Interface: ProvisionOptions
Options for SearchClient.provision - a one-call “make this index real and searchable” used at boot or in a seed script. It ensures the endpoint, ensures the index, and (optionally) seeds documents when the index is empty.
Extends
Section titled “Extends”Properties
Section titled “Properties”columnsToSync?
Section titled “columnsToSync?”
optionalcolumnsToSync?:string[]
Extra columns to sync alongside the embedding source (Delta Sync).
Inherited from
Section titled “Inherited from”CreateIndexOptions.columnsToSync
embeddingDimension?
Section titled “embeddingDimension?”
optionalembeddingDimension?:number
For a direct-access index: the embedding vector dimension (self-managed vectors, no source table).
Inherited from
Section titled “Inherited from”CreateIndexOptions.embeddingDimension
embeddingModel?
Section titled “embeddingModel?”
optionalembeddingModel?:string
Embedding model endpoint. A loose name is fuzzy-matched; when omitted the best embedding endpoint in the workspace is chosen (resolveEmbeddingModel).
Inherited from
Section titled “Inherited from”CreateIndexOptions.embeddingModel
embeddingSourceColumn?
Section titled “embeddingSourceColumn?”
optionalembeddingSourceColumn?:string
The text column embeddings are computed from (Delta Sync). Defaults to the
first of text / content / body present, else the caller must set it.
Inherited from
Section titled “Inherited from”CreateIndexOptions.embeddingSourceColumn
embeddingVectorColumn?
Section titled “embeddingVectorColumn?”
optionalembeddingVectorColumn?:string
For a direct-access index: the column the vector is stored in. Defaults to embedding.
Inherited from
Section titled “Inherited from”CreateIndexOptions.embeddingVectorColumn
endpoint?
Section titled “endpoint?”
optionalendpoint?:string
Vector Search endpoint to host the index on. Defaults to the plugin’s endpoint.
Inherited from
Section titled “Inherited from”pipelineType?
Section titled “pipelineType?”
optionalpipelineType?:"TRIGGERED"|"CONTINUOUS"
Sync mode for a Delta Sync index. TRIGGERED (default) syncs on demand; CONTINUOUS keeps fresh.
Inherited from
Section titled “Inherited from”CreateIndexOptions.pipelineType
primaryKey?
Section titled “primaryKey?”
optionalprimaryKey?:string
Primary-key column. Defaults to id.
Inherited from
Section titled “Inherited from”schema?
Section titled “schema?”
optionalschema?:Record<string,string>
The column-name -> type map used to build a direct-access index’s
schema_json (types: string, int, long, float, double,
boolean, date, timestamp). Must include the primary key and any
columns you upsert. Defaults to { id: "string", text: "string" }. The
embedding vector column is added automatically.
Inherited from
Section titled “Inherited from”
optionalseed?:Record<string,unknown>[]
Documents to seed when the index has no rows yet. Skipped if it already has data.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
External cancellation.
Inherited from
Section titled “Inherited from”sourceTable?
Section titled “sourceTable?”
optionalsourceTable?:string
Source Delta table (catalog.schema.table) for a Delta Sync index. Provide this for the common case: Databricks computes and syncs embeddings from it. Omit it (and pass embeddingDimension) to create a direct-access index you write vectors to yourself.
Inherited from
Section titled “Inherited from”CreateIndexOptions.sourceTable
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
How long to wait for readiness before giving up. Defaults to 20 minutes.
optionalwait?:boolean
Wait for the endpoint AND index to come online before returning (needed before seeding). Defaults to true. Endpoint creation can take many minutes.