Interface ToolInterface

Base interface implemented by all runnables. Used for cross-compatibility between different versions of LangChain core.

Should not change on patch releases.

Hierarchy

StructuredToolInterface
- ToolInterface

Index

Properties

description name returnDirect schema

Methods

batch call invoke stream transform

Properties

description

description: string

name

name: string

returnDirect

returnDirect: boolean

schema

schema: ZodObject<any, any, any, any, {}> | ZodEffects<ZodObject<any, any, any, any, {}>, any, {}>

Methods

batch

batch(inputs, options?, batchOptions?): Promise<string[]>
Parameters
- inputs: (string | {})[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<string[]>
Inherited from StructuredToolInterface.batch
- Defined in langchain-core/src/runnables/base.ts:51
batch(inputs, options?, batchOptions?): Promise<(string | Error)[]>
Parameters
- inputs: (string | {})[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(string | Error)[]>
Inherited from StructuredToolInterface.batch
- Defined in langchain-core/src/runnables/base.ts:57
batch(inputs, options?, batchOptions?): Promise<(string | Error)[]>
Parameters
- inputs: (string | {})[]
- Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(string | Error)[]>
Inherited from StructuredToolInterface.batch
- Defined in langchain-core/src/runnables/base.ts:63

call

call(arg, callbacks?): Promise<string>
Calls the tool with the provided argument and callbacks. It handles string inputs specifically.
Parameters
- arg: undefined | string | {}
  
  The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.
- Optional callbacks: Callbacks | RunnableConfig
  
  Optional callbacks for the tool.
Returns Promise<string>
A Promise that resolves with a string.
Overrides StructuredToolInterface.call
- Defined in langchain-core/src/tools.ts:175

invoke

invoke(input, options?): Promise<string>
Parameters
- input: string | {}
- Optional options: Partial<RunnableConfig>
Returns Promise<string>
Inherited from StructuredToolInterface.invoke
- Defined in langchain-core/src/runnables/base.ts:49

stream

stream(input, options?): Promise<IterableReadableStreamInterface<string>>
Parameters
- input: string | {}
- Optional options: Partial<RunnableConfig>
Returns Promise<IterableReadableStreamInterface<string>>
Inherited from StructuredToolInterface.stream
- Defined in langchain-core/src/runnables/base.ts:69

transform

transform(generator, options): AsyncGenerator<string, any, unknown>
Parameters
- generator: AsyncGenerator<string | {}, any, unknown>
- options: Partial<RunnableConfig>
Returns AsyncGenerator<string, any, unknown>
Inherited from StructuredToolInterface.transform
- Defined in langchain-core/src/runnables/base.ts:74

Interface ToolInterface

Hierarchy

Index

Properties

Methods

Properties

description

name

returnDirect

schema

Methods

batch

Parameters

inputs: (string | {})[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<string[]>

Parameters

inputs: (string | {})[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(string | Error)[]>

Parameters

inputs: (string | {})[]

Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(string | Error)[]>

call

Parameters

arg: undefined | string | {}

Optional callbacks: Callbacks | RunnableConfig

Returns Promise<string>

invoke

Parameters

input: string | {}

Optional options: Partial<RunnableConfig>

Returns Promise<string>

stream

Parameters

input: string | {}

Optional options: Partial<RunnableConfig>

Returns Promise<IterableReadableStreamInterface<string>>

transform

Parameters

generator: AsyncGenerator<string | {}, any, unknown>

options: Partial<RunnableConfig>

Returns AsyncGenerator<string, any, unknown>

Settings

Member Visibility

Theme

On This Page

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` callbacks: Callbacks | RunnableConfig

`Optional` options: Partial<RunnableConfig>

`Optional` options: Partial<RunnableConfig>