AgentExecutor

class langchain.agents.agent.AgentExecutor

Bases: Chain

Agent that is using tools.

Note

AgentExecutor implements the standard Runnable Interface. 🏃

The Runnable Interface has additional methods that are available on runnables, such as with_types, with_retry, assign, bind, get_graph, and more.

param agent: BaseSingleActionAgent | BaseMultiActionAgent | Runnable [Required]

The agent to run for creating a plan and determining actions to take at each step of the execution loop.

param callback_manager: BaseCallbackManager | None = None

[DEPRECATED] Use callbacks instead.

param callbacks: Callbacks = None

Optional list of callback handlers (or callback manager). Defaults to None. Callback handlers are called throughout the lifecycle of a call to a chain, starting with on_chain_start, ending with on_chain_end or on_chain_error. Each custom chain can optionally call additional callback methods, see Callback docs for full details.

param early_stopping_method: str = 'force'

The method to use for early stopping if the agent never returns AgentFinish. Either ‘force’ or ‘generate’.

“force” returns a string saying that it stopped because it met a

time or iteration limit.

“generate” calls the agent’s LLM Chain one final time to generate

a final answer based on the previous steps.

param handle_parsing_errors: bool | str | Callable[[OutputParserException], str] = False

How to handle errors raised by the agent’s output parser. Defaults to False, which raises the error. If true, the error will be sent back to the LLM as an observation. If a string, the string itself will be sent to the LLM as an observation. If a callable function, the function will be called with the exception

as an argument, and the result of that function will be passed to the agent

as an observation.

param max_execution_time: float | None = None

The maximum amount of wall clock time to spend in the execution loop.

param max_iterations: int | None = 15

The maximum number of steps to take before ending the execution loop.

Setting to ‘None’ could lead to an infinite loop.

param memory: BaseMemory | None = None

Optional memory object. Defaults to None. Memory is a class that gets called at the start and at the end of every chain. At the start, memory loads variables and passes them along in the chain. At the end, it saves any returned variables. There are many different types of memory - please see memory docs for the full catalog.

param metadata: Dict[str, Any] | None = None

Optional metadata associated with the chain. Defaults to None. This metadata will be associated with each call to this chain, and passed as arguments to the handlers defined in callbacks. You can use these to eg identify a specific instance of a chain with its use case.

param return_intermediate_steps: bool = False

Whether to return the agent’s trajectory of intermediate steps at the end in addition to the final output.

param tags: List[str] | None = None

Optional list of tags associated with the chain. Defaults to None. These tags will be associated with each call to this chain, and passed as arguments to the handlers defined in callbacks. You can use these to eg identify a specific instance of a chain with its use case.

param tools: Sequence[BaseTool] [Required]

The valid tools the agent can call.

param trim_intermediate_steps: int | Callable[[List[Tuple[AgentAction, str]]], List[Tuple[AgentAction, str]]] = -1

How to trim the intermediate steps before returning them. Defaults to -1, which means no trimming.

param verbose: bool [Optional]

Whether or not run in verbose mode. In verbose mode, some intermediate logs will be printed to the console. Defaults to the global verbose value, accessible via langchain.globals.get_verbose().

__call__(inputs: Dict[str, Any] | Any, return_only_outputs: bool = False, callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None, *, tags: List[str] | None = None, metadata: Dict[str, Any] | None = None, run_name: str | None = None, include_run_info: bool = False) → Dict[str, Any]

Deprecated since version langchain==0.1.0: Use invoke instead.

Execute the chain.

Parameters:

• inputs (Dict[str, Any] | Any) – Dictionary of inputs, or single input if chain expects only one param. Should contain all inputs specified in Chain.input_keys except for inputs that will be set by the chain’s memory.

• return_only_outputs (bool) – Whether to return only outputs in the response. If True, only new keys generated by this chain will be returned. If False, both input keys and new keys generated by this chain will be returned. Defaults to False.

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to use for this chain run. These will be called in addition to callbacks passed to the chain during construction, but only these runtime callbacks will propagate to calls to other objects.

• tags (List[str] | None) – List of string tags to pass to all callbacks. These will be passed in addition to tags passed to the chain during construction, but only these runtime tags will propagate to calls to other objects.

• metadata (Dict[str, Any] | None) – Optional metadata associated with the chain. Defaults to None

• include_run_info (bool) – Whether to include run info in the response. Defaults to False.

• run_name (str | None) –

Returns:

A dict of named outputs. Should contain all outputs specified in

Chain.output_keys.

Return type:

Dict[str, Any]

async abatch(inputs: List[Input], config: RunnableConfig | List[RunnableConfig] | None = None, *, return_exceptions: bool = False, **kwargs: Any | None) → List[Output]

Default implementation runs ainvoke in parallel using asyncio.gather.

The default implementation of batch works well for IO bound runnables.

Subclasses should override this method if they can batch more efficiently; e.g., if the underlying Runnable uses an API which supports a batch mode.

Parameters:

• inputs (List[Input]) – A list of inputs to the Runnable.

• config (RunnableConfig | List[RunnableConfig] | None) – A config to use when invoking the Runnable. The config supports standard keys like ‘tags’, ‘metadata’ for tracing purposes, ‘max_concurrency’ for controlling how much work to do in parallel, and other keys. Please refer to the RunnableConfig for more details. Defaults to None.

• return_exceptions (bool) – Whether to return exceptions instead of raising them. Defaults to False.

• kwargs (Any | None) – Additional keyword arguments to pass to the Runnable.

Returns:

A list of outputs from the Runnable.

Return type:

List[Output]

async abatch_as_completed(inputs: Sequence[Input], config: RunnableConfig | Sequence[RunnableConfig] | None = None, *, return_exceptions: bool = False, **kwargs: Any | None) → AsyncIterator[Tuple[int, Output | Exception]]

Run ainvoke in parallel on a list of inputs, yielding results as they complete.

Parameters:

• inputs (Sequence[Input]) – A list of inputs to the Runnable.

• config (RunnableConfig | Sequence[RunnableConfig] | None) – A config to use when invoking the Runnable. The config supports standard keys like ‘tags’, ‘metadata’ for tracing purposes, ‘max_concurrency’ for controlling how much work to do in parallel, and other keys. Please refer to the RunnableConfig for more details. Defaults to None. Defaults to None.

• return_exceptions (bool) – Whether to return exceptions instead of raising them. Defaults to False.

• kwargs (Any | None) – Additional keyword arguments to pass to the Runnable.

Yields:

A tuple of the index of the input and the output from the Runnable.

Return type:

AsyncIterator[Tuple[int, Output | Exception]]

async acall(inputs: Dict[str, Any] | Any, return_only_outputs: bool = False, callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None, *, tags: List[str] | None = None, metadata: Dict[str, Any] | None = None, run_name: str | None = None, include_run_info: bool = False) → Dict[str, Any]

Deprecated since version langchain==0.1.0: Use ainvoke instead.

Asynchronously execute the chain.

Parameters:

• inputs (Dict[str, Any] | Any) – Dictionary of inputs, or single input if chain expects only one param. Should contain all inputs specified in Chain.input_keys except for inputs that will be set by the chain’s memory.

• return_only_outputs (bool) – Whether to return only outputs in the response. If True, only new keys generated by this chain will be returned. If False, both input keys and new keys generated by this chain will be returned. Defaults to False.

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to use for this chain run. These will be called in addition to callbacks passed to the chain during construction, but only these runtime callbacks will propagate to calls to other objects.

• tags (List[str] | None) – List of string tags to pass to all callbacks. These will be passed in addition to tags passed to the chain during construction, but only these runtime tags will propagate to calls to other objects.

• metadata (Dict[str, Any] | None) – Optional metadata associated with the chain. Defaults to None

• include_run_info (bool) – Whether to include run info in the response. Defaults to False.

• run_name (str | None) –

Returns:

A dict of named outputs. Should contain all outputs specified in

Chain.output_keys.

Return type:

Dict[str, Any]

async ainvoke(input: Dict[str, Any], config: RunnableConfig | None = None, **kwargs: Any) → Dict[str, Any]

Default implementation of ainvoke, calls invoke from a thread.

The default implementation allows usage of async code even if the Runnable did not implement a native async version of invoke.

Subclasses should override this method if they can run asynchronously.

Parameters:

• input (Dict[str, Any]) –

• config (RunnableConfig | None) –

• kwargs (Any) –

Return type:

Dict[str, Any]

apply(input_list: List[Dict[str, Any]], callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None) → List[Dict[str, str]]

Deprecated since version langchain==0.1.0: Use batch instead.

Call the chain on all inputs in the list.

Parameters:

• input_list (List[Dict[str, Any]]) –

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) –

Return type:

List[Dict[str, str]]

async aprep_inputs(inputs: Dict[str, Any] | Any) → Dict[str, str]

Prepare chain inputs, including adding inputs from memory.

Parameters:

inputs (Dict[str, Any] | Any) – Dictionary of raw inputs, or single input if chain expects only one param. Should contain all inputs specified in Chain.input_keys except for inputs that will be set by the chain’s memory.

Returns:

A dictionary of all inputs, including those added by the chain’s memory.

Return type:

Dict[str, str]

async aprep_outputs(inputs: Dict[str, str], outputs: Dict[str, str], return_only_outputs: bool = False) → Dict[str, str]

Validate and prepare chain outputs, and save info about this run to memory.

Parameters:

• inputs (Dict[str, str]) – Dictionary of chain inputs, including any inputs added by chain memory.

• outputs (Dict[str, str]) – Dictionary of initial chain outputs.

• return_only_outputs (bool) – Whether to only return the chain outputs. If False, inputs are also added to the final outputs.

Returns:

A dict of the final chain outputs.

Return type:

Dict[str, str]

async arun(*args: Any, callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None, tags: List[str] | None = None, metadata: Dict[str, Any] | None = None, **kwargs: Any) → Any

Deprecated since version langchain==0.1.0: Use ainvoke instead.

Convenience method for executing chain.

The main difference between this method and Chain.__call__ is that this method expects inputs to be passed directly in as positional arguments or keyword arguments, whereas Chain.__call__ expects a single input dictionary with all the inputs

Parameters:

• *args (Any) – If the chain expects a single input, it can be passed in as the sole positional argument.

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to use for this chain run. These will be called in addition to callbacks passed to the chain during construction, but only these runtime callbacks will propagate to calls to other objects.

• tags (List[str] | None) – List of string tags to pass to all callbacks. These will be passed in addition to tags passed to the chain during construction, but only these runtime tags will propagate to calls to other objects.

• **kwargs (Any) – If the chain expects multiple inputs, they can be passed in directly as keyword arguments.

• metadata (Dict[str, Any] | None) –

• **kwargs –

Returns:

The chain output.

Return type:

Any

Example

# Suppose we have a single-input chain that takes a 'question' string:
await chain.arun("What's the temperature in Boise, Idaho?")
# -> "The temperature in Boise is..."

# Suppose we have a multi-input chain that takes a 'question' string
# and 'context' string:
question = "What's the temperature in Boise, Idaho?"
context = "Weather report for Boise, Idaho on 07/03/23..."
await chain.arun(question=question, context=context)
# -> "The temperature in Boise is..."

async astream(input: Dict[str, Any] | Any, config: RunnableConfig | None = None, **kwargs: Any) → AsyncIterator[AddableDict]

Async enables streaming over steps taken to reach final output.

Parameters:

• input (Dict[str, Any] | Any) – Input to the agent.

• config (RunnableConfig | None) – Config to use.

• kwargs (Any) – Additional arguments.

Yields:

AddableDict – Addable dictionary.

Return type:

AsyncIterator[AddableDict]

astream_events(input: Any, config: RunnableConfig | None = None, *, version: Literal['v1', 'v2'], include_names: Sequence[str] | None = None, include_types: Sequence[str] | None = None, include_tags: Sequence[str] | None = None, exclude_names: Sequence[str] | None = None, exclude_types: Sequence[str] | None = None, exclude_tags: Sequence[str] | None = None, **kwargs: Any) → AsyncIterator[StandardStreamEvent | CustomStreamEvent]

Beta

This API is in beta and may change in the future.

Generate a stream of events.

Use to create an iterator over StreamEvents that provide real-time information about the progress of the Runnable, including StreamEvents from intermediate results.

A StreamEvent is a dictionary with the following schema:

• event: str - Event names are of the

  format: on_[runnable_type]_(start|stream|end).

• name: str - The name of the Runnable that generated the event.

• run_id: str - randomly generated ID associated with the given execution of

  the Runnable that emitted the event. A child Runnable that gets invoked as part of the execution of a parent Runnable is assigned its own unique ID.

• parent_ids: List[str] - The IDs of the parent runnables that

  generated the event. The root Runnable will have an empty list. The order of the parent IDs is from the root to the immediate parent. Only available for v2 version of the API. The v1 version of the API will return an empty list.

• tags: Optional[List[str]] - The tags of the Runnable that generated

  the event.

• metadata: Optional[Dict[str, Any]] - The metadata of the Runnable

  that generated the event.

• data: Dict[str, Any]

Below is a table that illustrates some evens that might be emitted by various chains. Metadata fields have been omitted from the table for brevity. Chain definitions have been included after the table.

ATTENTION This reference table is for the V2 version of the schema.

event	name	chunk	input	output
on_chat_model_start	[model name]		{“messages”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[model name]	AIMessageChunk(content=”hello”)
on_chat_model_end	[model name]		{“messages”: [[SystemMessage, HumanMessage]]}	AIMessageChunk(content=”hello world”)
on_llm_start	[model name]		{‘input’: ‘hello’}
on_llm_stream	[model name]	‘Hello’
on_llm_end	[model name]		‘Hello human!’
on_chain_start	format_docs
on_chain_stream	format_docs	“hello world!, goodbye world!”
on_chain_end	format_docs		[Document(…)]	“hello world!, goodbye world!”
on_tool_start	some_tool		{“x”: 1, “y”: “2”}
on_tool_end	some_tool			{“x”: 1, “y”: “2”}
on_retriever_start	[retriever name]		{“query”: “hello”}
on_retriever_end	[retriever name]		{“query”: “hello”}	[Document(…), ..]
on_prompt_start	[template_name]		{“question”: “hello”}
on_prompt_end	[template_name]		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

In addition to the standard events, users can also dispatch custom events (see example below).

Custom events will be only be surfaced with in the v2 version of the API!

A custom event has following format:

Attribute	Type	Description
name	str	A user defined name for the event.
data	Any	The data associated with the event. This can be anything, though we suggest making it JSON serializable.

Here are declarations associated with the standard events shown above:

format_docs:

def format_docs(docs: List[Document]) -> str:
    '''Format the docs.'''
    return ", ".join([doc.page_content for doc in docs])

format_docs = RunnableLambda(format_docs)

some_tool:

@tool
def some_tool(x: int, y: str) -> dict:
    '''Some_tool.'''
    return {"x": x, "y": y}

prompt:

template = ChatPromptTemplate.from_messages(
    [("system", "You are Cat Agent 007"), ("human", "{question}")]
).with_config({"run_name": "my_template", "tags": ["my_template"]})

Example:

from langchain_core.runnables import RunnableLambda

async def reverse(s: str) -> str:
    return s[::-1]

chain = RunnableLambda(func=reverse)

events = [
    event async for event in chain.astream_events("hello", version="v2")
]

# will produce the following events (run_id, and parent_ids
# has been omitted for brevity):
[
    {
        "data": {"input": "hello"},
        "event": "on_chain_start",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"chunk": "olleh"},
        "event": "on_chain_stream",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"output": "olleh"},
        "event": "on_chain_end",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
]

Example: Dispatch Custom Event

from langchain_core.callbacks.manager import (
    adispatch_custom_event,
)
from langchain_core.runnables import RunnableLambda, RunnableConfig
import asyncio


async def slow_thing(some_input: str, config: RunnableConfig) -> str:
    """Do something that takes a long time."""
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 1 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 2 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    return "Done"

slow_thing = RunnableLambda(slow_thing)

async for event in slow_thing.astream_events("some_input", version="v2"):
    print(event)

Parameters:

• input (Any) – The input to the Runnable.

• config (RunnableConfig | None) – The config to use for the Runnable.

• version (Literal['v1', 'v2']) – The version of the schema to use either v2 or v1. Users should use v2. v1 is for backwards compatibility and will be deprecated in 0.4.0. No default will be assigned until the API is stabilized. custom events will only be surfaced in v2.

• include_names (Sequence[str] | None) – Only include events from runnables with matching names.

• include_types (Sequence[str] | None) – Only include events from runnables with matching types.

• include_tags (Sequence[str] | None) – Only include events from runnables with matching tags.

• exclude_names (Sequence[str] | None) – Exclude events from runnables with matching names.

• exclude_types (Sequence[str] | None) – Exclude events from runnables with matching types.

• exclude_tags (Sequence[str] | None) – Exclude events from runnables with matching tags.

• kwargs (Any) – Additional keyword arguments to pass to the Runnable. These will be passed to astream_log as this implementation of astream_events is built on top of astream_log.

Yields:

An async stream of StreamEvents.

Raises:

NotImplementedError – If the version is not v1 or v2.

Return type:

AsyncIterator[StandardStreamEvent | CustomStreamEvent]

batch(inputs: List[Input], config: RunnableConfig | List[RunnableConfig] | None = None, *, return_exceptions: bool = False, **kwargs: Any | None) → List[Output]

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

The default implementation of batch works well for IO bound runnables.

Subclasses should override this method if they can batch more efficiently; e.g., if the underlying Runnable uses an API which supports a batch mode.

Parameters:

• inputs (List[Input]) –

• config (RunnableConfig | List[RunnableConfig] | None) –

• return_exceptions (bool) –

• kwargs (Any | None) –

Return type:

List[Output]

batch_as_completed(inputs: Sequence[Input], config: RunnableConfig | Sequence[RunnableConfig] | None = None, *, return_exceptions: bool = False, **kwargs: Any | None) → Iterator[Tuple[int, Output | Exception]]

Run invoke in parallel on a list of inputs, yielding results as they complete.

Parameters:

• inputs (Sequence[Input]) –

• config (RunnableConfig | Sequence[RunnableConfig] | None) –

• return_exceptions (bool) –

• kwargs (Any | None) –

Return type:

Iterator[Tuple[int, Output | Exception]]

configurable_alternatives(which: ConfigurableField, *, default_key: str = 'default', prefix_keys: bool = False, **kwargs: Runnable[Input, Output] | Callable[[], Runnable[Input, Output]]) → RunnableSerializable[Input, Output]

Configure alternatives for Runnables that can be set at runtime.

Parameters:

• which (ConfigurableField) – The ConfigurableField instance that will be used to select the alternative.

• default_key (str) – The default key to use if no alternative is selected. Defaults to “default”.

• prefix_keys (bool) – Whether to prefix the keys with the ConfigurableField id. Defaults to False.

• **kwargs (Runnable[Input, Output] | Callable[[], Runnable[Input, Output]]) – A dictionary of keys to Runnable instances or callables that return Runnable instances.

Returns:

A new Runnable with the alternatives configured.

Return type:

RunnableSerializable[Input, Output]

from langchain_anthropic import ChatAnthropic
from langchain_core.runnables.utils import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatAnthropic(
    model_name="claude-3-sonnet-20240229"
).configurable_alternatives(
    ConfigurableField(id="llm"),
    default_key="anthropic",
    openai=ChatOpenAI()
)

# uses the default model ChatAnthropic
print(model.invoke("which organization created you?").content)

# uses ChatOpenAI
print(
    model.with_config(
        configurable={"llm": "openai"}
    ).invoke("which organization created you?").content
)

configurable_fields(**kwargs: ConfigurableField | ConfigurableFieldSingleOption | ConfigurableFieldMultiOption) → RunnableSerializable[Input, Output]

Configure particular Runnable fields at runtime.

Parameters:

**kwargs (ConfigurableField | ConfigurableFieldSingleOption | ConfigurableFieldMultiOption) – A dictionary of ConfigurableField instances to configure.

Returns:

A new Runnable with the fields configured.

Return type:

RunnableSerializable[Input, Output]

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatOpenAI(max_tokens=20).configurable_fields(
    max_tokens=ConfigurableField(
        id="output_token_number",
        name="Max tokens in the output",
        description="The maximum number of tokens in the output",
    )
)

# max_tokens = 20
print(
    "max_tokens_20: ",
    model.invoke("tell me something about chess").content
)

# max_tokens = 200
print("max_tokens_200: ", model.with_config(
    configurable={"output_token_number": 200}
    ).invoke("tell me something about chess").content
)

classmethod from_agent_and_tools(agent: BaseSingleActionAgent | BaseMultiActionAgent | Runnable, tools: Sequence[BaseTool], callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None, **kwargs: Any) → AgentExecutor

Create from agent and tools.

Parameters:

• agent (BaseSingleActionAgent | BaseMultiActionAgent | Runnable) – Agent to use.

• tools (Sequence[BaseTool]) – Tools to use.

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to use.

• kwargs (Any) – Additional arguments.

Returns:

Agent executor object.

Return type:

AgentExecutor

invoke(input: Dict[str, Any], config: RunnableConfig | None = None, **kwargs: Any) → Dict[str, Any]

Transform a single input into an output. Override to implement.

Parameters:

• input (Dict[str, Any]) – The input to the Runnable.

• config (RunnableConfig | None) – A config to use when invoking the Runnable. The config supports standard keys like ‘tags’, ‘metadata’ for tracing purposes, ‘max_concurrency’ for controlling how much work to do in parallel, and other keys. Please refer to the RunnableConfig for more details.

• kwargs (Any) –

Returns:

The output of the Runnable.

Return type:

Dict[str, Any]

iter(inputs: Any, callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None, *, include_run_info: bool = False, async_: bool = False) → AgentExecutorIterator

Enables iteration over steps taken to reach final output.

Parameters:

• inputs (Any) – Inputs to the agent.

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to run.

• include_run_info (bool) – Whether to include run info.

• async – Whether to run async. (Ignored)

• async_ (bool) –

Returns:

Agent executor iterator object.

Return type:

AgentExecutorIterator

lookup_tool(name: str) → BaseTool

Lookup tool by name.

Parameters:

name (str) – Name of tool.

Returns:

Tool object.

Return type:

BaseTool

prep_inputs(inputs: Dict[str, Any] | Any) → Dict[str, str]

Prepare chain inputs, including adding inputs from memory.

Parameters:

inputs (Dict[str, Any] | Any) – Dictionary of raw inputs, or single input if chain expects only one param. Should contain all inputs specified in Chain.input_keys except for inputs that will be set by the chain’s memory.

Returns:

A dictionary of all inputs, including those added by the chain’s memory.

Return type:

Dict[str, str]

prep_outputs(inputs: Dict[str, str], outputs: Dict[str, str], return_only_outputs: bool = False) → Dict[str, str]

Validate and prepare chain outputs, and save info about this run to memory.

Parameters:

• inputs (Dict[str, str]) – Dictionary of chain inputs, including any inputs added by chain memory.

• outputs (Dict[str, str]) – Dictionary of initial chain outputs.

• return_only_outputs (bool) – Whether to only return the chain outputs. If False, inputs are also added to the final outputs.

Returns:

A dict of the final chain outputs.

Return type:

Dict[str, str]

run(*args: Any, callbacks: List[BaseCallbackHandler] | BaseCallbackManager | None = None, tags: List[str] | None = None, metadata: Dict[str, Any] | None = None, **kwargs: Any) → Any

Deprecated since version langchain==0.1.0: Use invoke instead.

Convenience method for executing chain.

The main difference between this method and Chain.__call__ is that this method expects inputs to be passed directly in as positional arguments or keyword arguments, whereas Chain.__call__ expects a single input dictionary with all the inputs

Parameters:

• *args (Any) – If the chain expects a single input, it can be passed in as the sole positional argument.

• callbacks (List[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to use for this chain run. These will be called in addition to callbacks passed to the chain during construction, but only these runtime callbacks will propagate to calls to other objects.

• tags (List[str] | None) – List of string tags to pass to all callbacks. These will be passed in addition to tags passed to the chain during construction, but only these runtime tags will propagate to calls to other objects.

• **kwargs (Any) – If the chain expects multiple inputs, they can be passed in directly as keyword arguments.

• metadata (Dict[str, Any] | None) –

• **kwargs –

Returns:

The chain output.

Return type:

Any

Example

# Suppose we have a single-input chain that takes a 'question' string:
chain.run("What's the temperature in Boise, Idaho?")
# -> "The temperature in Boise is..."

# Suppose we have a multi-input chain that takes a 'question' string
# and 'context' string:
question = "What's the temperature in Boise, Idaho?"
context = "Weather report for Boise, Idaho on 07/03/23..."
chain.run(question=question, context=context)
# -> "The temperature in Boise is..."

save(file_path: Path | str) → None

Raise error - saving not supported for Agent Executors.

Parameters:

file_path (Path | str) – Path to save to.

Raises:

ValueError – Saving not supported for agent executors.

Return type:

None

save_agent(file_path: Path | str) → None

Save the underlying agent.

Parameters:

file_path (Path | str) – Path to save to.

Return type:

None

stream(input: Dict[str, Any] | Any, config: RunnableConfig | None = None, **kwargs: Any) → Iterator[AddableDict]

Enables streaming over steps taken to reach final output.

Parameters:

• input (Dict[str, Any] | Any) – Input to the agent.

• config (RunnableConfig | None) – Config to use.

• kwargs (Any) – Additional arguments.

Yields:

AddableDict – Addable dictionary.

Return type:

Iterator[AddableDict]

to_json() → SerializedConstructor | SerializedNotImplemented

Serialize the Runnable to JSON.

Returns:

A JSON-serializable representation of the Runnable.

Return type:

SerializedConstructor | SerializedNotImplemented

Examples using AgentExecutor

• Amadeus Toolkit

• ArXiv

• AskNews

• Azure AI Services Toolkit

• Azure Container Apps dynamic sessions

• Bing Search

• Bittensor

• Build an Agent with AgentExecutor (Legacy)

• Cassandra Database Toolkit

• Cohere

• Databricks Unity Catalog (UC)

• Dataherald

• Exa Search

• FinancialDatasets Toolkit

• How to add a semantic layer over graph database

• How to add tools to chatbots

• How to debug your LLM apps

• How to migrate from legacy LangChain agents to LangGraph

• How to track token usage in ChatModels

• How to use tools in a chain

• Infobip

• Ionic Shopping Tool

• LLMonitor

• Log, Trace, and Monitor

• MLX

• Memorize

• MultiOn Toolkit

• Passio NutritionAI

• Polygon IO Toolkit

• Polygon IO Toolkit and Tools

• Portkey

• Reddit Search

• Riza Code Interpreter

• Robocorp Toolkit

• Semantic Scholar API Tool

• Streamlit

• You.com Search

• ZHIPU AI