StructuredTool

The unique name of the tool that clearly communicates its purpose.

Whether to return the tool's output directly.

Whether to log the tool's progress.

Callbacks to be called during tool execution.

Optional list of tags associated with the tool.

Optional metadata associated with the tool.

Handle the content of the ToolException thrown.

Handle the content of the ValidationError thrown.

The tool response format.

Optional provider-specific extra fields for the tool.

Check if the tool accepts only a single input argument.

Get the tool's input arguments schema.

Get the schema for tool calls, excluding injected arguments.

The tool's input schema.

Run the tool.

Run the tool asynchronously.

The name of the Runnable.

Serialize the Runnable to JSON.

Configure particular Runnable fields at runtime.

Configure alternatives for Runnable objects that can be set at runtime.

A map of constructor argument names to secret ids.

List of attribute names that should be included in the serialized kwargs.

Is this class serializable?

Get the namespace of the LangChain object.

Return a unique identifier for this class for serialization purposes.

Serialize the object to JSON.

Serialize a "not implemented" object.

The name of the Runnable. Used for debugging and tracing.

Input type.

Output Type.

The type of input this Runnable accepts specified as a Pydantic model.

Output schema.

List configurable fields for this Runnable.

Get the name of the Runnable.

Get a Pydantic model that can be used to validate input to the Runnable.

Get a JSON schema that represents the input to the Runnable.

Get a Pydantic model that can be used to validate output to the Runnable.

Get a JSON schema that represents the output of the Runnable.

The type of config this Runnable accepts specified as a Pydantic model.

Get a JSON schema that represents the config of the Runnable.

Return a graph representation of this Runnable.

Return a list of prompts used by this Runnable.

Pipe Runnable objects.

Pick keys from the output dict of this Runnable.

Assigns new fields to the dict output of this Runnable.

Transform a single input into an output.

Default implementation runs invoke in parallel using a thread pool executor.

Run invoke in parallel on a list of inputs.

Default implementation runs ainvoke in parallel using asyncio.gather.

Run ainvoke in parallel on a list of inputs.

Default implementation of stream, which calls invoke.

Default implementation of astream, which calls ainvoke.

Stream all output from a Runnable, as reported to the callback system.

Generate a stream of events.

Transform inputs to outputs.

Transform inputs to outputs.

Bind arguments to a Runnable, returning a new Runnable.

Bind config to a Runnable, returning a new Runnable.

Bind lifecycle listeners to a Runnable, returning a new Runnable.

Bind async lifecycle listeners to a Runnable.

Bind input and output types to a Runnable, returning a new Runnable.

Create a new Runnable that retries the original Runnable on exceptions.

Return a new Runnable that maps a list of inputs to a list of outputs.

Add fallbacks to a Runnable, returning a new Runnable.

Create a BaseTool from a Runnable.