Training

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

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

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

*/*

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

*/*

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

*/*

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=5 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
}

Knowledge AI Training

Initiates training for automated learning.

post

Path parameters

orgUUIDstringRequired

UUID of the organization

envUUIDstringRequired

UUID of the environment

botUUIDstringRequired

UUID of the bot

Header parameters

x-request-idstringOptional

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

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.

trainAllCollectionsbooleanOptional

Flag to indicate if wants to train all collections from bot. If true, it will override filterCollectionUuids

Responses

202

Accepted

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

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

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

{
  "trainingAvailable": "text",
  "currentTrainingUUID": "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

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.

Query parameters

collectionUUIDstringOptional

Optional collection UUID

anyCollectionbooleanOptional

A boolean flag indicating whether the operation should consider any collection or a specific one. When this flag is true, the collectionUUID will be disregarded

Default: false

checkKAIEnabledbooleanOptional

A boolean flag indicating whether to check if the AI feature is enabled.

Default: false

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

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",
  "currentTrainingUUID": "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

*/*

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=5 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
}

PreviousTechnical Log NextTransactional Service

Last updated 18 days ago

Was this helpful?