Class OpenAIAgent

constructor

• new OpenAIAgent(input): OpenAIAgent

• Parameters

  • input: Omit<OpenAIAgentInput, "outputParser">

  Returns OpenAIAgent

outputParser

tools

constructScratchPad

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

• Constructs a scratch pad from a list of agent steps.

  Parameters

  • steps: AgentStep[]

    The steps to include in the scratch pad.

  Returns Promise<string | BaseMessage[]>

  A string or a list of BaseMessages representing the constructed scratch pad.

llmPrefix

• llmPrefix(): string

• Prefix to append the LLM call with.

  Returns string

observationPrefix

• observationPrefix(): string

• Prefix to append the observation with.

  Returns string

plan

• plan(steps, inputs, callbackManager?): Promise<AgentAction | AgentFinish>

• Plans the next action or finish state of the agent based on the provided steps, inputs, and optional callback manager.

  Parameters

  • steps: AgentStep[]

    The steps to consider in planning.

  • inputs: ChainValues

    The inputs to consider in planning.

  • Optional callbackManager: CallbackManager

    Optional CallbackManager to use in planning.

  Returns Promise<AgentAction | AgentFinish>

  A Promise that resolves to an AgentAction or AgentFinish object representing the planned action or finish state.

Static createPrompt

• createPrompt(_tools, fields?): BasePromptTemplate<any, BasePromptValueInterface, any>

• Creates a prompt for the OpenAIAgent using the provided tools and fields.

  Parameters

  • _tools: StructuredToolInterface<ZodObject<any, any, any, any, {}>>[]

    The tools to be used in the prompt.

  • Optional fields: OpenAIAgentCreatePromptArgs

    Optional fields for creating the prompt.

  Returns BasePromptTemplate<any, BasePromptValueInterface, any>

  A BasePromptTemplate object representing the created prompt.

Static fromLLMAndTools

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

• Creates an OpenAIAgent from a BaseLanguageModel and a list of tools.

  Parameters

  • llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

    The BaseLanguageModel to use.

  • tools: StructuredToolInterface<ZodObject<any, any, any, any, {}>>[]

    The tools to be used by the agent.

  • Optional args: OpenAIAgentCreatePromptArgs & Pick<AgentArgs, "callbacks">

    Optional arguments for creating the agent.

  Returns OpenAIAgent

  An instance of OpenAIAgent.