Knowledge AI NLP

This API supplies a single endpoint which allows you to perform conversations through the Knowledge AI (Automated Learning) for simulations.

API SUBPATH: eva-al-nlp

Predicts cockpit data based on provided parameters.

post

Path parameters

orgUUIDstringRequired

The UUID of the organization.

envUUIDstringRequired

The UUID of the environment.

botUUIDstringRequired

The UUID of the bot.

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

application/json

Data transfer object for Cockpit Predict V2 requests.

collectionUUIDstringRequired

Unique identifier for the collection.

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

502

Bad Gateway

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/v2/conversations/cockpit HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "collectionUUID": "text",
  "examples": [
    {
      "name": "text"
    }
  ]
}

{
  "answer": "text",
  "documentId": "text",
  "documentEnabled": true,
  "filename": "text",
  "type": "text",
  "storageFilename": "text",
  "answers": [
    {
      "content": "text",
      "score": 1,
      "storageFilename": "text",
      "collectionUUID": "text"
    }
  ]
}

Deprecated

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

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Header parameters

x-request-idstringOptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Bodyobject[]

application/json

Object that contains the data needed to perform the prediction from the Cockpit

namestringOptional

Question variable

Responses

200

Ok

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

502

Bad Gateway

*/*

post

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/conversations/cockpit HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

[
  {
    "name": "text"
  }
]

{
  "answer": "text",
  "documentId": "text",
  "documentEnabled": true,
  "filename": "text",
  "type": "text",
  "storageFilename": "text",
  "answers": [
    {
      "content": "text",
      "score": 1,
      "storageFilename": "text",
      "collectionUUID": "text"
    }
  ]
}