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

Training

The training API handles all training methods for bots that both use AL or not.

PreviousTechnical LogNextTransactional Service

Last updated 5 months ago

Was this helpful?

API SUBPATH: eva-training

The Training APIs are as simple as it can be - Both contain 3 methods, one for listing, one that requests a new training, and a last one which discerns whether a training should be available as of now. If you send a trainign request while the /training-availability does not inform it's available, the training proccess will fail at the nlp.

Standard Training

Knowledge AI Training

Creates a request for a bot training, which will be sent to it's nlp-adequate training MS. Returns a TrainingAvailabilityDTO with the current training version and status.

post
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entity you are searching belong to

Query parameters
formTrainingstring · enumOptionalPossible values:
Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training HTTP/1.1
Host: 
Accept: */*
{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1,
  "documentStatus": "text"
}

Returns a TrainingAvailabilityDTO indicating wether there is an ongoing training and if a new one is elibigle. When a new value is eligible, the next version number will be sent instead.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entity you are searching belong to

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}/training/training-availability HTTP/1.1
Host: 
Accept: */*
{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1,
  "documentStatus": "text"
}

Returns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entity you are searching belong to

Query parameters
validOnlybooleanOptional

Boolean that filters the search in order to find only trainings that obtained success

Default: false
pageinteger · int32Required

Current page, starting at 1

Default: 1
sizeinteger · int32Required

Size of the page

Default: 5
orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt
directionstringOptional

Direction of ordenation, ASC or DESC. The default is DESC

Default: DESC
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}/training/list?page=1&size=1 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "id": "text",
      "version": "text",
      "status": "text",
      "statusDocument": "text",
      "statusFAQ": "text",
      "accuracy": 1,
      "updatedAt": "text",
      "errorMsg": "text",
      "errorDocument": "text",
      "errorFAQ": "text",
      "statistics": {
        "documentsUpdated": 1,
        "success": 1,
        "error": 1
      },
      "user": {
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Returns a TrainingAvailabilityDTO indicating wether there is an ongoing training and if a new one is elibigle. When a new value is eligible, the next version number will be sent instead.

get
Path parameters
orgUUIDstringRequired

It is the organization uuid where the bot is.

envUUIDstringRequired

It is the environment uuid where the bot is.

botUUIDstringRequired

It is the identification of the bot.

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}/training/automated-learn/availability HTTP/1.1
Host: 
Accept: */*
{
  "trainingAvailable": "text",
  "currentVersion": 1,
  "nextVersion": 1,
  "documentStatus": "text"
}

Returns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.

get
Path parameters
orgUUIDstringRequired

A valid uuid of an organization

envUUIDstringRequired

A valid uuid of an environment

botUUIDstringRequired

The UUID of the bot whose entity you are searching belong to

Query parameters
validOnlybooleanOptional

Boolean that filters the search in order to find only trainings that obtained success

Default: false
pageinteger · int32Required

Current page, starting at 1

Default: 1
sizeinteger · int32Required

Size of the page

Default: 5
orderBystringOptional

Field want to ordernate, the default is 'updatedAt'

Default: updatedAt
directionstringOptional

Direction of ordenation, ASC or DESC. The default is DESC

Default: DESC
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}/training/automated-learn?page=1&size=1 HTTP/1.1
Host: 
Accept: */*
{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "content": [
    {
      "id": "text",
      "version": "text",
      "status": "text",
      "statusDocument": "text",
      "statusFAQ": "text",
      "accuracy": 1,
      "updatedAt": "text",
      "errorMsg": "text",
      "errorDocument": "text",
      "errorFAQ": "text",
      "statistics": {
        "documentsUpdated": 1,
        "success": 1,
        "error": 1
      },
      "user": {
        "name": "text",
        "imageUrl": "text"
      }
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}
  • Standard Training
  • POSTCreates a request for a bot training, which will be sent to it's nlp-adequate training MS. Returns a TrainingAvailabilityDTO with the current training version and status.
  • GETReturns a TrainingAvailabilityDTO indicating wether there is an ongoing training and if a new one is elibigle. When a new value is eligible, the next version number will be sent instead.
  • GETReturns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.
  • Knowledge AI Training
  • POSTCreates a request for a automated-learn training
  • GETReturns a TrainingAvailabilityDTO indicating wether there is an ongoing training and if a new one is elibigle. When a new value is eligible, the next version number will be sent instead.
  • GETReturns a page of the bot's trainings. If validOnly is sent with value true, only successfull trainings are shown, instead.

Creates a request for a automated-learn training

post
Path parameters
orgUUIDstringRequired

It is the organization uuid where the bot is.

envUUIDstringRequired

It is the environment uuid where the bot is.

botUUIDstringRequired

It is the identification of the bot.

Body

Optional structure. used to add new rules into the training and bypass new fields into KAI's register-doc v2

windowsLengthinteger · int32Optional

Optional. Maximum size of a chunk.

overlapinteger · int32Optional

Optional. Limit of overlapping characters between chunks. Bigger overlap preserves context but increases token usage.

filterCollectionUuidsstring[]Optional

Optional. A list of collectionUUIDs (Document groups) to train. If empty, it trains all documents instead.

filterDocumentIdsstring[]Optional

Optional. A list of documentIds to train. If empty, it trains all documents instead.

Responses
202
Accepted
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
post
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/training/automated-learn HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "windowsLength": 1,
  "overlap": 1,
  "filterCollectionUuids": [
    "text"
  ],
  "filterDocumentIds": [
    "text"
  ]
}

No content