AI Dataset Management

Run a Text AI Based Search on Trained Datasets

Changed on Oct 20, 2023

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

Base URL
https://api.worqhat.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints-2/docs/api/ai/search/v2/post.ts
A function with typed inputs. Its response is checked against the schema.

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
}

Changes

Oct 20, 2023871850b7231f Revision changes
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the endpoint scheme security bearerAuth was added to the API
- info
  api tag AI Dataset Management added
- info
  api tag AI removed
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Aug 15, 2023b5ffe2a9748f Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- info
  api operation id searchV2 was added
- info
  api tag AI added
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (6 revisions)