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

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.

Default: 0Example: 1

linesPerPageinteger · int32Required

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

Default: 5Example: 1

orderBystringRequired

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

Default: name

directionstringRequired

It is the sorting type, default value ASC.

Default: 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

200

*/*

totalPagesinteger · int32Optional

totalElementsinteger · int64Optional

firstbooleanOptional

lastbooleanOptional

numberOfElementsinteger · int32Optional

sizeinteger · int32Optional

numberinteger · int32Optional

emptybooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents?enabled=true&page=0&linesPerPage=5&orderBy=name&direction=ASC&searchTerms=text HTTP/1.1
Accept: */*

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "first": true,
  "last": 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
  },
  "empty": true
}

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

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 · int32Optional

It is the max number of result, default value 6

Default: 6Example: 6

Header parameters

x-request-idstringOptional

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

Responses

200

*/*

string[]Optional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/quicksearch?name=text HTTP/1.1
Accept: */*

[
  "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

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

200

*/*

Contains data needed to create business rules about intent.

namestringRequired

Name of the intent.

utterancesstring[]Optional

Utterances of the intent.

idstringOptional

Uuid of the intent.

flowsstring[]Optional

Flows where intent is being used.

aboutstringOptional

Description of the intent.

firstCellbooleanOptional

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

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/list-on-flow HTTP/1.1
Accept: */*

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

CRUD Operations

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

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

Is the data provided for generating example utterances

namestringRequired

Name of the intent.

utterancesstring[]Optional

Utterances of the intent.

aboutstring · max: 200Optional

About of the intent.

Responses

200

*/*

Contains data created after creating or updating an intent.

namestringRequired

Name of the intent.

utterancesstring[]Optional

Utterances of the intent.

idstringOptional

Uuid of the intent.

flowsstring[]Optional

Flows where intent is being used.

400

The name cannot contain spaces

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

The name must be a maximum of 50 characters

*/*

429

Utterance already exists

*/*

500

Internal Server Error

*/*

post

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

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

{
  "name": "text",
  "utterances": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "about": "text"
}

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

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

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

200

*/*

Contains the summary of the analysis made of the intents

successinteger · int32Optional

It is the number of correct intents

expWithItentsinteger · int32Optional

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

intWithExpinteger · int32Optional

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

duplicateExpinteger · int32Optional

It is the number of duplicate examples in the file

intAlerExistsInRepointeger · int32Optional

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

expAlerExistsInRepointeger · int32Optional

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

invalidIntentNameinteger · int32Optional

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

notLinesbooleanOptional

It is the flag that identifies if the file is empty

exceedsMaxEmptyLinesbooleanOptional

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

400

Intent is removed

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Resource not found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid} HTTP/1.1
Accept: */*

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

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

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

Is the data provided for generating example utterances

namestringRequired

Name of the intent.

utterancesstring[]Optional

Utterances of the intent.

aboutstring · max: 200Optional

About of the intent.

Responses

200

*/*

Contains data created after creating or updating an intent.

namestringRequired

Name of the intent.

utterancesstring[]Optional

Utterances of the intent.

idstringOptional

Uuid of the intent.

flowsstring[]Optional

Flows where intent is being used.

400

The name cannot contain spaces

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

The name must be a maximum of 50 characters

*/*

429

Utterance already exists

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "text",
  "utterances": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "about": "text"
}

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

Removes an existing Intent and their associated Utterances.

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

200

No content

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

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

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid} HTTP/1.1
Accept: */*

No content

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

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

200

No content

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

429

Utterance already exists

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/validate-utterance HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

No content

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

Is the data provided for generating example utterances

namestringRequired

Name of the intent.

utterancesstring[]Optional

Utterances of the intent.

aboutstring · max: 200Optional

About of the intent.

Responses

200

*/*

string[]Optional

400

Genai service did not return valid examples

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/complete HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "text",
  "utterances": [
    "text"
  ],
  "tags": [
    {
      "name": "text"
    }
  ],
  "about": "text"
}

[
  "text"
]

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

200

application/json

Contains information on the use of a bot's tokens.

maxTokensinteger · int32Optional

Total tokens to be used to build the bot.

usedTokensinteger · int32Optional

Number of tokens used.

reservedTokensinteger · int32Optional

Number of tokens reserved for the system.

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tokens

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tokens HTTP/1.1
Accept: */*

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

Bulk Trainings

CRUD Operations

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

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

200

*/*

Contains a summary of the analyses performed

messagestringOptional

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

400

The file format is invalid

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

There is already a bulk training for this bot '{botUUID}'

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

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

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

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

200

*/*

Object containing the current state of a bulk training

idstringOptional

It is the bulk training status id

botUuidstringOptional

It is the bot where the bulk training is running

typestringOptional

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

percentageinteger · int32Optional

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

statusstringOptional

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

resultstringOptional

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

fileNamestringOptional

It is the name of the file that was uploaded

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training HTTP/1.1
Accept: */*

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

Create the intents and examples submitted 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

200

*/*

Contains a summary of the analyses performed

messagestringOptional

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

datainteger · int32Optional

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

400

The file contains inconsistencies, fix it and try again

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Wait for the upload to finish

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents HTTP/1.1
Accept: */*

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

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

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

200

No content

204

No Content

400

Wait for the upload to finish to cancel the bulk training action

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Wait for the upload to finish

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

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

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/{id} HTTP/1.1
Accept: */*

No content

Auxiliary Methods

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

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

200

*/*

Contains a summary of the analyses performed

messagestringOptional

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

400

The file format is invalid

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

There is already a bulk training for this bot '{botUUID}'

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

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

Acquired 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

200

*/*

Contains a summary of the analyses performed

messagestringOptional

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

datastring[]Optional

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

400

The file contains inconsistencies, fix it and try again

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Wait for the upload to finish

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances HTTP/1.1
Accept: */*

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

PreviousGenerative Service NextParameters

Last updated 7 months ago

Was this helpful?

hashtagIntents

hashtagPagination and Listings

hashtagPaginates through the Intents of a given bot.

hashtagSearches (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.

hashtagAcquires 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.

hashtagCRUD Operations

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

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

hashtagUpdates 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.

hashtagRemoves an existing Intent and their associated Utterances.

hashtagAuxiliary Methods

hashtagValidates 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.

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

hashtagA service class for providing token management services.

hashtagBulk Trainings

hashtagCRUD Operations

hashtagReceives 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.

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

hashtagCreate the intents and examples submitted by the upload service.

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

hashtagAuxiliary Methods

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

hashtagAcquired the utterance data that was uploaded by the upload service

Intents

Pagination and Listings

Paginates through the Intents of a given bot.

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.

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.

CRUD Operations

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

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

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.

Removes an existing Intent and their associated Utterances.

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.

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

A service class for providing token management services.

Bulk Trainings

CRUD Operations

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.

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

Create the intents and examples submitted by the upload service.

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

Auxiliary Methods

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

Acquired the utterance data that was uploaded by the upload service