Interface: EnsureOnSetupConfig
Boot-time provisioning + seeding for a single index (see ensureOnSetup).
Properties
Section titled “Properties”documents?
Section titled “documents?”
optionaldocuments?:Record<string,unknown>[]
Documents to seed when the index is empty. Plain { id, text, ... } rows for a managed index.
embeddingModel?
Section titled “embeddingModel?”
optionalembeddingModel?:string
Embedding model endpoint. Fuzzy-matched; defaults to the best embedding endpoint.
endpoint?
Section titled “endpoint?”
optionalendpoint?:string
Vector Search endpoint to host it on. Defaults to the plugin’s endpoint.
index?
Section titled “index?”
optionalindex?:string
UC name of the index to ensure (catalog.schema.index). Defaults to the plugin’s index.
primaryKey?
Section titled “primaryKey?”
optionalprimaryKey?:string
Primary-key column. Defaults to id.
schema?
Section titled “schema?”
optionalschema?:Record<string,string>
Column -> type map for the managed direct-access schema_json. Inferred from documents when omitted.
sourceTable?
Section titled “sourceTable?”
optionalsourceTable?:string
For a Delta Sync index instead of managed direct-access: the source Delta table.
textColumn?
Section titled “textColumn?”
optionaltextColumn?:string
Text column Databricks embeds (managed direct-access). Defaults to text.
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Max time to wait for endpoint + index readiness. Defaults to 20 minutes.