Interface: LakebaseAiSearchIndexConfig
Per-alias Lakebase search configuration.
Extends
Section titled “Extends”Omit<IndexConfig,"embeddingFn"|"endpointName"|"pagination"|"reranker">
Properties
Section titled “Properties”
optionalauth?:"service-principal"|"on-behalf-of-user"
Auth mode for the built-in HTTP routes — “service-principal” (default)
uses the app’s SP, “on-behalf-of-user” proxies the logged-in user’s token.
Programmatic callers select per call via appkit.aiSearch.asUser(req).
Inherited from
Section titled “Inherited from”Omit.auth
columns?
Section titled “columns?”
optionalcolumns?:string[]
Columns to return in results. Optional: in development the plugin auto-discovers them from the index’s source table when omitted (and warns that they should be set explicitly for production).
Inherited from
Section titled “Inherited from”Omit.columns
documents?
Section titled “documents?”
optionaldocuments?:Record<string,unknown>[]
Documents used to seed an empty full-text table during setup.
indexName?
Section titled “indexName?”
optionalindexName?:string
Three-level UC name: catalog.schema.index_name. Defaults to the
DATABRICKS_VS_INDEX_NAME env var when omitted — so multiple aliases that
omit it all resolve to that same physical index. Set it explicitly per
alias when they should point at distinct indexes.
Inherited from
Section titled “Inherited from”Omit.indexName
numResults?
Section titled “numResults?”
optionalnumResults?:number
Max results per query
Inherited from
Section titled “Inherited from”Omit.numResults
queryType?
Section titled “queryType?”
optionalqueryType?:SearchQueryType
Default search mode
Inherited from
Section titled “Inherited from”Omit.queryType
textColumn?
Section titled “textColumn?”
optionaltextColumn?:string
Document field indexed first. Defaults to text.