Class BaseSingleActionAgent`Abstract`

Abstract base class for single action agents in LangChain. Extends the BaseAgent class and provides additional functionality specific to single action agents.

Hierarchy (view full)

BaseAgent
- BaseSingleActionAgent

Index

Constructors

Properties

Accessors

allowedTools inputKeys returnValues

Methods

plan prepareForOutput returnStoppedResponse

Constructors

constructor

new BaseSingleActionAgent(): BaseSingleActionAgent
Returns BaseSingleActionAgent
Inherited from BaseAgent.constructor

Properties

ToolType

ToolType: StructuredToolInterface

Accessors

allowedTools

get allowedTools(): undefined | string[]
Returns undefined | string[]
Inherited from BaseAgent.allowedTools
- Defined in langchain/src/agents/agent.ts:61

`Abstract` inputKeys

get inputKeys(): string[]
Returns string[]
Inherited from BaseAgent.inputKeys
- Defined in langchain/src/agents/agent.ts:55

returnValues

get returnValues(): string[]
Returns string[]
Inherited from BaseAgent.returnValues
- Defined in langchain/src/agents/agent.ts:57

Methods

`Abstract` plan

plan(steps, inputs, callbackManager?, config?): Promise<any>
Decide what to do, given some input.
Parameters
- steps: AgentStep[]
  Steps the LLM has taken so far, along with observations from each.
- inputs: ChainValues
  User inputs.
- Optional callbackManager: any
  Callback manager.
- Optional config: any
Returns Promise<any>
Action specifying what tool to use.
- Defined in langchain/src/agents/agent.ts:126

prepareForOutput

prepareForOutput(_returnValues, _steps): Promise<AgentFinish>
Prepare the agent for output, if needed
Parameters
- _returnValues: AgentFinish
- _steps: AgentStep[]
Returns Promise<AgentFinish>
Inherited from BaseAgent.prepareForOutput
- Defined in langchain/src/agents/agent.ts:99

returnStoppedResponse

returnStoppedResponse(earlyStoppingMethod, _steps, _inputs, _callbackManager?): Promise<AgentFinish>
Return response when agent has been stopped due to max iterations
Parameters
- earlyStoppingMethod: StoppingMethod
- _steps: AgentStep[]
- _inputs: ChainValues
- Optional _callbackManager: any
Returns Promise<AgentFinish>
Inherited from BaseAgent.returnStoppedResponse
- Defined in langchain/src/agents/agent.ts:80

Generated using TypeDoc