Function: searchTool()

searchTool(options?): Tool<{ columns?: string[]; filter?: Record<string, string | number | boolean | (string | number)[]>; index?: string; limit?: number; mode?: "hybrid" | "vector" | "keyword"; query: string; scoreThreshold?: number; }, { count: number; hits: object[]; index?: string; query: string; }, unknown, unknown, ToolExecutionContext<unknown, unknown, unknown>, string, unknown>

Build the search tool. Spread it into any agent that should be able to look things up in an index.

Parameters

options?

SearchToolOptions = {}

Returns

Tool<{ columns?: string[]; filter?: Record<string, string | number | boolean | (string | number)[]>; index?: string; limit?: number; mode?: "hybrid" | "vector" | "keyword"; query: string; scoreThreshold?: number; }, { count: number; hits: object[]; index?: string; query: string; }, unknown, unknown, ToolExecutionContext<unknown, unknown, unknown>, string, unknown>

Example

import { searchTool } from "@dbx-tools/search";
import { createAgent } from "@dbx-tools/appkit-mastra";

const support = createAgent({
  instructions: "Answer from the docs. Use `search` to find them.",
  tools: () => ({ search: searchTool() }),
});