v2

OpenAPI 3.0.02026-08-051996591.2 MB
Query History

Get a query history

Returns the detailed history of a specific query made against a corpus. The response includes the query latency, the execution time, and the stages of the query pipeline.

Set the query_id path parameter. The response includes the id of the query, the query object, the chat_id, timing information, and the spans object.

get/v2/queries/{query_id}

Path parameters

query_idstring required

The ID of the query history

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The query history. The spans object describes the ordered stages of the query pipeline and what happens during each stage.

idstring required

The ID of the query history.

chat_idstring

The ID of the chat the query is a part of.

latency_millisinteger

Time taken to complete the query, measured in milliseconds.

started_atstring date-time

ISO date time indicating when the query was first received.

agent_keystring

The agent key if this query was made through an agent.

session_keystring

The session key if this query was made through an agent session.