v47

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-06-17465244.2 KB
AI Dataset Management

Run a Text AI Based Search on Trained Datasets

Run a Text AI Based Search on Trained Datasets. You can run a Text AI Based Search on Trained Datasets using this endpoint. You can pass in the Dataset ID and the Search Query and we will run the search for you.

post/api/ai/search/v2

Request body

questionstring

The Search Query that you want to search for.

training_datastring

The ID of the Trained Dataset that you want to search in.

Example request

{
  "question": "What is the capital of India?",
  "training_data": "1234567890"
}

Response

Successful response

statusstring

Status indicating the success of the request.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

The number of times the request has been processed. This is what is considered in the Billing Process.

Example response

{
  "status": "success",
  "result": [
    {
      "sId": "07743dc2-2c1f-4b15-919e-7f7aae66586c",
      "type": "donut",
      "name": "Old Fashioned",
      "ppu": 0.55
    }
  ],
  "processing_time": 873,
  "processing_id": "9b174f6d-df21-460d-b81a-72ff3d9b9852",
  "processing_count": 2
}