Class ChatConversationalAgent

Agent for the MRKL chain.

Hierarchy

Agent
- ChatConversationalAgent

Index

Constructors

constructor

new ChatConversationalAgent(input): ChatConversationalAgent
Parameters
- input: ChatConversationalAgentInput
Returns ChatConversationalAgent
Overrides Agent.constructor
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:65

Properties

ToolType

ToolType: Tool

llmChain

llmChain: LLMChain<string, LLMType>

outputParser

outputParser: undefined | AgentActionOutputParser

Accessors

allowedTools

get allowedTools(): undefined | string[]
Returns undefined | string[]
Inherited from Agent.allowedTools
- Defined in docs/api_refs/langchain/src/agents/agent.ts:303

inputKeys

get inputKeys(): string[]
Returns string[]
Inherited from Agent.inputKeys
- Defined in docs/api_refs/langchain/src/agents/agent.ts:307

returnValues

get returnValues(): string[]
Returns string[]
Inherited from Agent.returnValues
- Defined in docs/api_refs/langchain/src/agents/agent.ts:51

Methods

constructScratchPad

constructScratchPad(steps): Promise<BaseMessage[]>
Constructs the agent scratchpad based on the agent steps. It returns an array of base messages representing the thoughts of the agent.
Parameters
- steps: AgentStep[]
  
  The agent steps to construct the scratchpad from.
Returns Promise<BaseMessage[]>
An array of base messages representing the thoughts of the agent.
Overrides Agent.constructScratchPad
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:105

finishToolName

finishToolName(): string
Name of tool to use to terminate the chain.

Returns string
Inherited from Agent.finishToolName
- Defined in docs/api_refs/langchain/src/agents/agent.ts:383

llmPrefix

llmPrefix(): string
Prefix to append the LLM call with.

Returns string
Overrides Agent.llmPrefix
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:80

observationPrefix

observationPrefix(): string
Prefix to append the observation with.

Returns string
Overrides Agent.observationPrefix
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:76

plan

plan(steps, inputs, callbackManager?): Promise<AgentAction | AgentFinish>
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: CallbackManager
  
  Callback manager to use for this call.
Returns Promise<AgentAction | AgentFinish>
Action specifying what tool to use.
Inherited from Agent.plan
- Defined in docs/api_refs/langchain/src/agents/agent.ts:438

prepareForOutput

prepareForOutput(_returnValues, _steps): Promise<Record<string, any>>
Prepare the agent for output, if needed
Parameters
- _returnValues: Record<string, any>
- _steps: AgentStep[]
Returns Promise<Record<string, any>>
Inherited from Agent.prepareForOutput
- Defined in docs/api_refs/langchain/src/agents/agent.ts:95

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: CallbackManager
Returns Promise<AgentFinish>
Inherited from Agent.returnStoppedResponse
- Defined in docs/api_refs/langchain/src/agents/agent.ts:449

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from Agent.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from Agent.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

`Static` createPrompt

createPrompt(tools, args?): ChatPromptTemplate<any, any>
Create prompt in the style of the ChatConversationAgent.
Parameters
- tools: Tool[]
  
  List of tools the agent will have access to, used to format the prompt.
- Optional args: ChatConversationalCreatePromptArgs
  
  Arguments to create the prompt with.
Returns ChatPromptTemplate<any, any>
Overrides Agent.createPrompt
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:154

`Static` deserialize

deserialize(data): Promise<Agent>
Load an agent from a json-like object describing it.
Parameters
- data: Object
Returns Promise<Agent>
Inherited from Agent.deserialize
- Defined in docs/api_refs/langchain/src/agents/agent.ts:491

`Static` fromLLMAndTools

fromLLMAndTools(llm, tools, args?): ChatConversationalAgent
Creates an instance of the ChatConversationalAgent class from a BaseLanguageModel and a set of tools. It takes optional arguments to customize the agent.
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  The BaseLanguageModel to create the agent from.
- tools: Tool[]
  
  The set of tools to create the agent from.
- Optional args: ChatConversationalCreatePromptArgs & AgentArgs
  
  Optional arguments to customize the agent.
Returns ChatConversationalAgent
An instance of the ChatConversationalAgent class.
Overrides Agent.fromLLMAndTools
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:192

`Static` getDefaultOutputParser

getDefaultOutputParser(fields?): AgentActionOutputParser
Returns the default output parser for the ChatConversationalAgent class. It takes optional fields as arguments to customize the output parser.
Parameters
- Optional fields: OutputParserArgs & {
  toolNames: string[];
  }
  
  Optional fields to customize the output parser.
Returns AgentActionOutputParser
The default output parser for the ChatConversationalAgent class.
Overrides Agent.getDefaultOutputParser
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:127

`Static` validateTools

validateTools(tools): void
Validate that appropriate tools are passed in
Parameters
- tools: Tool[]
Returns void
Overrides Agent.validateTools
- Defined in docs/api_refs/langchain/src/agents/chat_convo/index.ts:89

Class ChatConversationalAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

input: ChatConversationalAgentInput

Returns ChatConversationalAgent

Properties

ToolType

llmChain

outputParser

Accessors

allowedTools

Returns undefined | string[]

inputKeys

Returns string[]

returnValues

Returns string[]

Methods

constructScratchPad

Parameters

steps: AgentStep[]

Returns Promise<BaseMessage[]>

finishToolName

Returns string

llmPrefix

Returns string

observationPrefix

Returns string

plan

Parameters

steps: AgentStep[]

inputs: ChainValues

Optional callbackManager: CallbackManager

Returns Promise<AgentAction | AgentFinish>

prepareForOutput

Parameters

_returnValues: Record<string, any>

_steps: AgentStep[]

Returns Promise<Record<string, any>>

returnStoppedResponse

Parameters

earlyStoppingMethod: StoppingMethod

steps: AgentStep[]

inputs: ChainValues

Optional callbackManager: CallbackManager

Returns Promise<AgentFinish>

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Static createPrompt

Parameters

tools: Tool[]

Optional args: ChatConversationalCreatePromptArgs

Returns ChatPromptTemplate<any, any>

Static deserialize

Parameters

data: Object

Returns Promise<Agent>

Static fromLLMAndTools

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

tools: Tool[]

Optional args: ChatConversationalCreatePromptArgs & AgentArgs

Returns ChatConversationalAgent

Static getDefaultOutputParser

Parameters

Optional fields: OutputParserArgs & { toolNames: string[]; }

Returns AgentActionOutputParser

Static validateTools

Parameters

tools: Tool[]

Returns void

Settings

`Optional` callbackManager: CallbackManager

`Optional` callbackManager: CallbackManager

`Static` createPrompt

`Optional` args: ChatConversationalCreatePromptArgs

`Static` deserialize

`Static` fromLLMAndTools

`Optional` args: ChatConversationalCreatePromptArgs & AgentArgs

`Static` getDefaultOutputParser

`Optional` fields: OutputParserArgs & {
toolNames: string[];
}

`Static` validateTools