Class OpenAiLlm

OpenAI LLM implementation using GPT models Enhanced with comprehensive debug logging similar to Google LLM

Hierarchy (view full)

BaseLlm
- OpenAiLlm

Index

Constructors

Properties

Methods

generateContentAsync maybeAppendUserContent supportedModels generateContentAsyncImpl connect

Constructors

constructor

new OpenAiLlm(model?): OpenAiLlm
Constructor for OpenAI LLM
Parameters
- model: string = "gpt-4o-mini"
Returns OpenAiLlm
Overrides BaseLlm.constructor
- Defined in packages/adk/src/models/openai-llm.ts:19

Properties

model

model: string

The name of the LLM, e.g. gemini-2.5-flash or gemini-2.5-flash-001.

`Protected`logger

logger: Logger = ...

Methods

generateContentAsync

generateContentAsync(llmRequest, stream?): AsyncGenerator<LlmResponse, void, unknown>
Generates one content from the given contents and tools.
Parameters
- llmRequest: LlmRequest
  LlmRequest, the request to send to the LLM.
- Optionalstream: boolean
  bool = false, whether to do streaming call.
Returns AsyncGenerator<LlmResponse, void, unknown>
a generator of LlmResponse.

For non-streaming call, it will only yield one LlmResponse.

For streaming call, it may yield more than one response, but all yielded responses should be treated as one response by merging the parts list.
Inherited from BaseLlm.generateContentAsync
- Defined in packages/adk/src/models/base-llm.ts:46

`Protected`maybeAppendUserContent

maybeAppendUserContent(llmRequest): void
Appends a user content, so that model can continue to output.
Parameters
- llmRequest: LlmRequest
  LlmRequest, the request to send to the LLM.
Returns void
Inherited from BaseLlm.maybeAppendUserContent
- Defined in packages/adk/src/models/base-llm.ts:216

`Static`supportedModels

supportedModels(): string[]
Provides the list of supported models

Returns string[]
Overrides BaseLlm.supportedModels
- Defined in packages/adk/src/models/openai-llm.ts:26

`Protected`generateContentAsyncImpl

generateContentAsyncImpl(llmRequest, stream?): AsyncGenerator<LlmResponse, void, unknown>
Main content generation method - handles both streaming and non-streaming
Parameters
- llmRequest: LlmRequest
- stream: boolean = false
Returns AsyncGenerator<LlmResponse, void, unknown>
Overrides BaseLlm.generateContentAsyncImpl
- Defined in packages/adk/src/models/openai-llm.ts:33

connect

connect(_llmRequest): BaseLLMConnection
Live connection is not supported for OpenAI models
Parameters
- _llmRequest: LlmRequest
Returns BaseLLMConnection
Overrides BaseLlm.connect
- Defined in packages/adk/src/models/openai-llm.ts:260