Class ChatAgent

constructor

• new ChatAgent(input): ChatAgent

• Parameters

  • input: ChatAgentInput

  Returns ChatAgent

ToolType

constructScratchPad

• constructScratchPad(steps): Promise<string>

• Constructs the agent's scratchpad, which is a string representation of the agent's previous steps.

  Parameters

  • steps: AgentStep[]

    Array of AgentStep instances representing the agent's previous steps.

  Returns Promise<string>

  Promise resolving 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, args?): ChatPromptTemplate<any, any>

• Create prompt in the style of the zero shot agent.

  Parameters

  • tools: ToolInterface<ZodObjectAny>[]

    List of tools the agent will have access to, used to format the prompt.
  • Optionalargs: ChatCreatePromptArgs

    Arguments to create the prompt with.

  Returns ChatPromptTemplate<any, any>

StaticfromLLMAndTools

• fromLLMAndTools(llm, tools, args?): ChatAgent

• Creates a ChatAgent instance using a language model, tools, and optional arguments.

  Parameters

  • llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

    BaseLanguageModelInterface instance to use in the agent.
  • tools: ToolInterface<ZodObjectAny>[]

    Array of Tool instances to include in the agent.
  • Optionalargs: ChatCreatePromptArgs & AgentArgs

    Optional arguments to customize the agent and prompt.

  Returns ChatAgent

  ChatAgent instance

StaticgetDefaultOutputParser

• getDefaultOutputParser(_fields?): ChatAgentOutputParser

• Returns a default output parser for the ChatAgent.

  Parameters

  • Optional_fields: OutputParserArgs

    Optional OutputParserArgs to customize the output parser.

  Returns ChatAgentOutputParser

  ChatAgentOutputParser instance

StaticvalidateTools

• validateTools(tools): void

• Validates that all tools have descriptions. Throws an error if a tool without a description is found.

  Parameters

  • tools: ToolInterface<ZodObjectAny>[]

    Array of Tool instances to validate.

  Returns void

  void