Interface DynamicStructuredToolInput<SchemaT, SchemaOutputT, ToolOutputT>

Interface for the input parameters of the DynamicStructuredTool class.

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

Type Parameters

  • SchemaT = ToolSchemaBase

    The type of the tool input schema. Usually you don't need to specify this.

  • SchemaOutputT = ToolInputSchemaOutputType<SchemaT>

    The TypeScript type representing the result of applying the schema to the tool arguments. Useful for type checking tool handler functions when using JSONSchema.

  • ToolOutputT = ToolOutputType

Hierarchy (view full)

Properties

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

Properties

Optionalcallbacks

callbacks?: Callbacks

OptionaldefaultConfig

defaultConfig?: ToolRunnableConfig<Record<string, any>>

Default config object for the tool runnable.

description

description: string

func

func: ((input: SchemaOutputT, runManager?: CallbackManagerForToolRun, config?: RunnableConfig<Record<string, any>>) => Promise<ToolOutputT>)

Tool handler function - the function that will be called when the tool is invoked.

Type declaration

Optionalmetadata

metadata?: Record<string, unknown>

Metadata for the tool.

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

Whether to return the tool's output directly.

Setting this to true means that after the tool is called, an agent should stop looping.

schema

schema: SchemaT

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