GET /sink/rag

RAG (Retrieval Augmented Generation) endpoint

:param query: User query :param context: Additional context string :param context_blocks: Additional context block IDs :param retrieve_mode: Retrieval mode - "embedding", "reasoning", or "feature" :param use_reranker: Whether to use reranker to improve retrieval results :param num_retrieve: Number of blocks to retrieve initially :param num_rerank: Number of blocks to keep after reranking

Query parameters

  • query string Required
  • context string | null
  • context_blocks array[integer]

    Default value is [] (empty).

  • retrieve_mode string

    Values are feature, embedding, or reasoning.

  • use_reranker boolean

    Default value is true.

  • num_retrieve integer

    Default value is 20.

  • num_rerank integer

    Default value is 5.

Responses

  • 200 application/json

    Successful Response

    Hide response attribute Show response attribute object
    • message string Required
  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
      • loc array[string | integer] Required
      • msg string Required
      • type string Required
GET /sink/rag
curl \
 --request GET 'http://api.example.com/sink/rag?query=string'
Response examples (200)
{
  "message": "string"
}
Response examples (422)
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}