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

ToolDefinitionConfig

Interface: ToolDefinitionConfig<TInput, TOutput, TName>

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

Tool definition configuration

Type Parameters

TInput

TInput extends SchemaInput = SchemaInput

TOutput

TOutput extends SchemaInput = SchemaInput

TName

TName extends string = string

Properties

description

ts
description: string;
description: string;

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


inputSchema?

ts
optional inputSchema: TInput;
optional inputSchema: TInput;

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


metadata?

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

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


name

ts
name: TName;
name: TName;

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


needsApproval?

ts
optional needsApproval: boolean;
optional needsApproval: boolean;

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


outputSchema?

ts
optional outputSchema: TOutput;
optional outputSchema: TOutput;

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