Interface: ToolDefinitionConfig<TInput, TOutput, TName, TNeedsApproval>#

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:107

Tool definition configuration

Type Parameters#

TInput#

TInput extends SchemaInput = SchemaInput

TOutput#

TOutput extends SchemaInput = SchemaInput

TName#

TName extends string = string

TNeedsApproval#

TNeedsApproval extends boolean = false

Properties#

description#

description: string;

description: string;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:114

inputSchema?#

optional inputSchema: TInput;

optional inputSchema: TInput;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:115

lazy?#

optional lazy: boolean;

optional lazy: boolean;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:118

metadata?#

optional metadata: Record<string, unknown>;

optional metadata: Record<string, unknown>;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:119

name#

name: TName;

name: TName;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:113

needsApproval?#

optional needsApproval: TNeedsApproval;

optional needsApproval: TNeedsApproval;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:117

outputSchema?#

optional outputSchema: TOutput;

optional outputSchema: TOutput;

Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:116