Interface DynamicStructuredToolInput<T>

Interface for the input parameters of the DynamicStructuredTool class.

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

Type Parameters

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

Hierarchy (view full)

Properties

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

Properties

Optionalcallbacks

callbacks?: Callbacks

description

description: string

func

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

Optionalmetadata

metadata?: Record<string, unknown>

name

name: string

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

schema

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

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

OptionalverboseParsingErrors

verboseParsingErrors?: boolean

Whether to show full details in the thrown parsing errors.

Default

false

Settings

Member Visibility

On This Page

Properties