BaseSingleActionAgent#

class langchain.agents.agent.BaseSingleActionAgent[source]#

Bases: BaseModel

Base Single Action Agent class.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

abstract async aplan(intermediate_steps: List[Tuple[AgentAction, str]], callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None, **kwargs: Any) → AgentAction | AgentFinish[source]#

Async given input, decided what to do.

Parameters:

intermediate_steps (List[Tuple[AgentAction, str]]) – Steps the LLM has taken to date, along with observations.
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to run.
**kwargs (Any) – User inputs.

Returns:

Action specifying what tool to use.

Return type:

AgentAction | AgentFinish

classmethod from_llm_and_tools(llm: BaseLanguageModel, tools: Sequence[BaseTool], callback_manager: BaseCallbackManager | None = None, **kwargs: Any) → BaseSingleActionAgent[source]#

Construct an agent from an LLM and tools.

Parameters:

llm (BaseLanguageModel) – Language model to use.
tools (Sequence[BaseTool]) – Tools to use.
callback_manager (BaseCallbackManager | None) – Callback manager to use.
kwargs (Any) – Additional arguments.

Returns:

Agent object.

Return type:

BaseSingleActionAgent

get_allowed_tools() → List[str] | None[source]#

Return type:: List[str] | None

abstract plan(intermediate_steps: List[Tuple[AgentAction, str]], callbacks: list[BaseCallbackHandler] | BaseCallbackManager | None = None, **kwargs: Any) → AgentAction | AgentFinish[source]#

Given input, decided what to do.

Parameters:

intermediate_steps (List[Tuple[AgentAction, str]]) – Steps the LLM has taken to date, along with observations.
callbacks (list[BaseCallbackHandler] | BaseCallbackManager | None) – Callbacks to run.
**kwargs (Any) – User inputs.

Returns:

Action specifying what tool to use.

Return type:

AgentAction | AgentFinish

return_stopped_response(early_stopping_method: str, intermediate_steps: List[Tuple[AgentAction, str]], **kwargs: Any) → AgentFinish[source]#

Return response when agent has been stopped due to max iterations.

Parameters:

early_stopping_method (str) – Method to use for early stopping.
intermediate_steps (List[Tuple[AgentAction, str]]) – Steps the LLM has taken to date, along with observations.
**kwargs (Any) – User inputs.

Returns:

Agent finish object.

Return type:

AgentFinish

Raises:

ValueError – If early_stopping_method is not supported.

save(file_path: Path | str) → None[source]#

Save the agent.

Parameters:: file_path (Path | str) – Path to file to save the agent to.
Return type:: None

Example: .. code-block:: python

# If working with agent executor agent.agent.save(file_path=”path/agent.yaml”)

tool_run_logging_kwargs() → Dict[source]#

Return logging kwargs for tool run.

Return type:: Dict

property return_values: List[str]#: Return values of the agent.