Databricks SDK for JavaScript
    Preparing search index...

    Interface QueryIndexRequest

    Request to query (search) an AI Search index. The legacy num_results count is exposed as max_results; v1 returns up to max_results rows in a single response (no cursor pagination — see the note on max_results below).

    interface QueryIndexRequest {
        columns?: string[];
        columnsToRerank?: string[];
        facets?: string[];
        filtersJson?: string;
        maxResults?: number;
        name?: string;
        queryColumns?: string[];
        queryText?: string;
        queryType?: string;
        queryVector?: number[];
        reranker?: RerankerConfig;
        scoreThreshold?: number;
        sortColumns?: string[];
    }
    Index

    Properties

    columns? columnsToRerank? facets? filtersJson? maxResults? name? queryColumns? queryText? queryType? queryVector? reranker? scoreThreshold? sortColumns?

    Properties

    columns?: string[]

    Column names to include in each result row.

    columnsToRerank?: string[]

    Columns whose values are sent to the reranker.

    facets?: string[]

    Facets to compute over the matched results (e.g. "category TOP 5").

    filtersJson?: string

    JSON string describing query filters (e.g. {"id >": 5}).

    maxResults?: number

    Maximum number of results to return (the legacy num_results). Defaults to 10.

    name?: string

    Full resource name of the index to query. Format: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

    queryColumns?: string[]

    Text columns to search for query_text. When empty, all text columns are searched.

    queryText?: string

    Query text. Required for Delta Sync indexes that compute embeddings from a model endpoint.

    queryType?: string

    Query type: ANN, HYBRID, or FULL_TEXT. Defaults to ANN.

    queryVector?: number[]

    Query vector. Required for Direct Access indexes and Delta Sync indexes with self-managed vectors.

    reranker?: RerankerConfig

    If set, results are reranked before being returned.

    scoreThreshold?: number

    Score threshold for the approximate nearest-neighbor search. Defaults to 0.0.

    sortColumns?: string[]

    Sort clauses, e.g. ["rating DESC", "price ASC"]. Overrides relevance ordering.

    Settings

    Member Visibility

    On This Page

    Properties