Databricks SDK for JavaScript
    Preparing search index...
    interface QueryVectorIndexRequest {
        columns?: string[];
        columnsToRerank?: string[];
        facets?: string[];
        filtersJson?: string;
        name?: string;
        numResults?: number;
        queryColumns?: string[];
        queryText?: string;
        queryType?: string;
        queryVector?: number[];
        reranker?: RerankerConfig;
        scoreThreshold?: number;
        sortColumns?: string[];
    }
    Index

    Properties

    columns?: string[]

    List of column names to include in the response.

    columnsToRerank?: string[]

    Column names used to retrieve data to send to the reranker.

    facets?: string[]

    Facets 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.

    filtersJson?: string

    JSON 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.
    name?: string

    Name of the vector index to query.

    numResults?: number

    Number of results to return. Defaults to 10.

    queryColumns?: string[]

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

    queryText?: string

    Query text. Required for Delta Sync Index using model endpoint.

    queryType?: string

    The query type to use. Choices are ANN and HYBRID and FULL_TEXT. Defaults to ANN.

    queryVector?: number[]

    Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed vectors.

    reranker?: RerankerConfig

    If 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.

    scoreThreshold?: number

    Threshold for the approximate nearest neighbor search. Defaults to 0.0.

    sortColumns?: string[]

    Sort 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"].