Skip to content

Interface: SearchIndexConfig

A configured index the plugin knows about ahead of time. Only name (or alias) is required; the rest is resolved from the live index definition when omitted, so a deployment can register { name } and let the plugin fill in the primary key and columns.

optional alias?: string

Short alias a caller may use in place of name (defaults to the last name segment).


optional columns?: string[]

Columns to return per hit, in display order. Defaults to every indexed column.


name: string

Unity Catalog name of the index (catalog.schema.index).


optional primaryKey?: string

Primary-key column. Resolved from the index definition when omitted.