Intent

The Intent API handles Intents and their utterances, also handling their mass import through files, known as Bulk Training.

API SUBPATH: eva-intent

Intents

Pagination and Listings

Paginates through the Intents of a given bot.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

It is the bot where the intents are, it is used to filter intents.

Query parameters

Header parameters

Response

200400401403404409422500

OK

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

firstboolean

lastboolean

numberOfElementsinteger (int32)

pageablePageableObject (object)

sortSort (object)

sizeinteger (int32)

contentarray of IntentDetailsDTO (object)

numberinteger (int32)

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents?enabled=false&orderBy=name&direction=ASC&searchTerms=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "first": false,
  "last": false,
  "pageable": {
    "paged": false,
    "unpaged": false,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "content": [
    {
      "name": "text",
      "utterances": [
        "text"
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "id": "text",
      "flows": [
        "text"
      ],
      "lastModified": {
        "uuid": "text",
        "image": "text",
        "name": "text"
      }
    }
  ],
  "empty": false
}

Searches (greedily) for any Intent names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/quicksearch

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter intents

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/quicksearch?name=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Acquires a full list of Intents. This method is intended to be consumed on the Flow editing screen and brings information regarding each Intent's current usage on the current Flow.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/list-on-flow

Path parameters

orgUUID*string

It is the organization where the intents are, used to connect to the correct database.

envUUID*string

It is the environment where the intents are, used to connect to the correct database.

botUUID*string

It is the bot where the intents are, used to filter intents.

Header parameters

Response

200400401403404409422500

OK

Body

*/*

name*string

Name of the intent.

utterances*array of string

Utterances of the intent.

tagsarray of TagDTO (object)

These are the tags used in the intent.

idstring

Uuid of the intent.

flowsarray of string

Flows where intent is being used.

lastModifiedUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the intent.

descriptionstring

Description of the intent.

firstCellboolean

Flag that indicates if the intent is being used to start flows.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/list-on-flow', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "name": "text",
    "utterances": [
      "text"
    ],
    "tags": [
      {
        "name": "text"
      }
    ],
    "id": "text",
    "flows": [
      "text"
    ],
    "lastModified": {
      "uuid": "text",
      "image": "text",
      "name": "text"
    },
    "description": "text",
    "firstCell": false
  }
]

CRUD Operations

Retrieves complete information regarding a given Intent, by it's UUID.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}

Path parameters

orgUUID*string

It is the organization where the intents are, used to connect to the correct database.

envUUID*string

It is the environment where the intents are, used to connect to the correct database.

botUUID*string

It is the bot where the intents are, used to filter intents.

uuid*string

It is the uuid used to search for an intent.

Header parameters

Response

200400401403404409422500

OK

Body

*/*

successinteger (int32)

It is the number of correct intents

expWithItentsinteger (int32)

It is the number of examples that have no intents in the file

intWithExpinteger (int32)

It is the number of intents that have no examples in the file

duplicateExpinteger (int32)

It is the number of duplicate examples in the file

intAlerExistsInRepointeger (int32)

It is the number of intents that already exist in the system

expAlerExistsInRepointeger (int32)

It is the number of examples that already exist in the system

invalidIntentNameinteger (int32)

It is the number of intents that have invalid characters in the name

notLinesboolean

It is the flag that identifies if the file is empty

exceedsMaxEmptyLinesboolean

It is the flag that identifies if the file exceeds the maximum number of empty lines.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "notLines": false,
  "exceedsMaxEmptyLines": false
}

Creates a new Intent, according to the provided body. Utterances submitted must be previously validated or it will fail.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents

Path parameters

orgUUID*string

It is the organization where the intents are, used to connect to the correct database.

envUUID*string

It is the bot where the intents are, it is used to create intents.

botUUID*string

It is the bot where the intents are, used to filter intents.

Header parameters

Body

application/json

name*string

Name of the intent.

utterances*array of string

Utterances of the intent.

tagsarray of TagDTO (object)

These are the tags used in the intent.

descriptionstring

Description of the intent.

Response

200400401403404409422429500

OK

Body

*/*

name*string

Name of the intent.

utterances*array of string

Utterances of the intent.

tagsarray of TagDTO (object)

These are the tags used in the intent.

idstring

Uuid of the intent.

flowsarray of string

Flows where intent is being used.

lastModifiedUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the intent.

Request

JavaScriptCurlPython

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

Response

200400401403404409422429500

{
  "name": "text",
  "utterances": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "id": "text",
  "flows": [
    "text"
  ],
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text"
  }
}

Updates an existing Intent. Utterances submitted overwrite the previous one, so you must submit the previous utterances you previously had, with their UUID, if you intend to persist them.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}

Path parameters

orgUUID*string

It is the organization where the intents are, used to connect to the correct database.

envUUID*string

It is the environment where the intents are, used to connect to the correct database.

botUUID*string

It is the bot where the intents are, used to filter intents.

uuid*string

It is the uuid used to search for an intent, in this case it is the intent will be updated.

Header parameters

Body

application/json

name*string

Name of the intent.

utterances*array of string

Utterances of the intent.

tagsarray of TagDTO (object)

These are the tags used in the intent.

descriptionstring

Description of the intent.

Response

200400401403404409422429500

OK

Body

*/*

name*string

Name of the intent.

utterances*array of string

Utterances of the intent.

tagsarray of TagDTO (object)

These are the tags used in the intent.

idstring

Uuid of the intent.

flowsarray of string

Flows where intent is being used.

lastModifiedUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the intent.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "utterances": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200400401403404409422429500

{
  "name": "text",
  "utterances": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "id": "text",
  "flows": [
    "text"
  ],
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text"
  }
}

Removes an existing Intent and their associated Utterances.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}

Path parameters

orgUUID*string

It is the organization where the intents are, used to connect to the correct database.

envUUID*string

It is the environment where the intents are, used to connect to the correct database.

botUUID*string

It is the bot where the intents are, used to filter intents.

uuid*string

It is the uuid used to delete an intent.

Header parameters

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Auxiliary Methods

Validates if an utterance is already being used in the bot elsewhere. Should be called to verify each utterance in a body for creating or updating Intents.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/validate-utterance

Path parameters

orgUUID*string

It is the organization where the intents are, used to connect to the correct database.

envUUID*string

It is the environment where the intents are, used to connect to the correct database.

botUUID*string

It is the bot where the intents are, it is used to check the utterance.

Header parameters

Body

application/json

string

It is the value of the intent example that will be checked if it already exists.

Response

200400401403404409422429500

OK

Request

JavaScriptCurlPython

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

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Bulk Trainings

CRUD Operations

Retrieves the status of the bot's current bulk training..

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

Bot where intents and examples will be imported.

Header parameters

Response

200400401403404409422500

OK

Body

*/*

idstring

It is the bulk training status id

botUuidstring

It is the bot where the bulk training is running

typestring

It is the bulk training type and can be INTENTS or UTTERANCES

percentageinteger (int32)

It is the current percentage of the analysis and can be from 0 to 100

statusstring

It is the status of mass training and can be PENDING or ERROR

resultstring

Contains the result of the analysis in JSON format, this field is filled only at the end of the analysis

fileNamestring

It is the name of the file that was uploaded

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "id": "text",
  "botUuid": "text",
  "type": "text",
  "status": "text",
  "result": "text",
  "fileName": "text"
}

Receives and load intents and utterances to analyze data consistency, and generate a pre-save of the analyzed data which must be then approved and trained.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

Bot where intents and examples will be imported.

Header parameters

Body

multipart/form-data

file*string (binary)

It is the file that contains the data to be analyzed.

Response

200400401403404409422500

OK

Body

*/*

messagestring

Represents the bulk training status, which can be OK or NOK

dataIntentDataDTO (object)

Contains the summary of the analysis made of the intents

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "message": "text",
  "data": {
    "notLines": false,
    "exceedsMaxEmptyLines": false
  }
}

Create the intents and examples submitted by the upload service.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

Bot where intents and examples will be created.

Header parameters

Response

200400401403404409422500

OK

Body

*/*

messagestring

Represents the bulk training status, which can be OK or NOK

datainteger (int32)

It is the content of the analysis, which can be a list of String, a number, an IntentDataDTO or UtteranceDataDTO

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "message": "text"
}

Deletes an existing Bulk Training. Both the uploaded data and it's status will be erased.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/{id}

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

Bot that contains the bulk training that will be canceled

id*string

It is the id of the bulk training.

Header parameters

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Auxiliary Methods

Validates it a set of utterance/examples provided are valid.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

Bot where intents and examples will be imported.

Header parameters

Body

multipart/form-data

file*string (binary)

It is the file that contains the data to be analyzed.

Response

200400401403404409422500

OK

Body

*/*

messagestring

Represents the bulk training status, which can be OK or NOK

dataUtteranceDataDTO (object)

Contains the summary of the analysis made of the examples

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "file": "binary"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "message": "text",
  "data": {
    "notLines": false
  }
}

Acquired the utterance data that was uploaded by the upload service

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances

Path parameters

orgUUID*string

It is the organization where the intents are, it is used to connect to the correct database.

envUUID*string

It is the environment where the intents are, it is used to connect to the correct database.

botUUID*string

Bot where the examples were loaded

Header parameters

Response

200400401403404409422500

OK

Body

*/*

messagestring

Represents the bulk training status, which can be OK or NOK

dataarray of string

It is the content of the analysis, which can be a list of String, a number, an IntentDataDTO or UtteranceDataDTO

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "message": "text",
  "data": [
    "text"
  ]
}