Query - v3
Query - v3
Search indexed files and return source chunks with optional document, metadata, region (bounding boxes), relation, and related chunk context.
Compared with v2: this response uses results[].text, supports explicit include controls, and returns structured rerank details.
Path parameters
collection_name
Request
This endpoint expects an object.
query
Natural-language search query.
limit
Maximum number of ranked chunks to return.
filter
Document metadata and chunk metadata filter expression. Supports operators such as \$eq, \$ne, \$gt, \$gte, \$lt, \$lte, \$in, \$nin, \$and, and \$or.
rerank
Whether to request reranking. Multimodal collections may apply reranking even when this is false.
include
Controls which optional result objects are included in the response.
relation_types
Optional relation type filter when include.relations or include.related_chunks is enabled.
relation_direction
Which graph edge direction to include for relation context.
Response
Query response.
query
Echo of the submitted query.
results
Retrieved source chunks sorted by final retrieval score.
total_results
Number of results returned in this response.
limit
Result limit applied to the request.
rerank
Whether reranking was applied and why.
warnings
Non-fatal notices about the request or response, such as forced reranking for multimodal collections.
execution_time_ms
Server-side execution time in milliseconds.
request_id
Request identifier for support and trace lookup.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error