Function: createIndexTool()
createIndexTool(
options?):Tool<{columnsToSync?:string[];embeddingDimension?:number;embeddingModel?:string;embeddingSourceColumn?:string;endpoint?:string;name:string;pipelineType?:"TRIGGERED"|"CONTINUOUS";primaryKey?:string;sourceTable?:string; }, {columns:string[];endpoint?:string;name:string;primaryKey?:string;ready:boolean;rowCount?:number; },unknown,unknown,ToolExecutionContext<unknown,unknown,unknown>,string,unknown>
Build the opt-in create_index tool (provision a Vector Search index).
Only install it when the plugin’s write surface is enabled. Delegates to
SearchClient.createIndex, inferring the endpoint, embedding model,
key, and columns from the request + plugin config.
Parameters
Section titled “Parameters”options?
Section titled “options?”SearchToolOptions = {}
Returns
Section titled “Returns”Tool<{ columnsToSync?: string[]; embeddingDimension?: number; embeddingModel?: string; embeddingSourceColumn?: string; endpoint?: string; name: string; pipelineType?: "TRIGGERED" | "CONTINUOUS"; primaryKey?: string; sourceTable?: string; }, { columns: string[]; endpoint?: string; name: string; primaryKey?: string; ready: boolean; rowCount?: number; }, unknown, unknown, ToolExecutionContext<unknown, unknown, unknown>, string, unknown>