Skip to main content
PATCH
Edit Plan

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
Query · object
required

A query against a DocSet. Contains either a natural language string or a query plan.

feedback
string
required

Feedback about the existing plan or instructions to modify it.

Response

Successful Response

A logical query plan used to evaluate a query.

query
string
required

The query that the plan is for.

nodes
Nodes · object
required

A mapping of node IDs to nodes in the query plan.

result_node
integer
required

The ID of the node that is the result of the query.

llm_prompt
any | null

The LLM prompt that was used to generate this query plan.

llm_plan
string | null

The result generated by the LLM.