Retrievers

Retrieve

Changed on

Retrieve data using a Retriever.

post/api/v1/retrievers/{retriever_id}/retrieve

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/retrievers/{retriever_id}/retrieve
  • Auth: HTTP bearer

Path parameters

retriever_idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

mode'routing' | 'full'

Enum for the mode of composite retrieval.

rerank_top_ninteger nullable

(use rerank_config.top_n instead) The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.

querystring required

The query to retrieve against.

Response

Successful Response

Changes

  • a38b684f8e1bRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status