Class ChatConversationalAgent

constructor

• new ChatConversationalAgent(input): ChatConversationalAgent

• Parameters

  • input: ChatConversationalAgentInput

  Returns ChatConversationalAgent

ToolType

constructScratchPad

• constructScratchPad(steps): Promise<BaseMessage[]>

• Constructs the agent scratchpad based on the agent steps. It returns an array of base messages representing the thoughts of the agent.

  Parameters

  • steps: AgentStep[]

    The agent steps to construct the scratchpad from.

  Returns Promise<BaseMessage[]>

  An array of base messages representing the thoughts of the agent.

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 ChatConversationAgent.

  Parameters

  • tools: ToolInterface<ZodObjectAny | ZodEffects<ZodObjectAny, any, {}> | JsonSchema7Type, unknown>[]

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

    Arguments to create the prompt with.

  Returns ChatPromptTemplate<any, any>

StaticfromLLMAndTools

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

• Creates an instance of the ChatConversationalAgent class from a BaseLanguageModel and a set of tools. It takes optional arguments to customize the agent.

  Parameters

  • llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

    The BaseLanguageModel to create the agent from.
  • tools: ToolInterface<ZodObjectAny | ZodEffects<ZodObjectAny, any, {}> | JsonSchema7Type, unknown>[]

    The set of tools to create the agent from.
  • Optionalargs: ChatConversationalCreatePromptArgs & AgentArgs

    Optional arguments to customize the agent.

  Returns ChatConversationalAgent

  An instance of the ChatConversationalAgent class.

StaticgetDefaultOutputParser

• getDefaultOutputParser(fields?): AgentActionOutputParser

• Returns the default output parser for the ChatConversationalAgent class. It takes optional fields as arguments to customize the output parser.

  Parameters

  • Optionalfields: OutputParserArgs & {
        toolNames: string[];
    }

    Optional fields to customize the output parser.

  Returns AgentActionOutputParser

  The default output parser for the ChatConversationalAgent class.

StaticvalidateTools

• validateTools(tools): void

• Validate that appropriate tools are passed in

  Parameters

  • tools: ToolInterface<ZodObjectAny | ZodEffects<ZodObjectAny, any, {}> | JsonSchema7Type, unknown>[]

  Returns void