Class: OpenAIGenerationAdapter

Defined in: src/batteries/generation/openai/adapter.ts:63

Media generation adapter for the OpenAI /v1/images/generations and /v1/images/edits wire shapes.

Remarks

Reusable: construct once, call OpenAIGenerationAdapter.generate / OpenAIGenerationAdapter.edit as many times as needed.

Constructors

Constructor

new OpenAIGenerationAdapter(options: unknown): OpenAIGenerationAdapter;

Defined in: src/batteries/generation/openai/adapter.ts:80

Parameters

Parameter	Type	Description
options	unknown	Constructor options. Validated eagerly.

Returns

OpenAIGenerationAdapter

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_INVALID_OPENAI_GENERATION_OPTIONS when options does not satisfy @nhtio/adk/batteries/generation/openai/validation!openAIGenerationOptionsSchema (e.g. missing model).

Methods

edit()

edit(
   inputs:
  | GenerationImageInput
  | GenerationImageInput[],
   prompt: string,
opts?: OpenAIEditOptions): Promise<GeneratedMediaOutput[]>;

Defined in: src/batteries/generation/openai/adapter.ts:156

Edits one or more source images from a text prompt, optionally constrained to a masked region.

Parameters

Parameter	Type	Description
inputs	| GenerationImageInput | GenerationImageInput[]	One image, or several images, in any GenerationImageInput form.
prompt	string	The text prompt describing the desired edit.
opts?	OpenAIEditOptions	Per-call options (n, size, quality, mask), each falling back to the adapter's configured default when omitted (mask has no adapter-level default).

Returns

Promise<GeneratedMediaOutput[]>

One GeneratedMediaOutput per edited image.

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_OPENAI_GENERATION_HTTP_ERROR on a non-2xx response or transport failure.

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_OPENAI_GENERATION_REQUEST_TIMEOUT when the handshake exceeds requestTimeoutMs.

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_OPENAI_GENERATION_MALFORMED_RESPONSE when the 2xx body is not the expected shape.

---

generate()

generate(prompt: string, opts?: OpenAIGenerateOptions): Promise<GeneratedMediaOutput[]>;

Defined in: src/batteries/generation/openai/adapter.ts:115

Generates one or more images from a text prompt.

Parameters

Parameter	Type	Description
prompt	string	The text prompt describing the desired image(s).
opts?	OpenAIGenerateOptions	Per-call options (n, size, quality, outputFormat, background), each falling back to the adapter's configured default when omitted.

Returns

Promise<GeneratedMediaOutput[]>

One GeneratedMediaOutput per generated image.

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_OPENAI_GENERATION_HTTP_ERROR on a non-2xx response or transport failure.

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_OPENAI_GENERATION_REQUEST_TIMEOUT when the handshake exceeds requestTimeoutMs.

Throws

@nhtio/adk/batteries/generation/openai/exceptions!E_OPENAI_GENERATION_MALFORMED_RESPONSE when the 2xx body is not the expected shape.

---

isAvailable()

isAvailable(): boolean;

Defined in: src/batteries/generation/openai/adapter.ts:85

See OpenAIGenerationAdapter.isAvailable. Instance alias for surface-parity.

Returns

boolean

---

preload()

preload(): Promise<void>;

Defined in: src/batteries/generation/openai/adapter.ts:93

No-op warm-up. The OpenAI battery has no engine to preload; present for surface-parity with on-device generation batteries so callers can treat them interchangeably.

Returns

Promise<void>

---

reset()

reset(): void;

Defined in: src/batteries/generation/openai/adapter.ts:100

No-op state reset. Present for surface-parity with on-device generation batteries.

Returns

void

---

isAvailable()

static isAvailable(): boolean;

Defined in: src/batteries/generation/openai/adapter.ts:71

Whether this battery can run in the current environment. For the HTTP-backed OpenAI battery this is always true (a fetch is always resolvable); present for surface-parity with WebGPU-gated batteries.

Returns

boolean