Class StructuredChatAgent

Agent that interoperates with Structured Tools using React logic.

Hierarchy

Agent
- StructuredChatAgent

Constructors

constructor

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

Properties

ToolType

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

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

llmChain

llmChain: LLMChain<string, BaseLanguageModel<any, BaseLanguageModelCallOptions>>

outputParser

outputParser: undefined | AgentActionOutputParser

Accessors

allowedTools

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

inputKeys

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

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from Agent.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from Agent.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from Agent.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | {
[key: string]: string;
}
Inherited from Agent.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

returnValues

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

Methods

_agentActionType

_agentActionType(): string
Returns string
Inherited from Agent._agentActionType
- Defined in langchain/src/agents/agent.ts:107

_agentType

_agentType(): "structured-chat-zero-shot-react-description"
Return the string type key uniquely identifying this class of agent.

Returns "structured-chat-zero-shot-react-description"
Overrides Agent._agentType
- Defined in langchain/src/agents/structured_chat/index.ts:59

_stop

_stop(): string[]
Returns string[]
Overrides Agent._stop
- Defined in langchain/src/agents/structured_chat/index.ts:71

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 langchain/src/agents/structured_chat/index.ts:118

finishToolName

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

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

llmPrefix

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

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

observationPrefix

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

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

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 langchain/src/agents/agent.ts:422

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 langchain/src/agents/agent.ts:93

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 langchain/src/agents/agent.ts:433

toJSON

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

toJSONNotImplemented

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

`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 langchain/src/agents/structured_chat/index.ts:152

`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 langchain/src/agents/structured_chat/index.ts:131

`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 langchain/src/agents/agent.ts:475

`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 langchain/src/agents/structured_chat/index.ts:195

`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 langchain/src/agents/structured_chat/index.ts:96

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Overrides Agent.lc_name
- Defined in langchain/src/agents/structured_chat/index.ts:47

`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 langchain/src/agents/structured_chat/index.ts:80

Class StructuredChatAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

input: StructuredChatAgentInput

Returns StructuredChatAgent

Properties

ToolType

lc_kwargs

lc_namespace

lc_serializable

llmChain

outputParser

Accessors

allowedTools

Returns undefined | string[]

inputKeys

Returns string[]

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

returnValues

Returns string[]

Methods

_agentActionType

Returns string

_agentType

Returns "structured-chat-zero-shot-react-description"

_stop

Returns string[]

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

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

`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` lc_name

`Static` validateTools