Interface AIPluginToolParams

Interface for parameters required to create an instance of AIPluginTool.

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

Hierarchy (view full)

Implemented by

Properties

apiSpec callbacks? defaultConfig? description metadata? name responseFormat? tags? verbose? verboseParsingErrors?

Properties

apiSpec

apiSpec: string

Optionalcallbacks

callbacks?: Callbacks

OptionaldefaultConfig

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

Default config object for the tool runnable.

description

description: string

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"

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