Sign in

v2

latestOpenAPI 3.1.02026-07-2670186350.6 KB
knowledge

Query Knowledge Base

Query a knowledge base by its id

post/knowledge/{knowledge_base_id}/query

Path parameters

knowledge_base_idstring uuid required

The id of the knowledge base to query

The id of the knowledge base to query

Request body

querystring required

Query string

prefilter_limitinteger

Number of documents to retrieve from the knowledge base before filtering

top_kinteger

Number of documents to return

rerankboolean

Whether to rerank the results

parent_span_idstring uuid nullable

Parent span id

Example request

{
  "query": "What is the capital of France?",
  "prefilter_limit": 10,
  "top_k": 3,
  "filters": [
    {
      "field": "price",
      "operation": ">",
      "value": 100
    },
    {
      "field": "category",
      "operation": "in",
      "value": [
        "product",
        "service"
      ]
    }
  ]
}

Response

Successful Response

idstring uuid required

The id of the document

keystring required

The key of the document

contentstring required

The content of the document

metadataobject required

The metadata of the document

scorenumber required

The score of the document

Example response

[
  {
    "key": "paris_123",
    "content": "The capital of France is Paris",
    "metadata": {
      "category": "product",
      "price": 100
    },
    "score": 0.95
  }
]