OptionalcolumnsOptionalcolumnsColumn names used to retrieve data to send to the reranker.
OptionalfacetsFacets to compute over the matched results. Each entry has one of these forms:
"<column>" - top 10 distinct values by count
"<column> TOP <n>" - top n distinct values, where n > 0
"<column> BUCKETS [[from,to],...]" - inclusive numeric ranges
TOP and BUCKETS are case-insensitive. A column may appear at most once.
OptionalfiltersJSON string representing query filters.
Example filters:
{"id <": 5}: Filter for id less than 5.{"id >": 5}: Filter for id greater than 5.{"id <=": 5}: Filter for id less than equal to 5.{"id >=": 5}: Filter for id greater than equal to 5.{"id": 5}: Filter for id equal to 5.OptionalnameName of the vector index to query.
OptionalnumNumber of results to return. Defaults to 10.
OptionalqueryText columns to search for query_text. When empty, all text columns are searched.
OptionalqueryQuery text. Required for Delta Sync Index using model endpoint.
OptionalqueryThe query type to use. Choices are ANN and HYBRID and FULL_TEXT. Defaults to ANN.
OptionalqueryQuery vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.
OptionalrerankerIf set, the top 50 results are reranked with the Databricks Reranker model before returning the num_results results to the user.
The setting columns_to_rerank selects which columns are used for reranking. For each datapoint, the columns selected are concatenated before
being sent to the reranking model. See https://docs.databricks.com/aws/en/vector-search/query-vector-search#rerank for more information.
OptionalscoreThreshold for the approximate nearest neighbor search. Defaults to 0.0.
OptionalsortSort results by column values instead of the default relevance ordering.
Each clause has the form "<column> ASC" or "<column> DESC", for example
["rating DESC", "price ASC"].
List of column names to include in the response.