Class LLM

Hierarchy (view full)

llm.LLM
- LLM

Index

Constructors

Accessors

Methods

aclose chat label prewarm

Constructors

constructor

new LLM(opts?): responses.LLM
Create a new instance of OpenAI Responses LLM.
Parameters
- opts: Partial<LLMOptions> = defaultLLMOptions
Returns responses.LLM
Remarks
apiKey must be set to your OpenAI API key, either using the argument or by setting the OPENAI_API_KEY environment variable.
Overrides LLM.constructor
- Defined in plugins/openai/src/responses/llm.ts:46

Accessors

model

get model(): string
Get the model name/identifier for this LLM instance.

Returns string
The model name if available, "unknown" otherwise.

Remarks
Plugins should override this property to provide their model information.
Overrides llm.LLM.model
- Defined in plugins/openai/src/responses/llm.ts:66

Methods

aclose

aclose(): Promise<void>
Returns Promise<void>
Inherited from LLM.aclose
- Defined in agents/dist/llm/llm.d.ts:63

chat

chat(__namedParameters): responses.LLMStream
Returns a LLMStream that can be used to push text and receive LLM responses.
Parameters
- __namedParameters: {
      chatCtx: ChatContext;
      connOptions?: APIConnectOptions;
      extraKwargs?: Record<string, unknown>;
      parallelToolCalls?: boolean;
      toolChoice?: llm.ToolChoice;
      toolCtx?: ToolContext;
  }
  - chatCtx: ChatContext
  - Optional connOptions?: APIConnectOptions
  - Optional extraKwargs?: Record<string, unknown>
  - Optional parallelToolCalls?: boolean
  - Optional toolChoice?: llm.ToolChoice
  - Optional toolCtx?: ToolContext
Returns responses.LLMStream
Overrides LLM.chat
- Defined in plugins/openai/src/responses/llm.ts:70

label

label(): string
Returns string
Overrides LLM.label
- Defined in plugins/openai/src/responses/llm.ts:62

prewarm

prewarm(): void
Pre-warm connection to the LLM service

Returns void
Inherited from LLM.prewarm
- Defined in agents/dist/llm/llm.d.ts:62