Query the "Get SQL Evaluation Set" tool (streaming)

post

https://{protocol}://{base-url}/ai/api/v1/chats/tool/default/get_sql_eval_set_tool/stream

Invoke the "Get SQL Evaluation Set" directly.

Query Params

chat_id

The ID of the Chat to use. If not provided, a new Chat will be created.

tags

array | null

If creating a new chat, add these tags to it. This is ignored if the chat already exists.

Body Params

data_product_id

string

required

The data product ID to which the evaluation set belongs.

skip

integer

Defaults to 0

The number of question/sql pairs to skip from the start of the eval set.

limit

integer

Defaults to 10

The maximum number of question/sql pairs to retrieve from the eval set.

search_term

Optional search string to filter questions. Each space-separated term is matched against the question using case-insensitive substring matching (ILIKE). All terms must match (AND semantics). For example, 'sales monthly' matches questions containing both 'sales' AND 'monthly'.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

402Tenant has no remaining tool calls. The request cannot be completed.

422Validation Error

500Internal server error during request processing.