Knowledge Bases
Query a knowledge base
Knowledge Bases
Query a knowledge base
POST
/
knowledge-base
/
{id}
/
query
curl --request POST \
--url https://api.vectorshift.ai/v1/knowledge-base/{id}/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"queries": [
"<string>"
],
"context": "<string>",
"search_metadata": {
"filter": "<string>",
"opensearch_filter": "<string>",
"top_k": 123,
"group_by_key": "<string>"
},
"config": {
"rerank_documents": true,
"generate_metadata_filters": true,
"transform_query": true,
"answer_multi_query": true,
"expand_query": true,
"do_advanced_qa": true,
"format_context_for_llm": true,
"generate_ai_doc_summaries": true,
"retrieval_unit": "<string>",
"retrieval_config": {
"max_documents": 123,
"data_fusion_method": "<string>"
},
"reranking_config": {
"reranking_model": "<string>",
"api_key": "<string>",
"num_chunks_to_rerank": 123
},
"question_answering_config": {
"qa_model": "<string>",
"advanced_qa_mode": "<string>"
},
"hybrid_search_config": {
"alpha": 123,
"fusion_method": "<string>"
},
"score_cutoff": 123
},
"semantic_search_chunks": {}
}'
{
"status": "success",
"result": {}
}
Authorizations
Bearer token authentication using API key
Path Parameters
Knowledge base ID
Body
curl --request POST \
--url https://api.vectorshift.ai/v1/knowledge-base/{id}/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"queries": [
"<string>"
],
"context": "<string>",
"search_metadata": {
"filter": "<string>",
"opensearch_filter": "<string>",
"top_k": 123,
"group_by_key": "<string>"
},
"config": {
"rerank_documents": true,
"generate_metadata_filters": true,
"transform_query": true,
"answer_multi_query": true,
"expand_query": true,
"do_advanced_qa": true,
"format_context_for_llm": true,
"generate_ai_doc_summaries": true,
"retrieval_unit": "<string>",
"retrieval_config": {
"max_documents": 123,
"data_fusion_method": "<string>"
},
"reranking_config": {
"reranking_model": "<string>",
"api_key": "<string>",
"num_chunks_to_rerank": 123
},
"question_answering_config": {
"qa_model": "<string>",
"advanced_qa_mode": "<string>"
},
"hybrid_search_config": {
"alpha": 123,
"fusion_method": "<string>"
},
"score_cutoff": 123
},
"semantic_search_chunks": {}
}'
{
"status": "success",
"result": {}
}