Class StructuredChatAgent

Agent that interoperates with Structured Tools using React logic.

Hierarchy

Agent
- StructuredChatAgent

Index

Constructors

constructor

new StructuredChatAgent(input): StructuredChatAgent
Parameters
- input: StructuredChatAgentInput
Returns StructuredChatAgent
Overrides Agent.constructor
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:57

Properties

ToolType

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

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:327

inputKeys

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

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<string>
Constructs the agent's scratchpad from a list of steps. If the agent's scratchpad is not empty, it prepends a message indicating that the agent has not seen any previous work.
Parameters
- steps: AgentStep[]
  
  Array of AgentStep instances to construct the scratchpad from.
Returns Promise<string>
A Promise that resolves to a string representing the agent's scratchpad.
Overrides Agent.constructScratchPad
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:124

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:407

llmPrefix

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

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

observationPrefix

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

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

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:462

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:473

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 agent.
Parameters
- tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]
  
  List of tools the agent will have access to, used to format the prompt.
- Optional args: StructuredChatCreatePromptArgs
  
  Arguments to create the prompt with.
Returns ChatPromptTemplate<any, any>
Overrides Agent.createPrompt
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:158

`Static` createToolSchemasString

createToolSchemasString(tools): string
Creates a string representation of the schemas of the provided tools.
Parameters
- tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]
  
  Array of StructuredTool instances to create the schemas string from.
Returns string
A string representing the schemas of the provided tools.
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:137

`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:515

`Static` fromLLMAndTools

fromLLMAndTools(llm, tools, args?): StructuredChatAgent
Creates a StructuredChatAgent from an LLM and a list of tools. Validates the tools, creates a prompt, and sets up an LLM chain for the agent.
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  BaseLanguageModel instance to create the agent from.
- tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]
  
  Array of StructuredTool instances to create the agent from.
- Optional args: StructuredChatCreatePromptArgs & AgentArgs
  
  Optional arguments to customize the creation of the agent. Can include arguments for creating the prompt and AgentArgs.
Returns StructuredChatAgent
A new instance of StructuredChatAgent.
Overrides Agent.fromLLMAndTools
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:201

`Static` getDefaultOutputParser

getDefaultOutputParser(fields?): StructuredChatOutputParserWithRetries
Returns a default output parser for the StructuredChatAgent. If an LLM is provided, it creates an output parser with retry logic from the LLM.
Parameters
- Optional fields: OutputParserArgs & {
  toolNames: string[];
  }
  
  Optional fields to customize the output parser. Can include an LLM and a list of tool names.
Returns StructuredChatOutputParserWithRetries
An instance of StructuredChatOutputParserWithRetries.
Overrides Agent.getDefaultOutputParser
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:102

`Static` validateTools

validateTools(tools): void
Validates that all provided tools have a description. Throws an error if any tool lacks a description.
Parameters
- tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]
  
  Array of StructuredTool instances to validate.
Returns void
Overrides Agent.validateTools
- Defined in docs/api_refs/langchain/src/agents/structured_chat/index.ts:86

Class StructuredChatAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

input: StructuredChatAgentInput

Returns StructuredChatAgent

Properties

ToolType

llmChain

outputParser

Accessors

allowedTools

Returns undefined | string[]

inputKeys

Returns string[]

returnValues

Returns string[]

Methods

constructScratchPad

Parameters

steps: AgentStep[]

Returns Promise<string>

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: StructuredTool<ZodObject<any, any, any, any, {}>>[]

Optional args: StructuredChatCreatePromptArgs

Returns ChatPromptTemplate<any, any>

Static createToolSchemasString

Parameters

tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]

Returns string

Static deserialize

Parameters

data: Object

Returns Promise<Agent>

Static fromLLMAndTools

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]

Optional args: StructuredChatCreatePromptArgs & AgentArgs

Returns StructuredChatAgent

Static getDefaultOutputParser

Parameters

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

Returns StructuredChatOutputParserWithRetries

Static validateTools

`Optional` callbackManager: CallbackManager

`Optional` callbackManager: CallbackManager

`Static` createPrompt

`Optional` args: StructuredChatCreatePromptArgs

`Static` createToolSchemasString

`Static` deserialize

`Static` fromLLMAndTools

`Optional` args: StructuredChatCreatePromptArgs & AgentArgs

`Static` getDefaultOutputParser

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

`Static` validateTools