Skip to content
dbx tools

Variable: searchToolSchema

const searchToolSchema: ZodObject<{ columns: ZodOptional<ZodArray<ZodString>>; filter: ZodOptional<ZodRecord<ZodString, ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean, ZodArray<ZodUnion<readonly [ZodString, ZodNumber]>>]>>>; index: ZodOptional<ZodString>; limit: ZodOptional<ZodNumber>; mode: ZodOptional<ZodEnum<{ hybrid: "hybrid"; keyword: "keyword"; vector: "vector"; }>>; query: ZodString; scoreThreshold: ZodOptional<ZodNumber>; }, $strip> = searchSchemas.searchRequestSchema

Schema for the search tool input (the shared request schema).

searchTool fields

Section titled “searchTool fields”
  • query: What to search for, as natural language or keywords. Prefix fragments work for autocomplete.
  • index (optional): Unity Catalog name of the index to search (catalog.schema.index). Defaults to the plugin’s configured index. Accepts a short alias when one is configured.
  • limit (optional): Maximum number of hits to return. Defaults to the plugin’s configured page size.
  • mode (optional): Match strategy: ‘hybrid’ fuses semantic similarity with keyword ranking (default, best for most searches), ‘vector’ is pure semantic, ‘keyword’ is pure full-text.
  • columns (optional): Which document columns to return per hit. Defaults to the plugin’s configured columns (or all indexed columns).
  • filter (optional): AppKit AI Search attribute filters as { column: scalarOrArray }. Combined with AND.
  • scoreThreshold (optional): Drop hits whose relevance score is below this value.