Class OpenAIAgent

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

Agent
- OpenAIAgent

Index

Constructors

constructor

new OpenAIAgent(input): OpenAIAgent
Parameters
- input: Omit<OpenAIAgentInput, "outputParser">
Returns OpenAIAgent
Overrides Agent.constructor
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:125

Properties

ToolType

ToolType: StructuredTool<ZodObject<any, any, any, any, {}>>

llmChain

llmChain: LLMChain<string, LLMType>

outputParser

outputParser: OpenAIFunctionsAgentOutputParser = ...

tools

tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]

Accessors

allowedTools

get allowedTools(): undefined | string[]
Returns undefined | string[]
Inherited from Agent.allowedTools
- Defined in docs/api_refs/langchain/src/agents/agent.ts:327

inputKeys

get inputKeys(): string[]
Returns string[]
Inherited from Agent.inputKeys
- Defined in docs/api_refs/langchain/src/agents/agent.ts:331

returnValues

get returnValues(): string[]
Returns string[]
Inherited from Agent.returnValues
- Defined in docs/api_refs/langchain/src/agents/agent.ts:51

Methods

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.
Overrides Agent.constructScratchPad
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:184

finishToolName

finishToolName(): string
Name of tool to use to terminate the chain.

Returns string
Inherited from Agent.finishToolName
- Defined in docs/api_refs/langchain/src/agents/agent.ts:407

llmPrefix

llmPrefix(): string
Prefix to append the LLM call with.

Returns string
Overrides Agent.llmPrefix
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:111

observationPrefix

observationPrefix(): string
Prefix to append the observation with.

Returns string
Overrides Agent.observationPrefix
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:107

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.
Overrides Agent.plan
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:198

prepareForOutput

prepareForOutput(_returnValues, _steps): Promise<Record<string, any>>
Prepare the agent for output, if needed
Parameters
- _returnValues: Record<string, any>
- _steps: AgentStep[]
Returns Promise<Record<string, any>>
Inherited from Agent.prepareForOutput
- Defined in docs/api_refs/langchain/src/agents/agent.ts:95

returnStoppedResponse

returnStoppedResponse(earlyStoppingMethod, steps, inputs, callbackManager?): Promise<AgentFinish>
Return response when agent has been stopped due to max iterations
Parameters
- earlyStoppingMethod: StoppingMethod
- steps: AgentStep[]
- inputs: ChainValues
- Optional callbackManager: CallbackManager
Returns Promise<AgentFinish>
Inherited from Agent.returnStoppedResponse
- Defined in docs/api_refs/langchain/src/agents/agent.ts:473

`Static` createPrompt

createPrompt(_tools, fields?): BasePromptTemplate<any, BasePromptValue, any>
Creates a prompt for the OpenAIAgent using the provided tools and fields.
Parameters
- _tools: StructuredTool<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, BasePromptValue, any>
A BasePromptTemplate object representing the created prompt.
Overrides Agent.createPrompt
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:137

`Static` deserialize

deserialize(data): Promise<Agent>
Load an agent from a json-like object describing it.
Parameters
- data: Object
Returns Promise<Agent>
Inherited from Agent.deserialize
- Defined in docs/api_refs/langchain/src/agents/agent.ts:515

`Static` fromLLMAndTools

fromLLMAndTools(llm, tools, args?): OpenAIAgent
Creates an OpenAIAgent from a BaseLanguageModel and a list of tools.
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  The BaseLanguageModel to use.
- tools: StructuredTool<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.
Overrides Agent.fromLLMAndTools
- Defined in docs/api_refs/langchain/src/agents/openai/index.ts:157

`Static` getDefaultOutputParser

getDefaultOutputParser(_fields?): AgentActionOutputParser
Get the default output parser for this agent.
Parameters
- Optional _fields: OutputParserArgs
Returns AgentActionOutputParser
Inherited from Agent.getDefaultOutputParser
- Defined in docs/api_refs/langchain/src/agents/agent.ts:362

`Static` validateTools

validateTools(_tools): void
Validate that appropriate tools are passed in
Parameters
- _tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]
Returns void
Inherited from Agent.validateTools
- Defined in docs/api_refs/langchain/src/agents/agent.ts:397

Class OpenAIAgent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

input: Omit<OpenAIAgentInput, "outputParser">

Returns OpenAIAgent

Properties

ToolType

llmChain

outputParser

tools

Accessors

allowedTools

Returns undefined | string[]

inputKeys

Returns string[]

returnValues

Returns string[]

Methods

constructScratchPad

Parameters

steps: AgentStep[]

Returns Promise<string | BaseMessage[]>

finishToolName

Returns string

llmPrefix

Returns string

observationPrefix

Returns string

plan

Parameters

steps: AgentStep[]

inputs: ChainValues

Optional callbackManager: CallbackManager

Returns Promise<AgentAction | AgentFinish>

prepareForOutput

Parameters

_returnValues: Record<string, any>

_steps: AgentStep[]

Returns Promise<Record<string, any>>

returnStoppedResponse

Parameters

earlyStoppingMethod: StoppingMethod

steps: AgentStep[]

inputs: ChainValues

Optional callbackManager: CallbackManager

Returns Promise<AgentFinish>

Static createPrompt

Parameters

_tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]

Optional fields: OpenAIAgentCreatePromptArgs

Returns BasePromptTemplate<any, BasePromptValue, any>

Static deserialize

Parameters

data: Object

Returns Promise<Agent>

Static fromLLMAndTools

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]

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

Returns OpenAIAgent

Static getDefaultOutputParser

Parameters

Optional _fields: OutputParserArgs

Returns AgentActionOutputParser

Static validateTools

Parameters

_tools: StructuredTool<ZodObject<any, any, any, any, {}>>[]

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` callbackManager: CallbackManager

`Optional` callbackManager: CallbackManager

`Static` createPrompt

`Optional` fields: OpenAIAgentCreatePromptArgs

`Static` deserialize

`Static` fromLLMAndTools

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

`Static` getDefaultOutputParser

`Optional` _fields: OutputParserArgs

`Static` validateTools