langchain.js
    Preparing search index...

    Interface ToolParams

    Parameters for the Tool classes.

    interface ToolParams {
        callbacks?: Callbacks;
        defaultConfig?: ToolRunnableConfig<Record<string, any>, any>;
        extras?: Record<string, unknown>;
        metadata?: Record<string, unknown>;
        responseFormat?: string;
        tags?: string[];
        verbose?: boolean;
        verboseParsingErrors?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    callbacks? defaultConfig? extras? metadata? responseFormat? tags? verbose? verboseParsingErrors?

    Properties

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

    Default config object for the tool runnable.

    extras?: Record<string, unknown>

    Optional provider-specific extra fields for the tool.

    This is used to pass provider-specific configuration that doesn't fit into standard tool fields.

    metadata?: Record<string, unknown>

    Metadata for the tool.

    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.

    "content"
    tags?: string[]
    verbose?: boolean
    verboseParsingErrors?: boolean

    Whether to show full details in the thrown parsing errors.

    false

    Settings

    Member Visibility

    On This Page

    Properties