Interface DynamicStructuredToolInput<T>

Interface for the input parameters of the DynamicStructuredTool class.

interface DynamicStructuredToolInput<T> {
    description: string;
    func: ((input: T extends ZodObjectAny
        ? TypeOf<T<T>>
        : T, runManager?: CallbackManagerForToolRun, config?: RunnableConfig) => Promise<any>);
    name: string;
    schema: T extends ZodObjectAny
        ? T<T>
        : T;
    callbacks?: Callbacks;
    metadata?: Record<string, unknown>;
    responseFormat?: string;
    returnDirect?: boolean;
    tags?: string[];
    verbose?: boolean;
}

Type Parameters

  • T extends ZodObjectAny | Record<string, any> = ZodObjectAny

Hierarchy (view full)

Properties

description func name schema callbacks? metadata? responseFormat? returnDirect? tags? verbose?

Properties

description

description: string

func

func: ((input: T extends ZodObjectAny
    ? TypeOf<T<T>>
    : T, runManager?: CallbackManagerForToolRun, config?: RunnableConfig) => Promise<any>)

name

name: string

schema

schema: T extends ZodObjectAny
    ? T<T>
    : T

Optionalcallbacks

callbacks?: Callbacks

Optionalmetadata

metadata?: Record<string, unknown>

OptionalresponseFormat

responseFormat?: string

The tool response format.

If "content" then the output of the tool is interpreted as the contents of a ToolMessage. If "content_and_artifact" then the output is expected to be a two-tuple corresponding to the (content, artifact) of a ToolMessage.

Default

"content"

OptionalreturnDirect

returnDirect?: boolean

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties