Interface: ToolDefinitionConfig\#

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

Tool definition configuration

Type Parameters#

TInput#

TInput extends SchemaInput = SchemaInput

TOutput#

TOutput extends SchemaInput = SchemaInput

TName#

TName extends string = string

Properties#

description#

description: string;

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

inputSchema?#

optional inputSchema: TInput;

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

lazy?#

optional lazy: boolean;

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

metadata?#

optional metadata: Record<string, unknown>;

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

name#

name: TName;

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

needsApproval?#

optional needsApproval: boolean;

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

outputSchema?#

optional outputSchema: TOutput;

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