Interface StructuredToolInterface<T>

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

Should not change on patch releases.

Type Parameters

T extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>

Hierarchy

RunnableInterface<(z.output<T> extends string
? string
: never) | z.input<T>, string>
- 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: T | ZodEffects<T, output<T>, input<T>>

Methods

batch

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

call

call(arg, configArg?, tags?): Promise<string>
Calls the tool with the provided argument, configuration, and tags. It parses the input according to the schema, handles any errors, and manages callbacks.
Parameters
- arg: input<T> | (output<T> extends string
  ? string
  : never)
  
  The input argument for the tool.
- Optional configArg: Callbacks | RunnableConfig
  
  Optional configuration or callbacks for the tool.
- Optional tags: string[]
  
  Optional tags for the tool.
Returns Promise<string>
A Promise that resolves with a string.
- Defined in langchain-core/src/tools.ts:54

invoke

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

stream

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

transform

transform(generator, options): AsyncGenerator<string, any, unknown>
Parameters
- generator: AsyncGenerator<(output<T> extends string
  ? string
  : never) | input<T>, any, unknown>
- options: Partial<RunnableConfig>
Returns AsyncGenerator<string, any, unknown>
Inherited from RunnableInterface.transform
- Defined in langchain-core/src/runnables/base.ts:74

Interface StructuredToolInterface<T>

Type Parameters

T extends z.ZodObject<any, any, any, any> = z.ZodObject<any, any, any, any>

Hierarchy

Index

Properties

Methods

Properties

description

name

returnDirect

schema

Methods

batch

Parameters

inputs: ((output<T> extends string ? string : never) | input<T>)[]

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

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

Returns Promise<string[]>

Parameters

inputs: ((output<T> extends string ? string : never) | input<T>)[]

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

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(string | Error)[]>

Parameters

inputs: ((output<T> extends string ? string : never) | input<T>)[]

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

Optional batchOptions: RunnableBatchOptions

Returns Promise<(string | Error)[]>

call

Parameters

arg: input<T> | (output<T> extends string ? string : never)

Optional configArg: Callbacks | RunnableConfig

Optional tags: string[]

Returns Promise<string>

invoke

Parameters

input: (output<T> extends string ? string : never) | input<T>

Optional options: Partial<RunnableConfig>

Returns Promise<string>

stream

Parameters

input: (output<T> extends string ? string : never) | input<T>

Optional options: Partial<RunnableConfig>

Returns Promise<IterableReadableStreamInterface<string>>

transform

Parameters

generator: AsyncGenerator<(output<T> extends string ? string : never) | input<T>, any, unknown>

options: Partial<RunnableConfig>

Returns AsyncGenerator<string, any, unknown>

Settings

Member Visibility

Theme

On This Page

inputs: ((output<T> extends string
? string
: never) | input<T>)[]

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

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

inputs: ((output<T> extends string
? string
: never) | input<T>)[]

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

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

inputs: ((output<T> extends string
? string
: never) | input<T>)[]

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

`Optional` batchOptions: RunnableBatchOptions

arg: input<T> | (output<T> extends string
? string
: never)

`Optional` configArg: Callbacks | RunnableConfig

`Optional` tags: string[]

input: (output<T> extends string
? string
: never) | input<T>

`Optional` options: Partial<RunnableConfig>

input: (output<T> extends string
? string
: never) | input<T>

`Optional` options: Partial<RunnableConfig>

generator: AsyncGenerator<(output<T> extends string
? string
: never) | input<T>, any, unknown>