User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • 🚀GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • 💬BUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • ✨GENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • 🌐CHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • ⚙️CONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • 📊ANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page

Was this helpful?

  1. API DOCS
  2. API Guidelines
  3. Management API
  4. Instance API

Intent

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

PreviousGenerative ServiceNextParameters

Last updated 5 months ago

Was this helpful?

API SUBPATH: eva-intent

Intents

Pagination and Listings

CRUD Operations

Auxiliary Methods

Bulk Trainings

CRUD Operations

Auxiliary Methods

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 · 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
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents?enabled=true&page=1&linesPerPage=1&orderBy=text&direction=text&searchTerms=text HTTP/1.1
Host: 
Accept: */*
{
  "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
}

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 · 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
Ok
*/*
Responsestring[]
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/quicksearch?name=text HTTP/1.1
Host: 
Accept: */*
[
  "text"
]

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
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/list-on-flow HTTP/1.1
Host: 
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
  }
]

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
200
OK
*/*
400
Intent is removed
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Resource not found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid} HTTP/1.1
Host: 
Accept: */*
{
  "success": 1,
  "expWithItents": 1,
  "intWithExp": 1,
  "duplicateExp": 1,
  "intAlerExistsInRepo": 1,
  "expAlerExistsInRepo": 1,
  "invalidIntentName": 1,
  "notLines": true,
  "exceedsMaxEmptyLines": true
}

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
200
OK
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid} HTTP/1.1
Host: 
Accept: */*

No content

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
Ok
application/json
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tokens HTTP/1.1
Host: 
Accept: */*
{
  "maxTokens": 1,
  "usedTokens": 1,
  "reservedTokens": 1
}

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
200
OK
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "botUuid": "text",
  "type": "text",
  "percentage": 1,
  "status": "text",
  "result": "text",
  "fileName": "text"
}

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
200
OK
*/*
400
The file contains inconsistencies, fix it and try again
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Wait for the upload to finish
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents HTTP/1.1
Host: 
Accept: */*
{
  "message": "text",
  "data": 1
}

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
200
OK
204
No Content
400
Wait for the upload to finish to cancel the bulk training action
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Wait for the upload to finish
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
delete
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/{id} HTTP/1.1
Host: 
Accept: */*

No content

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
200
OK
*/*
400
The file contains inconsistencies, fix it and try again
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Wait for the upload to finish
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances HTTP/1.1
Host: 
Accept: */*
{
  "message": "text",
  "data": [
    "text"
  ]
}
  • Intents
  • Pagination and Listings
  • GETIts function is to provide a list of Flow in page format
  • GETIts service is used to search a intents by name
  • GETIts function is to list all intents, and check if they start a flow.
  • CRUD Operations
  • POSTIts function is to create an intent.
  • GETIts function is to find the intent data.
  • PUTIts function is to update an intent.
  • DELETEIts function is to update an intent.
  • Auxiliary Methods
  • POSTIts function is to check if an utterance is already being used in the bot.
  • POSTIts function is responsible for communicating with the genai service to bring examples of utterances.
  • GETA service class for providing token management services.
  • Bulk Trainings
  • CRUD Operations
  • POSTIts function is to load intents and utterances to analyze data consistency, and generate a pre-save of the analyzed data.
  • GETIts function is to return the status of a current bulk training of a bot.
  • PUTIts function is to create the intents and examples uploaded by the upload service.
  • DELETEIts function is to cancel a bulk training, it will erase the status and data uploaded
  • Auxiliary Methods
  • POSTIts function is to analyze if the set of examples are valid for creation.
  • PUTIts function is to provide the utterance data that was uploaded by the upload service

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

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
OK
*/*
400
The name cannot contain spaces
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
The name must be a maximum of 50 characters
*/*
429
Utterance already exists
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents HTTP/1.1
Host: 
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
  }
}

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

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
OK
*/*
400
The name cannot contain spaces
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
The name must be a maximum of 50 characters
*/*
429
Utterance already exists
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/{uuid} HTTP/1.1
Host: 
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
  }
}

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
200
OK
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
429
Utterance already exists
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/validate-utterance HTTP/1.1
Host: 
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
OK
*/*
Responsestring[]
400
Genai service did not return valid examples
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/intents/complete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 77

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

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
200
OK
*/*
400
The file format is invalid
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
There is already a bulk training for this bot '{botUUID}'
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/intents HTTP/1.1
Host: 
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
  }
}

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
200
OK
*/*
400
The file format is invalid
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
There is already a bulk training for this bot '{botUUID}'
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/bulk-training/utterances HTTP/1.1
Host: 
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

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