Actions50
- Bucket Actions
- Collection Actions
- Cluster Actions
- Document Actions
- Inference Actions
- Namespace Actions
- Retriever Actions
- Task Actions
- Taxonomy Actions
- Upload Actions
- Webhook Actions
Retriever → Explain
AI-generatedSummary
Explain the execution plan of a Retriever for a given search query using its Retriever ID and query text.
Inputs
- Retriever ID (required) — The identifier of the Retriever to explain.
- Query (required) — The search query text to analyze with the Retriever.
Output shape
a single JSON object containing the execution plan and explanation details of the Retriever's processing of the query
This operation sends a POST request to the /v1/retrievers/{retrieverId}/execute/explain endpoint with the query as input and returns the explanation data from Mixpeek API. The output includes details about how the Retriever would execute the given search query. No pagination applies.
Examples
Example 1: Given a Retriever ID and a query text, returns an explanation of how the Retriever will process the query.
Set the resource to 'Retriever', the operation to 'Explain', specify the required 'Retriever ID' and the 'Query' string.