Start project’s learning by text

Parameters


"omni_key" is the private key.
You can generate a personal key in your profile settings on the platform. Instructions on how to do this can be found here> API key

"nowait" optional. flag for running tasks in sync or async state.

"title" optional. can be retrieved automatically from the file name or set directly in the request body.

"content" – enter the content or data that needs to be transmitted or processed.

"metadata" Refers to data that describes other data. Examples include information about the author, creation date, file size, and file format.

"chunkSize" – the size of the chunks into which the uploaded document is divided. The value is specified in characters.

Returns


If the request is successful, you will receive an object with your project ID

/rest/v1/projects/{id}/training/text/
Example
{
  "omni_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoiNGFiNDUyYTMtNGMwYi00MTIyLWI3NDgtYzk4MWRiN2VlYWFlIiwiZGVmYXVsdFJvbGUiOiJ1c2VyIiwiYWxsb3dlZFJvbGVzIjpbInVzZXIiLCJtZSJdfSwiaWF0IjoxNzE0MzgxNzM4LCJleHAiOjE3NDU5MzkzMzgsInN1YiI6IjRhYjQ1MmEzLTRjMGItNDEyMi1iNzQ4LWM5ODFkYjdlZWFhZSJ9.EFa4TEFmXrSdUX7X6rrfbFSy2xP78YEhHSRWUid9hMo",
  "nowait": true,
  "title": "description",
  "content": "Connect only with the right users through quality...",
  "metadata": {},
  "chunkSize": "100"
}
Schema
{

  omni_key:	"string"
  nowait:	"boolean"
  title:	"string"
  content:	"string"
  metadata	{  }
  chunkSize:	"string"
  
}

Responses

Successful operation

Example
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]
Schema
{
oneOf ->	TrainingAsyncResponse{
                        id:	string($uuid)
          }
          TrainingSyncResponse{
                        results:	string($json)
              }
}

Was this article helpful to you? Yes No

How can we help?