Databricks SDK for JavaScript
    Preparing search index...

    Interface DeltaSyncVectorIndexSpec

    interface DeltaSyncVectorIndexSpec {
        columnsToIndex?: string[];
        columnsToSync?: string[];
        embeddingSourceColumns?: EmbeddingSourceColumn[];
        embeddingVectorColumns?: EmbeddingVectorColumn[];
        embeddingWritebackTable?: string;
        pipelineId?: string;
        pipelineType?: PipelineType;
        sourceTable?: string;
    }
    Index

    Properties

    columnsToIndex? columnsToSync? embeddingSourceColumns? embeddingVectorColumns? embeddingWritebackTable? pipelineId? pipelineType? sourceTable?

    Properties

    columnsToIndex?: string[]

    [Optional] Alias for columns_to_sync. Select the columns to include in the vector index. If you leave this field blank, all columns from the source table are included. The primary key column and embedding source column or embedding vector column are always included. Only one of columns_to_sync or columns_to_index may be specified.

    columnsToSync?: string[]

    [Optional] Select the columns to sync with the vector index. If you leave this field blank, all columns from the source table are synced with the index. The primary key column and embedding source column or embedding vector column are always synced.

    embeddingSourceColumns?: EmbeddingSourceColumn[]

    The columns that contain the embedding source.

    embeddingVectorColumns?: EmbeddingVectorColumn[]

    The columns that contain the embedding vectors.

    embeddingWritebackTable?: string

    [Optional] Name of the Delta table to sync the vector index contents and computed embeddings to.

    pipelineId?: string

    The ID of the pipeline that is used to sync the index.

    pipelineType?: PipelineType

    Pipeline execution mode.

    • TRIGGERED: If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.
    • CONTINUOUS: If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.
    sourceTable?: string

    The name of the source table.

    Settings

    Member Visibility

    On This Page

    Properties