Interface: ClientTool<TInput, TOutput, TName>#
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:24
Marker type for client-side tools
Type Parameters#
TInput#
TInput extends SchemaInput = SchemaInput
TOutput#
TOutput extends SchemaInput = SchemaInput
TName#
TName extends string = string
Properties#
__toolSide#
__toolSide: "client";
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:29
description#
description: string;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:31
execute()?#
optional execute: (args) =>
| InferSchemaType<TOutput>
| Promise<InferSchemaType<TOutput>>;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:42
Parameters#
args#
InferSchemaType<TInput>
Returns#
| InferSchemaType<TOutput>
| Promise<InferSchemaType<TOutput>>
inputSchema?#
optional inputSchema: TInput;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:37
lazy?#
optional lazy: boolean;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:40
metadata?#
optional metadata: Record<string, unknown>;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:41
name#
name: TName;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:30
needsApproval?#
optional needsApproval: boolean;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:39
outputSchema?#
optional outputSchema: TOutput;
Defined in: packages/typescript/ai/src/activities/chat/tools/tool-definition.ts:38