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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

Query parameters

enabledbooleanrequired

It is the status of the intents, represents whether are active, default value true.

Example: true

pageinteger · int32required

It is the number of pages that will be returned, default value 0.

Example: 1

linesPerPageinteger · int32 · default: 5required

It is the number of intent per page, default value 5.

Example: 1

orderBystring · default: namerequired

It is the intent attribute used for ordination the page, default attribute name.

directionstring · default: ASCrequired

It is the sorting type, default value ASC.

searchTermsstringrequired

It is the parameter that contains the user data entry, that will be used to filter the intents.

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents?enabled=true&page=0&linesPerPage=5&orderBy=name&direction=ASC&searchTerms=text'

200

400

401

403

404

409

422

500

200

{
  "totalPages": 1,
  "totalElements": 1,
  "first": true,
  "last": true,
  "numberOfElements": 1,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    },
    "offset": 1
  },
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "size": 1,
  "number": 1,
  "empty": true,
  "content": [
    {
      "name": "text",
      "id": "text",
      "lastModified": {
        "uuid": "text",
        "image": "text",
        "name": "text",
        "timestamp": 1
      },
      "utterances": [
        "text"
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "flows": [
        "text"
      ]
    }
  ]
}

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

Query parameters

namestringrequired

It is the parameter used to search for intents related to the entered value

limitinteger · int32 · default: 6

It is the max number of result, default value 6

Example: 6

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/quicksearch?name=text'

200

400

401

403

404

409

422

500

200

[
  "text"
]

Ok

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/list-on-flow'

200

400

401

403

404

409

422

500

200

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

OK

CRUD Operations

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

get

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

Path parameters

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

uuidstringrequired

It is the uuid used to search for an intent.

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}'

200

400

401

403

404

409

422

500

200

{
  "success": 1,
  "expWithItents": 1,
  "intWithExp": 1,
  "duplicateExp": 1,
  "intAlerExistsInRepo": 1,
  "expAlerExistsInRepo": 1,
  "invalidIntentName": 1,
  "notLines": true,
  "exceedsMaxEmptyLines": true
}

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

Header parameters

x-request-idstring

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

Body

namestringrequired

Name of the intent.

descriptionstring

Description of the intent.

utterancesstring[]required

Utterances of the intent.

tagsobject[]

These are the tags used in the intent.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","utterances":[null],"tags":[{}]}'

200

400

401

403

404

409

422

429

500

200

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

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

uuidstringrequired

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

Header parameters

x-request-idstring

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

Body

namestringrequired

Name of the intent.

descriptionstring

Description of the intent.

utterancesstring[]required

Utterances of the intent.

tagsobject[]

These are the tags used in the intent.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","utterances":[null],"tags":[{}]}'

200

400

401

403

404

409

422

429

500

200

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

OK

Removes an existing Intent and their associated Utterances.

delete

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

Path parameters

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

uuidstringrequired

It is the uuid used to delete an intent.

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid}'

200

400

401

403

404

409

422

500

200

No body

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

Header parameters

x-request-idstring

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

Body

string

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/validate-utterance' \
  --header 'Content-Type: application/json'

200

400

401

403

404

409

422

429

500

200

No body

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

Bot where intents and examples will be imported.

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training'

200

400

401

403

404

409

422

500

200

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

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

Bot where intents and examples will be imported.

Header parameters

x-request-idstring

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

Body

filestring · binaryrequired

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"file":"text"}'

200

400

401

403

404

409

422

500

200

{
  "message": "text",
  "data": {
    "success": 1,
    "expWithItents": 1,
    "intWithExp": 1,
    "duplicateExp": 1,
    "intAlerExistsInRepo": 1,
    "expAlerExistsInRepo": 1,
    "invalidIntentName": 1,
    "notLines": true,
    "exceedsMaxEmptyLines": true
  }
}

OK

Create the intents and examples submitted by the upload service.

put

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

Path parameters

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

Bot where intents and examples will be created.

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents'

200

400

401

403

404

409

422

500

200

{
  "message": "text",
  "data": 1
}

OK

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

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

Bot that contains the bulk training that will be canceled

idstringrequired

It is the id of the bulk training.

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/{id}'

200

400

401

403

404

409

422

500

200

No body

OK

Auxiliary Methods

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

post

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

Path parameters

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

Bot where intents and examples will be imported.

Header parameters

x-request-idstring

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

Body

filestring · binaryrequired

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances' \
  --header 'Content-Type: multipart/form-data' \
  --data '{"file":"text"}'

200

400

401

403

404

409

422

500

200

{
  "message": "text",
  "data": {
    "success": 1,
    "uttWrong": 1,
    "expAlerExistsInRepo": 1,
    "notLines": true
  }
}

OK

Acquired the utterance data that was uploaded by the upload service

put

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

Path parameters

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

Bot where the examples were loaded

Header parameters

x-request-idstring

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances'

200

400

401

403

404

409

422

500

200

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

OK