Automated Learning NLP

This API supplies a single endpoint which allows you to perform conversations through the AL for simulations.

API SUBPATH: eva-al-nlp

Performs a prediction with a given String. The return value will be a key with an answer to be delivered, along with it's associated document and textual position.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/cockpit

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

namestring

Question variable

Response

200400401403404409422500

OK

Body

*/*

answerstring

documentIdstring

documentEnabledboolean

filenamestring

confidencenumber (double)

typestring

positionCognitiveAnswerPosition (object)

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/cockpit', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {}
    ]),
});
const data = await response.json();

Response

200400401403404409422500

{
  "answer": "text",
  "documentId": "text",
  "documentEnabled": false,
  "filename": "text",
  "confidence": 0,
  "type": "text",
  "position": {
    "paragraph": 0,
    "start": 0,
    "end": 0
  }
}