Class OpenAiAdapter

AI Adapter implementation for OpenAI and OpenAI-compatible models (DeepSeek, Qwen, Mistral, Ollama). Built with native fetch and Web Streams without external third-party SDK dependencies.

Hierarchy (View Summary)

AbstractAiAdapter
- OpenAiAdapter

Constructors

constructor

new OpenAiAdapter(config: string | OpenAiAdapterConfig): OpenAiAdapter
Construct a new OpenAiAdapter instance.
Parameters
- config: string | OpenAiAdapterConfig
  String API key or complete OpenAiAdapterConfig object.
Returns OpenAiAdapter
Throws
If apiKey is empty or config is invalid (Fail-Fast).
Overrides AbstractAiAdapter.constructor
- Defined in OpenAiAdapter.ts:191

Properties

`Protected`_apiKey

_apiKey: string

`Protected`_baseUrl

_baseUrl: string

`Protected`_customHeaders

_customHeaders: Record<string, string>

`Protected`_defaultModel

_defaultModel: string

`Protected`_defaultResponseFormat

_defaultResponseFormat:
    | Record<string, unknown>
    | { type: "text" | "json_object" | "json_schema" }
    | null

`Protected`_defaultTemperature

_defaultTemperature: number

`Protected`_initialized

_initialized: boolean = false

`Protected`_timeoutMs

_timeoutMs: number

Methods

`Protected`_buildMessages

_buildMessages(prompt: string, options?: OpenAiGenerateOptions): OpenAiMessage[]
Internal helper to build chat messages array.
Parameters
- prompt: string
- Optionaloptions: OpenAiGenerateOptions
Returns OpenAiMessage[]
- Defined in OpenAiAdapter.ts:523

`Protected`_cleanJsonFences

_cleanJsonFences(rawContent: string): string
Strips optional markdown JSON codeblock fences from a response string.
Parameters
- rawContent: string
  Raw text output from model.
Returns string
Cleaned JSON text.
- Defined in OpenAiAdapter.ts:384

`Protected`_parseSseLine

_parseSseLine(line: string): string | null
Parse an individual Server-Sent Events line and extract delta content.
Parameters
- line: string
  Raw SSE line string.
Returns string | null
Text delta string if available, or null.
- Defined in OpenAiAdapter.ts:599

`Protected`_parseSseStream

_parseSseStream(
body: ReadableStream<Uint8Array<ArrayBufferLike>>,
): AsyncGenerator<string, void, unknown>
Internal async generator parsing Server-Sent Events (SSE) stream chunks.
Parameters
- body: ReadableStream<Uint8Array<ArrayBufferLike>>
Returns AsyncGenerator<string, void, unknown>
- Defined in OpenAiAdapter.ts:625

`Protected`_postChatCompletions

_postChatCompletions(
    payload: Record<string, unknown>,
    headers?: Record<string, string>,
    timeoutMs?: number,
): Promise<Response>
Internal helper to make an authorized POST request to /chat/completions.
Parameters
- payload: Record<string, unknown>
- Optionalheaders: Record<string, string>
- OptionaltimeoutMs: number
Returns Promise<Response>
- Defined in OpenAiAdapter.ts:548

generateStructured

generateStructured<T = unknown>(
    prompt: unknown,
    schema: unknown,
    options?: OpenAiGenerateOptions,
): Promise<T>
Generates structured data strictly conforming to a JSON schema.
Type Parameters
- T = unknown
Parameters
- prompt: unknown
  Context or instructions.
- schema: unknown
  Target JSON schema or contract.
- Optionaloptions: OpenAiGenerateOptions
  Generation options.
Returns Promise<T>
Parsed JSON object conforming to type T.
Overrides AbstractAiAdapter.generateStructured
- Defined in OpenAiAdapter.ts:405

generateText

generateText(prompt: string, options?: OpenAiGenerateOptions): Promise<string>
Sends a prompt to the OpenAI-compatible chat completions API and retrieves the response string.
Parameters
- prompt: string
  Text instruction or prompt query.
- Optionaloptions: OpenAiGenerateOptions
  Execution options (model, messages, temperature, maxTokens).
Returns Promise<string>
Generated text from model.
Overrides AbstractAiAdapter.generateText
- Defined in OpenAiAdapter.ts:336

generateTextStream

generateTextStream(
prompt: string,
options?: OpenAiGenerateOptions,
): Promise<AsyncIterable<string, any, any>>
Sends a prompt and returns an async iterable stream of generated text tokens.
Parameters
- prompt: string
  Text instruction or prompt query.
- Optionaloptions: OpenAiGenerateOptions
  Execution options.
Returns Promise<AsyncIterable<string, any, any>>
Async iterable yielding chunks of text.
Overrides AbstractAiAdapter.generateTextStream
- Defined in OpenAiAdapter.ts:488

init

init(): void
Initialize the adapter and validate setup.

Returns void
Overrides AbstractAiAdapter.init
- Defined in OpenAiAdapter.ts:325

`Static`forDeepSeek

forDeepSeek(apiKey: string, defaultModel?: string): OpenAiAdapter
Preset for DeepSeek API endpoint (V3 & R1).
Parameters
- apiKey: string
  DeepSeek API key.
- defaultModel: string = 'deepseek-chat'
  Default model (defaults to 'deepseek-chat').
Returns OpenAiAdapter
- Defined in OpenAiAdapter.ts:250

`Static`forLmStudio

forLmStudio(baseUrl?: string, defaultModel?: string): OpenAiAdapter
Preset for local LM Studio instance.
Parameters
- baseUrl: string = 'http://localhost:1234/v1'
  LM Studio endpoint URL (defaults to 'http://localhost:1234/v1').
- defaultModel: string = 'default'
  Default model identifier.
Returns OpenAiAdapter
- Defined in OpenAiAdapter.ts:296

`Static`forOllama

forOllama(baseUrl?: string, defaultModel?: string): OpenAiAdapter
Preset for local or on-premise Ollama instance.
Parameters
- baseUrl: string = 'http://localhost:11434/v1'
  Ollama endpoint URL (defaults to 'http://localhost:11434/v1').
- defaultModel: string = 'llama3.2'
  Default model (defaults to 'llama3.2').
Returns OpenAiAdapter
- Defined in OpenAiAdapter.ts:278

`Static`forOpenAi

forOpenAi(apiKey: string, defaultModel?: string): OpenAiAdapter
Preset for OpenAI official endpoint.
Parameters
- apiKey: string
  OpenAI API key.
- defaultModel: string = 'gpt-4o'
  Default model (defaults to 'gpt-4o').
Returns OpenAiAdapter
- Defined in OpenAiAdapter.ts:236

`Static`forOpenRouter

forOpenRouter(apiKey: string, defaultModel?: string): OpenAiAdapter
Preset for OpenRouter aggregator endpoint.
Parameters
- apiKey: string
  OpenRouter API key.
- defaultModel: string = 'openrouter/auto'
  Default model (defaults to 'openrouter/auto').
Returns OpenAiAdapter
- Defined in OpenAiAdapter.ts:314

`Static`forQwen

forQwen(apiKey: string, defaultModel?: string): OpenAiAdapter
Preset for Alibaba Qwen API endpoint (DashScope OpenAI compatible).
Parameters
- apiKey: string
  DashScope API key.
- defaultModel: string = 'qwen-plus'
  Default model (defaults to 'qwen-plus').
Returns OpenAiAdapter
- Defined in OpenAiAdapter.ts:264

Class OpenAiAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OpenAiAdapter

Throws

Properties

Protected_apiKey

Protected_baseUrl

Protected_customHeaders

Protected_defaultModel

Protected_defaultResponseFormat

Protected_defaultTemperature

Protected_initialized

Protected_timeoutMs

Methods

Protected_buildMessages

Parameters

Returns OpenAiMessage[]

Protected_cleanJsonFences

Parameters

Returns string

Protected_parseSseLine

Parameters

Returns string | null

Protected_parseSseStream

Parameters

Returns AsyncGenerator<string, void, unknown>

Protected_postChatCompletions

Parameters

Returns Promise<Response>

generateStructured

Type Parameters

Parameters

Returns Promise<T>

generateText

Parameters

Returns Promise<string>

generateTextStream

Parameters

Returns Promise<AsyncIterable<string, any, any>>

init

Returns void

StaticforDeepSeek

Parameters

Returns OpenAiAdapter

StaticforLmStudio

Parameters

Returns OpenAiAdapter

StaticforOllama

Parameters

Returns OpenAiAdapter

StaticforOpenAi

Parameters

Returns OpenAiAdapter

StaticforOpenRouter

Parameters

Returns OpenAiAdapter

StaticforQwen

Parameters

Returns OpenAiAdapter

Settings

On This Page

`Protected`_apiKey

`Protected`_baseUrl

`Protected`_customHeaders

`Protected`_defaultModel

`Protected`_defaultResponseFormat

`Protected`_defaultTemperature

`Protected`_initialized

`Protected`_timeoutMs

`Protected`_buildMessages

`Protected`_cleanJsonFences

`Protected`_parseSseLine

`Protected`_parseSseStream

`Protected`_postChatCompletions

`Static`forDeepSeek

`Static`forLmStudio

`Static`forOllama

`Static`forOpenAi

`Static`forOpenRouter

`Static`forQwen