Interface: IndexConfig

Properties

auth?

optional auth: "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).

columns?

optional columns: 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).

embeddingFn()?

optional embeddingFn: (text: string) => Promise<number[]>;

For self-managed embedding indexes: converts query text to an embedding vector. When provided, the plugin calls this function and sends query_vector to VS. When omitted, query_text is sent and VS computes embeddings server-side (managed mode).

Parameters

Returns

Promise<number[]>

endpointName?

optional endpointName: string;

VS endpoint name (required when pagination is true)

indexName?

optional indexName: 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.

numResults?

optional numResults: number;

Max results per query

pagination?

optional pagination: boolean;

Enable cursor pagination

queryType?

optional queryType: SearchQueryType;

Default search mode

reranker?

optional reranker: boolean | RerankerConfig;

Enable built-in reranker. Pass true to rerank all non-id columns, or an object for fine control.