Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The id of the knowledge base to query
Body
application/json
Query string
Minimum length:
1
Example:
"What is the capital of France?"
Number of documents to retrieve from the knowledge base before filtering
Required range:
x > 0
Example:
10
Number of documents to return
Required range:
x > 0
Example:
3
Per-field filters to apply to the query combined with AND
Example:
[
{
"field": "price",
"operation": ">",
"value": 100
},
{
"field": "category",
"operation": "in",
"value": ["product", "service"]
}
]
Whether to rerank the results
Parent span id
Response
Successful Response
The id of the document
The key of the document
Example:
"paris_123"
The content of the document
Example:
"The capital of France is Paris"
The metadata of the document
Example:
{ "category": "product", "price": 100 }
The score of the document
Example:
0.95