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.
Documentation Index
Fetch the complete documentation index at: https://docs.xagent.run/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Target collection to search within
Query text to search for
Embedding model ID (default: text-embedding-v4)
Search strategy: dense, sparse, or hybrid (default: hybrid)
dense, sparse, hybrid Maximum number of results to return (default: 5)
1 <= x <= 100Optional 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.
Optional fusion configuration for hybrid search
Optional rerank model ID for result reordering
Optional override for rerank result count
Avoid index modifications (default: False)
Number of partitions to probe for ANN search
Refine factor for ANN search re-ranking
Allow hybrid search to fallback to sparse (default: True)
Successful Response
Unified response payload for document search pipeline.
Pipeline status: success|partial_success|error
Actual search strategy executed (post-fallback if any)
dense, sparse, hybrid Number of results returned
Human-readable pipeline outcome message
Search results (possibly reranked)
Non-fatal warnings and fallback messages
Whether rerank model was applied to the results