Class StructuredChatAgent

constructor

• new StructuredChatAgent(input: StructuredChatAgentInput): StructuredChatAgent

  Parameters

  • input: StructuredChatAgentInput

  Returns StructuredChatAgent

lc_namespace

_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"

_stop

• _stop(): string[]

  Returns string[]

constructScratchPad

• constructScratchPad(steps: AgentStep[]): 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.

llmPrefix

• llmPrefix(): string

  Prefix to append the LLM call with.

  Returns string

observationPrefix

• observationPrefix(): string

  Prefix to append the observation with.

  Returns string

StaticcreatePrompt

• createPrompt(
      tools: StructuredToolInterface[],
      args?: StructuredChatCreatePromptArgs,
  ): any

  Create prompt in the style of the agent.

  Parameters

  • tools: StructuredToolInterface[]

    List of tools the agent will have access to, used to format the prompt.

  • Optionalargs: StructuredChatCreatePromptArgs

    Arguments to create the prompt with.

    Interface for arguments used to create a prompt for a StructuredChatAgent.

    • OptionalhumanMessageTemplate?: string

      String to use directly as the human message template.

    • OptionalinputVariables?: string[]

      List of input variables the final prompt will expect.

    • OptionalmemoryPrompts?: BaseMessagePromptTemplate[]

      List of historical prompts from memory.

    • Optionalprefix?: string

      String to put before the list of tools.

    • Optionalsuffix?: string

      String to put after the list of tools.

  Returns any

StaticcreateToolSchemasString

• createToolSchemasString(tools: StructuredToolInterface[]): string

  Creates a string representation of the schemas of the provided tools.

  Parameters

  • tools: StructuredToolInterface[]

    Array of StructuredTool instances to create the schemas string from.

  Returns string

  A string representing the schemas of the provided tools.

StaticfromLLMAndTools

• fromLLMAndTools(
      llm: BaseLanguageModelInterface,
      tools: StructuredToolInterface[],
      args?: StructuredChatCreatePromptArgs & AgentArgs,
  ): 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: BaseLanguageModelInterface

    BaseLanguageModel instance to create the agent from.

  • tools: StructuredToolInterface[]

    Array of StructuredTool instances to create the agent from.

  • Optionalargs: 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.

StaticgetDefaultOutputParser

• getDefaultOutputParser(
      fields?: OutputParserArgs & { toolNames: string[] },
  ): 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

  • Optionalfields: 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.

Staticlc_name

• lc_name(): string

  Returns string

StaticvalidateTools

• validateTools(tools: StructuredToolInterface[]): void

  Validates that all provided tools have a description. Throws an error if any tool lacks a description.

  Parameters

  • tools: StructuredToolInterface[]

    Array of StructuredTool instances to validate.

  Returns void