본문으로 건너뛰기

인터페이스: ClientTool<TInput, TOutput, TName, TContext, TNeedsApproval, TApprovalSchema>

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:107

클라이언트 측 도구를 나타내는 마커 타입입니다.

확장

  • ToolApprovalCapabilityMarker<TNeedsApproval, TApprovalSchema>

타입 매개변수

TInput

TInput extends SchemaInput | undefined = undefined

TOutput

TOutput extends SchemaInput | undefined = undefined

TName

TName extends string = string

TContext

TContext = unknown

TNeedsApproval

TNeedsApproval extends boolean = false

TApprovalSchema

TApprovalSchema extends | ApprovalSchemaConfig | undefined = undefined

속성

__toolSide

__toolSide: "client";

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:118


[toolApprovalCapability]?

readonly optional [toolApprovalCapability]?: object;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:26

approvalSchema

approvalSchema: TApprovalSchema;

needsApproval

needsApproval: TNeedsApproval;

상속됨

ToolApprovalCapabilityMarker.[toolApprovalCapability]

approvalSchema?

optional approvalSchema?: TApprovalSchema;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:129


description

description: string;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:120


execute?

optional execute?: ToolExecuteFunction<TInput, TOutput, TContext>;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:132


inputSchema?

optional inputSchema?: TInput;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:126


lazy?

optional lazy?: boolean;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:130


metadata?

optional metadata?: Record<string, unknown>;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:131


name

name: TName;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:119


needsApproval?

optional needsApproval?: TNeedsApproval;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:128


outputSchema?

optional outputSchema?: TOutput;

정의 위치: packages/ai/src/activities/chat/tools/tool-definition.ts:127