Knowledge AI

The Knowledge AI (former Automated Learning) API contains methods for both it's related models: Documents, which contains the text to perform them, and Questions, which are assigned to Documents.

API SUBPATH: eva-al

Documents

Pagination and Listing

CRUD Operations

Bulk Operations

Questions

Paginations and Listings

CRUD Operations

Auxiliary Methods

Knowledge AI

PreviousInstance API NextKnowledge AI NLP

Last updated 2 months ago

Was this helpful?

Returning a list of possible words to autocomplete in search

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

searchTermstringRequired

Word or part of word to get suggestion names of documents

limitinteger · int64Optional

The limit of suggestions names in the response. The default value is 6

Default: 6Example: 1

Responses

Responsestring[]

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Remove document

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid document Uuid

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
Accept: */*

No content

Returnig a pagination list of bot's questions

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

pageinteger · int32Optional

The number of page and the default is 1

Default: 1Example: 1

linesPerPageinteger · int32Optional

The number of services per pages and the default is 5

Default: 5Example: 1

orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt

directionstringOptional

Direction of ordenation, ASC or DESC. The default is DESC

Default: DESC

filenamesstring[]Optional

Filename to filter the search

searchTermsstring[]Optional

Names or tags to filter the search

Responses

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/pagination HTTP/1.1
Host: 
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "variables": 1,
      "document": {
        "uuid": "text",
        "storageFilename": "text",
        "filename": "text",
        "enabled": true
      },
      "enabled": true,
      "selected": true,
      "lastModified": {
        "name": "text",
        "image": "text",
        "date": 1
      },
      "tags": [
        "text"
      ],
      "updatedAt": "2025-04-27T01:32:40.254Z"
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Returning a list of possible words to autocomplete in search

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

searchTermstringRequired

Word or part of word to get suggestion names of documents

limitinteger · int64Optional

The limit of suggestions names in the response. The default value is 6

Default: 6Example: 1

Responses

Responsestring[]

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Return all limits to upload documents

get

Path parameters

orgUUIDstringRequired

It is the id that represents an organization.

envUUIDstringRequired

It is the id that represents an environment.

Header parameters

x-request-idstringOptional

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

Responses

get

GET /org/{orgUUID}/env/{envUUID}/documents/limits HTTP/1.1
Host: 
Accept: */*

{
  "size": {
    "txt": 1,
    "pdf": 1
  },
  "textSize": {
    "txt": "text",
    "pdf": "text"
  },
  "page": {
    "pdf": 1
  },
  "limit": 1
}

Enable or disable document

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

documentUUIDstringRequired

A valid service Uuid

Body

enabledbooleanOptional

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

No content

Delete an question. The question is disabled via the 'removed' parameter rather than deleted from the DB

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

{
  "success": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

Validate examples

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

variablestringOptional

Example of the question

Responses

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/variable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "variable": "text"
}

[
  {
    "id": "text",
    "variable": "text"
  }
]

Enable and disable questions

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

questionsIdsstring[]Optional

List the questions ids

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/change-enable HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "questionsIds": [
    "text"
  ]
}

No content

Exports more than one document

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

Responsestring · byte[]

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/export HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

[
  "Ynl0ZXM="
]

Bulk removes Documents with the provided uuid list.

delete

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

Document uuids to delete

uuidsstring[]Optional

A list of Uuid of question

Responses

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/massive-delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "uuids": [
    "text"
  ]
}

{
  "success": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

Create a brand new Question

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Body

documentIdstringRequired

A Uuid of a document assigned to this question.

namestringRequired

Question name

descriptionstringOptional

Question description

variablesstring[]Optional

List of examples of question

enabledbooleanRequired

Question enabled/disabled status

evaluablebooleanOptional

Question evaluable status

transactionalbooleanOptional

Question transactional status

webhookstringOptional

Webhook address endpoint

headersobjectOptional

Webhook headers

Responses

post

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

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "variables": [
    "text"
  ],
  "enabled": true,
  "evaluable": true,
  "transactional": true,
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "webhook": "text",
  "headers": {},
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "questionId": "text"
}

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "updateContent": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "createdAt": "2025-04-27T01:32:40.254Z",
  "updatedAt": "2025-04-27T01:32:40.254Z",
  "updatedBy": "text"
}

Updates an question

put

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

questionUUIDstringRequired

A valid question Uuid

Body

documentIdstringRequired

A Uuid of a document assigned to this question.

namestringRequired

Question name

descriptionstringOptional

Question description

variablesstring[]Optional

List of examples of question

enabledbooleanRequired

Question enabled/disabled status

evaluablebooleanOptional

Question evaluable status

transactionalbooleanOptional

Question transactional status

webhookstringOptional

Webhook address endpoint

headersobjectOptional

Webhook headers

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/questions/{questionUUID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "variables": [
    "text"
  ],
  "enabled": true,
  "evaluable": true,
  "transactional": true,
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "webhook": "text",
  "headers": {},
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "tags": [
    {
      "name": "text"
    }
  ]
}

{
  "id": "text",
  "botId": "text",
  "document": {
    "uuid": "text",
    "storageFilename": "text",
    "filename": "text",
    "enabled": true
  },
  "name": "text",
  "description": "text",
  "variables": [
    {
      "id": "text",
      "variable": "text"
    }
  ],
  "webhook": "text",
  "headers": "text",
  "transactional": true,
  "enabled": true,
  "removed": true,
  "updateContent": true,
  "evaluable": true,
  "tags": [
    {
      "name": "text"
    }
  ],
  "answerTemplates": [
    {
      "id": "text",
      "content": {},
      "type": "text",
      "channelTypeId": 1,
      "channelId": "text",
      "technicalText": "text"
    }
  ],
  "transactionalAuth": {
    "authType": "AUTH_NONE",
    "basicToken": "text",
    "bearerToken": "text",
    "oauthUrl": "text",
    "grantType": "CLIENT_CREDENTIALS",
    "clientId": "text",
    "clientSecret": "text",
    "authUsername": "text",
    "authPassword": "text"
  },
  "createdAt": "2025-04-27T01:32:40.254Z",
  "updatedAt": "2025-04-27T01:32:40.254Z",
  "updatedBy": "text"
}

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "pageSize": 1,
    "paged": true,
    "pageNumber": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "uuid": "text",
      "storageFileName": "text",
      "filename": "text",
      "collectionUUID": "text",
      "questions": 1,
      "questionsIds": [
        "text"
      ],
      "enabled": true,
      "selected": true,
      "date": 1,
      "uploaded": {
        "uuid": "text",
        "name": "text",
        "imageUrl": "text"
      },
      "tags": [
        "text"
      ],
      "format": "text"
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

[
  {
    "uuid": "text",
    "filename": "text",
    "storageFileName": "text",
    "collectionUUID": "text",
    "questionSize": 1,
    "enabled": true,
    "removed": true,
    "updatedAt": "2025-04-27T01:32:40.254Z",
    "trainingStatus": "text",
    "format": "text"
  }
]

Upload new document

post

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

tagstring[]Optional

The tag name to save with document

Body

documentstring · binaryRequired

The document to upload

namestringOptional

The document name to save

collectionUUIDstringOptional

Optional. Symbolic collectionUUID for document organizing.

Responses

post

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

{
  "document": "binary",
  "name": "text",
  "collectionUUID": "text"
}

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true,
  "tags": [
    "text"
  ]
}

{
  "filename": "text",
  "enabled": true,
  "lastEdition": {
    "name": "text",
    "image": "text",
    "date": 1
  },
  "collectionUUID": "text",
  "questionCount": 1,
  "questionsIds": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "format": "text"
}

Update one document, the file document or the data (name, tags...)

put

Path parameters

orgUUIDstringRequired

It is the organization uuid where the bot is.

envUUIDstringRequired

It is the environment uuid where the bot is.

botUUIDstringRequired

It is the identification of the bot.

documentUUIDstringRequired

It is the identification of the document

Query parameters

tagstring[]Optional

The tag name to save with document

Body

documentstring · binaryOptional

It is the new file to update

namestringRequired

It is the new document name to update

collectionUUIDstringOptional

Optional. Symbolic collectionUUID for document organizing. Sending this as null will overwrite existing repository Id.

Responses

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/documents/{documentUUID}/update HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 59

{
  "document": "binary",
  "name": "text",
  "collectionUUID": "text"
}

{
  "uuid": "text",
  "storageFilename": "text",
  "filename": "text",
  "enabled": true,
  "tags": [
    "text"
  ]
}

Knowledge AI

Documents

CRUD Operations

Bulk Operations

Questions

Paginations and Listings

CRUD Operations

Auxiliary Methods

Knowledge AI

Documents

CRUD Operations

Bulk Operations

Questions

Paginations and Listings

CRUD Operations

Auxiliary Methods

Knowledge AI

Returning a list of possible words to autocomplete in search

Remove document

Returning a list of possible words to autocomplete in search

Return all limits to upload documents

Enable or disable document

Delete an question. The question is disabled via the 'removed' parameter rather than deleted from the DB

Validate examples

Enable and disable questions

Retrieve info a specific given question

Returnig a pagination list of bot's documents

Show a document

Exports more than one document

Bulk removes Documents with the provided uuid list.

Create a brand new Question

Updates an question

Upload new document

Update one document, the file document or the data (name, tags...)