Class XMLAgent

Class that represents an agent that uses XML tags.

⚠️ Deprecated ⚠️

Use the createXmlAgent method instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Hierarchy (view full)

BaseSingleActionAgent
- XMLAgent

Implements

XMLAgentInput

Index

Constructors

Properties

ToolType llmChain outputParser tools

Accessors

allowedTools inputKeys returnValues

Methods

plan prepareForOutput returnStoppedResponse createPrompt fromLLMAndTools

Constructors

constructor

new XMLAgent(fields): XMLAgent
Parameters
- fields: XMLAgentInput
Returns XMLAgent
Overrides BaseSingleActionAgent.constructor
- Defined in langchain/src/agents/xml/index.ts:57

Properties

ToolType

ToolType: StructuredToolInterface<ZodObject<any, any, any, any, {}>>

llmChain

llmChain: LLMChain<string, LLMType>

outputParser

outputParser: XMLAgentOutputParser = ...

tools

tools: ToolInterface[]

Accessors

allowedTools

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

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseSingleActionAgent.inputKeys
- Defined in langchain/src/agents/xml/index.ts:63

returnValues

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

Methods

plan

plan(steps, inputs, callbackManager?): Promise<AgentAction | AgentFinish>
Plans the next action or finish state of the agent based on the provided steps, inputs, and optional callback manager.
Parameters
- steps: AgentStep[]
  The steps to consider in planning.
- inputs: ChainValues
  The inputs to consider in planning.
- Optional callbackManager: CallbackManager
  Optional CallbackManager to use in planning.
Returns Promise<AgentAction | AgentFinish>
A Promise that resolves to an AgentAction or AgentFinish object representing the planned action or finish state.
Overrides BaseSingleActionAgent.plan
- Defined in langchain/src/agents/xml/index.ts:82

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

`Static` createPrompt

createPrompt(): ChatPromptTemplate<any, any>
Returns ChatPromptTemplate<any, any>
- Defined in langchain/src/agents/xml/index.ts:67

`Static` fromLLMAndTools

fromLLMAndTools(llm, tools, args?): XMLAgent
Creates an XMLAgent from a BaseLanguageModel and a list of tools.
Parameters
- llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>
  The BaseLanguageModel to use.
- tools: ToolInterface[]
  The tools to be used by the agent.
- Optional args: XMLAgentInput & Pick<AgentArgs, "callbacks">
  Optional arguments for creating the agent.
Returns XMLAgent
An instance of XMLAgent.
- Defined in langchain/src/agents/xml/index.ts:112

Generated using TypeDoc