XOxorbitsai
kb

Search

Search documents in the knowledge base.

Args: collection: Target collection to search within. query_text: Query text to search for. embedding_model_id: Embedding model ID (required for dense/hybrid search). search_type: Search strategy (dense, sparse, or hybrid). top_k: Maximum number of results to return. filters: Optional filters for search. fusion_config: Optional fusion configuration for hybrid search. rerank_model_id: Optional rerank model for result reordering. rerank_top_k: Override for rerank result count. readonly: Whether to avoid index modifications. nprobes: Number of partitions to probe for ANN search. refine_factor: Refine factor for ANN search re-ranking. fallback_to_sparse: Allow hybrid search to fallback to sparse.

post/api/kb/search

Request

Request body application/x-www-form-urlencoded

collectionstring required

Target collection to search within

query_textstring required

Query text to search for

embedding_model_idstring

Embedding model ID (default: text-embedding-v4)

search_type'dense' | 'sparse' | 'hybrid'

Unified search types for the document search pipeline.

top_kinteger nullable

Maximum number of results to return (default: 5)

filtersobject nullable

Optional filters to apply during search. Format: {field: value} for equality filters. For advanced filters, use {field: {operator: str, value: Any}} where operator can be: eq, ne, gt, gte, lt, lte, in, contains.

fusion_configobject nullable

Optional fusion configuration for hybrid search

rerank_model_idstring nullable

Optional rerank model ID for result reordering

rerank_top_kinteger nullable

Optional override for rerank result count

readonlyboolean nullable

Avoid index modifications (default: False)

nprobesinteger nullable

Number of partitions to probe for ANN search

refine_factorinteger nullable

Refine factor for ANN search re-ranking

fallback_to_sparseboolean nullable

Allow hybrid search to fallback to sparse (default: True)

Response

Successful Response

statusstring required

Pipeline status: success|partial_success|error

search_type'dense' | 'sparse' | 'hybrid' required

Unified search types for the document search pipeline.

result_countinteger required

Number of results returned

warningsstring[]

Non-fatal warnings and fallback messages

messagestring required

Human-readable pipeline outcome message

used_rerankboolean

Whether rerank model was applied to the results

Changes

No recorded changes to this operation across all 5 revisions of this API.