Documentation
Framework
Version
Class References
Function References
Interface References
Type Alias References
Variable References

ClientTool

Interface: ClientTool<TInput, TOutput, TName>

Defined in: activities/chat/tools/tool-definition.ts:23

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

ts
__toolSide: "client";
__toolSide: "client";

Defined in: activities/chat/tools/tool-definition.ts:28


description

ts
description: string;
description: string;

Defined in: activities/chat/tools/tool-definition.ts:30


execute()?

ts
optional execute: (args) => 
  | InferSchemaType<TOutput>
| Promise<InferSchemaType<TOutput>>;
optional execute: (args) => 
  | InferSchemaType<TOutput>
| Promise<InferSchemaType<TOutput>>;

Defined in: activities/chat/tools/tool-definition.ts:35

Parameters

args

InferSchemaType<TInput>

Returns

| InferSchemaType<TOutput> | Promise<InferSchemaType<TOutput>>


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

Defined in: activities/chat/tools/tool-definition.ts:31


metadata?

ts
optional metadata: Record<string, unknown>;
optional metadata: Record<string, unknown>;

Defined in: activities/chat/tools/tool-definition.ts:34


name

ts
name: TName;
name: TName;

Defined in: activities/chat/tools/tool-definition.ts:29


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

Defined in: activities/chat/tools/tool-definition.ts:33


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

Defined in: activities/chat/tools/tool-definition.ts:32