langchain.js
    Preparing search index...

    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.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    lc_namespace: string[] = ...
    llmChain: LLMChain
    tools: StructuredToolInterface[]
    ToolType: StructuredToolInterface

    Accessors

    • get allowedTools(): undefined | string[]

      Returns undefined | string[]

    • get inputKeys(): string[]

      Returns string[]

    • get returnValues(): string[]

      Returns string[]

    Methods

    • Return the string type key uniquely identifying multi or single action agents.

      Returns string

    • Return the string type key uniquely identifying this class of agent.

      Returns "openai-functions"

    • Returns string[]

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

    • Name of tool to use to terminate the chain.

      Returns string

    • Prefix to append the LLM call with.

      Returns string

    • Prefix to append the observation with.

      Returns string

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

      • OptionalcallbackManager: any

        Optional CallbackManager to use in planning.

      Returns Promise<any>

      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: AgentFinish
      • _steps: AgentStep[]

      Returns Promise<AgentFinish>

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

      Parameters

      • earlyStoppingMethod: StoppingMethod
      • steps: AgentStep[]
      • inputs: ChainValues
      • OptionalcallbackManager: any

      Returns Promise<AgentFinish>

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

      Parameters

      • _tools: StructuredToolInterface[]

        The tools to be used in the prompt.

      • Optionalfields: OpenAIAgentCreatePromptArgs

        Optional fields for creating the prompt.

      Returns BasePromptTemplate

      A BasePromptTemplate object representing the created prompt.

    • Load an agent from a json-like object describing it.

      Parameters

      Returns Promise<Agent>

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

      Parameters

      • llm: BaseLanguageModelInterface

        The BaseLanguageModel to use.

      • tools: StructuredToolInterface[]

        The tools to be used by the agent.

      • Optionalargs: OpenAIAgentCreatePromptArgs & Pick<AgentArgs, "callbacks">

        Optional arguments for creating the agent.

      Returns OpenAIAgent

      An instance of OpenAIAgent.

    • Returns string

    • Validate that appropriate tools are passed in

      Parameters

      • _tools: StructuredToolInterface[]

      Returns void