[DEPRECATED] Perform semantic search across vector store chunks
DEPRECATED: Use POST /stores/search instead
Request body
Example request
{
"query": "how to configure SSL",
"filters": {
"all": [
{
"key": "price",
"operator": "gt",
"value": "100"
},
{
"key": "color",
"operator": "eq",
"value": "red"
}
],
"any": [
{
"key": "price",
"operator": "gt",
"value": "100"
},
{
"key": "color",
"operator": "eq",
"value": "red"
}
],
"none": [
{
"key": "price",
"operator": "gt",
"value": "100"
},
{
"key": "color",
"operator": "eq",
"value": "red"
}
]
},
"file_ids": [
"123e4567-e89b-12d3-a456-426614174000",
"123e4567-e89b-12d3-a456-426614174001"
],
"search_options": {
"rerank": {
"model": "rerank_model",
"top_k": 10
}
}
}Response
List of semantically similar chunks with relevance scores and pagination details
Example response
{
"data": [
{
"mime_type": "text/plain",
"model": "text-embedding-ada-002",
"score": 0.5,
"file_id": "file1",
"filename": "file1",
"vector_store_id": "store1",
"metadata": {
"key": "value"
},
"context": "This chunk is from an SEC filing on ACME corp's Q2 2023 performance.",
"summary": "A short overview of ACME's Q2 2023 performance."
}
]
}Changes
Changed in 2 of the 17 revisions of this API.5
- ○
added the new optional request property
/new-optional-request-property
- ○
- ○
the
request property default value changed frommixedbread-ai/mxbai-rerank-v3-listwisetomixedbread-ai/mxbai-rerank-v3.1-listwiserequest-property-default-value-changed
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○