Class representing an agent for the OpenAI chat model in LangChain. It extends the Agent class and provides additional functionality specific to the OpenAIAgent type.

⚠️ Deprecated ⚠️

Use the createOpenAIFunctionsAgent method instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Hierarchy (view full)

Constructors

Properties

ToolType: StructuredToolInterface<ZodObject<any, any, any, any, {}>>
llmChain: LLMChain<string, LLMType>
tools: StructuredToolInterface<ZodObject<any, any, any, any, {}>>[]

Accessors

Methods

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

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

  • Prepare the agent for output, if needed

    Parameters

    • _returnValues: Record<string, any>
    • _steps: AgentStep[]

    Returns Promise<Record<string, any>>

  • Return response when agent has been stopped due to max iterations

    Parameters

    • earlyStoppingMethod: StoppingMethod
    • steps: AgentStep[]
    • inputs: ChainValues
    • Optional callbackManager: CallbackManager

    Returns Promise<AgentFinish>

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

Generated using TypeDoc