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

Its function is to provide a list of Flow in page format

get

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 · int32 · default: 0required

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: "name"required

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

directionstring · default: "ASC"required

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-idstringoptional

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=1&linesPerPage=1&orderBy=text&direction=text&searchTerms=text'

200

400

401

403

404

409

422

500

200

{
  "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": [
    {
      "name": "text",
      "utterances": [
        "text"
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "id": "text",
      "flows": [
        "text"
      ],
      "lastModified": {
        "uuid": "text",
        "image": "text",
        "name": "text",
        "timestamp": 1
      }
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

OK

Its service is used to search a intents by name

get

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: 6optional

It is the max number of result, default value 6

Example: 6

Header parameters

x-request-idstringoptional

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

Its function is to list all intents, and check if they start a flow.

get

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-idstringoptional

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",
    "utterances": [
      "text"
    ],
    "tags": [
      {
        "name": "text"
      }
    ],
    "id": "text",
    "flows": [
      "text"
    ],
    "lastModified": {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timestamp": 1
    },
    "about": "text",
    "firstCell": true
  }
]

OK

CRUD Operations

Its function is to create an intent.

post

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-idstringoptional

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

Body

namestringrequired

Name of the intent.

utterancesstring[]optional

Utterances of the intent.

tagsobject[]optional

These are the tags used in the intent.

aboutstring · max: 200optional

About of 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": [
      "text"
    ],
    "tags": [
      {
        "name": "text"
      }
    ],
    "about": "text"
  }'

200

400

401

403

404

409

422

429

500

200

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

OK

Its function is to find the intent data.

get

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-idstringoptional

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

Its function is to update an intent.

put

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-idstringoptional

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

Body

namestringrequired

Name of the intent.

utterancesstring[]optional

Utterances of the intent.

tagsobject[]optional

These are the tags used in the intent.

aboutstring · max: 200optional

About of 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": [
      "text"
    ],
    "tags": [
      {
        "name": "text"
      }
    ],
    "about": "text"
  }'

200

400

401

403

404

409

422

429

500

200

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

OK

Its function is to update an intent.

delete

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-idstringoptional

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

204

400

401

403

404

409

422

500

200

No body

OK

Auxiliary Methods

Its function is to check if an utterance is already being used in the bot.

post

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-idstringoptional

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

Body

stringoptional

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' \
  --data '"text"'

200

204

400

401

403

404

409

422

429

500

200

No body

OK

Its function is responsible for communicating with the genai service to bring examples of utterances.

post

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-idstringoptional

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

Body

namestringrequired

Name of the intent.

utterancesstring[]optional

Utterances of the intent.

tagsobject[]optional

These are the tags used in the intent.

aboutstring · max: 200optional

About of the intent.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

[
  "text"
]

OK

A service class for providing token management services.

get

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 for token counting.

Header parameters

x-request-idstringoptional

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

Responses

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

404

409

422

500

200

{
  "maxTokens": 1,
  "usedTokens": 1,
  "reservedTokens": 1
}

Ok

Bulk Trainings

CRUD Operations

Its function is to load intents and utterances to analyze data consistency, and generate a pre-save of the analyzed data.

post

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-idstringoptional

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' \
  --form 'file=binary'

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

Its function is to return the status of a current bulk training of a bot.

get

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-idstringoptional

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

Its function is to create the intents and examples uploaded by the upload service.

put

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-idstringoptional

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

Its function is to cancel a bulk training, it will erase the status and data uploaded

delete

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-idstringoptional

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

204

400

401

403

404

409

422

500

200

No body

OK

Auxiliary Methods

Its function is to analyze if the set of examples are valid for creation.

post

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-idstringoptional

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' \
  --form 'file=binary'

200

400

401

403

404

409

422

500

200

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

OK

Its function is to provide the utterance data that was uploaded by the upload service

put

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-idstringoptional

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