llamaindex · Schema

RetrievalRequest

Request body for running a retrieval query against a pipeline.

Properties

Name Type Description
query string The search query to run against the indexed content.
mode string Retrieval mode that controls the trade-off between speed and accuracy.
top_k integer Maximum number of results to return after re-ranking.
View JSON Schema on GitHub

JSON Schema

llamaindex-retrievalrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RetrievalRequest",
  "title": "RetrievalRequest",
  "type": "object",
  "description": "Request body for running a retrieval query against a pipeline.",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "The search query to run against the indexed content."
    },
    "mode": {
      "type": "string",
      "enum": [
        "fast",
        "accurate",
        "advanced"
      ],
      "description": "Retrieval mode that controls the trade-off between speed and accuracy."
    },
    "top_k": {
      "type": "integer",
      "minimum": 1,
      "description": "Maximum number of results to return after re-ranking."
    }
  }
}