Type Alias: ToolDefinitionConfig<TInput, TOutput, TName, TNeedsApproval, TApprovalSchema>#

type ToolDefinitionConfig<TInput, TOutput, TName, TNeedsApproval, TApprovalSchema> = object & ApprovalConfig<TNeedsApproval, TApprovalSchema>;

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

Tool definition configuration

Type Declaration#

description#

description: string;

inputSchema?#

optional inputSchema?: TInput;

lazy?#

optional lazy?: boolean;

metadata?#

optional metadata?: Record<string, unknown>;

name#

name: TName;

outputSchema?#

optional outputSchema?: TOutput;

Type Parameters#

TInput#

TInput extends SchemaInput | undefined = undefined

TOutput#

TOutput extends SchemaInput | undefined = undefined

TName#

TName extends string = string

TNeedsApproval#

TNeedsApproval extends boolean = false

TApprovalSchema#

TApprovalSchema extends ApprovalSchemaConfig | undefined = undefined