VectorSearchIndex

laktory.models.resources.databricks.VectorSearchIndex

Bases: BaseModel, PulumiResource, TerraformResource

Databricks Warehouse

Examples:

from laktory import models

index = models.resources.databricks.VectorSearchIndex(
    name="dev.finances.market_news_vs_index",
    primary_key="id",
    endpoint_name="default",
    index_type="DELTA_SYNC",
    delta_sync_index_spec={
        "source_table": "dev.finances.market_news",
        "embedding_vector_columns": [
            {"name": "embedding", "embedding_dimension": 4095}
        ],
        "pipeline_type": "TRIGGERED",
    },
)

PARAMETER	DESCRIPTION
delta_sync_index_spec	Specification for Delta Sync Index. Required if index_type is DELTA_SYNC. TYPE: VectorSearchIndexDeltaSyncIndexSpec | VariableType DEFAULT: None
direct_access_index_spec	Specification for Direct Vector Access Index. Required if index_type is DIRECT_ACCESS. TYPE: VectorSearchIndexDirectAccessIndexSpec | VariableType DEFAULT: None
endpoint_name	The name of the Vector Search Endpoint that will be used for indexing the data. TYPE: str | VariableType
index_type	Vector Search index type. Currently supported values are: - DELTA_SYNC: An index that automatically syncs with a source Delta Table, automatically and incrementally updating the index as the underlying data in the Delta Table changes. - DIRECT_ACCESS: An index that supports the direct read and write of vectors and metadata through our REST and SDK APIs. With this model, the user manages index updates. TYPE: Literal['DELTA_SYNC', 'DIRECT_ACCESS'] | VariableType
name	Three-level name of the Vector Search Index to create (catalog.schema.index_name). TYPE: str | VariableType
primary_key	The column name that will be used as a primary key. TYPE: str | VariableType

---

laktory.models.resources.databricks.vectorsearchindex.VectorSearchIndexDeltaSyncIndexSpec

Bases: BaseModel

PARAMETER	DESCRIPTION
embedding_source_columns	Array of objects representing columns that contain the embedding source TYPE: list[VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn | VariableType] | VariableType DEFAULT: None
embedding_vector_columns	(required if embedding_source_columns isn't provided) array of objects representing columns that contain the embedding vectors. TYPE: list[VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn | VariableType] | VariableType DEFAULT: None
embedding_writeback_table	TYPE: str | VariableType DEFAULT: None
pipeline_id	ID of the associated Declarative Pipeline. TYPE: str | VariableType DEFAULT: None
pipeline_type	TYPE: Literal['TRIGGERED', 'CONTINUOUS'] | VariableType DEFAULT: None
source_table	Pipeline execution mode. Possible values are: - 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 the vector index fresh. TYPE: str | VariableType DEFAULT: None

---

laktory.models.resources.databricks.vectorsearchindex.VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn

Bases: BaseModel

PARAMETER	DESCRIPTION
embedding_model_endpoint_name	The name of the embedding model endpoint TYPE: str | VariableType
name	Three-level name of the Vector Search Index to create (catalog.schema.index_name). TYPE: str | VariableType

---

laktory.models.resources.databricks.vectorsearchindex.VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn

Bases: BaseModel

PARAMETER	DESCRIPTION
embedding_dimension	Dimension of the embedding vector. TYPE: int | VariableType
name	Three-level name of the Vector Search Index to create (catalog.schema.index_name). TYPE: str | VariableType

---

laktory.models.resources.databricks.vectorsearchindex.VectorSearchIndexDirectAccessIndexSpec

Bases: BaseModel

PARAMETER	DESCRIPTION
embedding_source_columns	Array of objects representing columns that contain the embedding source TYPE: list[VectorSearchIndexDeltaSyncIndexSpecEmbeddingSourceColumn | VariableType] | VariableType DEFAULT: None
embedding_vector_columns	(required if embedding_source_columns isn't provided) array of objects representing columns that contain the embedding vectors. TYPE: list[VectorSearchIndexDeltaSyncIndexSpecEmbeddingVectorColumn | VariableType] | VariableType DEFAULT: None