Skip to content

ImageAdapter.md

Latest commit

 

History

History
127 lines (76 loc) · 3.14 KB

ImageAdapter.md

File metadata and controls

127 lines (76 loc) · 3.14 KB
id ImageAdapter
title ImageAdapter

Interface: ImageAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelSizeByName>

Defined in: packages/typescript/ai/src/activities/generateImage/adapter.ts:33

Image adapter interface with pre-resolved generics.

An adapter is created by a provider function: provider('model') → adapter All type resolution happens at the provider call site, not in this interface.

Generic parameters:

  • TModel: The specific model name (e.g., 'dall-e-3')
  • TProviderOptions: Base provider-specific options (already resolved)
  • TModelProviderOptionsByName: Map from model name to its specific provider options
  • TModelSizeByName: Map from model name to its supported sizes

Type Parameters

TModel

TModel extends string = string

TProviderOptions

TProviderOptions extends object = Record<string, unknown>

TModelProviderOptionsByName

TModelProviderOptionsByName extends Record<string, any> = Record<string, any>

TModelSizeByName

TModelSizeByName extends Record<string, string> = Record<string, string>

Properties

~types

~types: object;

Defined in: packages/typescript/ai/src/activities/generateImage/adapter.ts:49

Internal

Type-only properties for inference. Not assigned at runtime.

modelProviderOptionsByName

modelProviderOptionsByName: TModelProviderOptionsByName;

modelSizeByName

modelSizeByName: TModelSizeByName;

providerOptions

providerOptions: TProviderOptions;

generateImages()

generateImages: (options) => Promise<ImageGenerationResult>;

Defined in: packages/typescript/ai/src/activities/generateImage/adapter.ts:58

Generate images from a prompt

Parameters

options

ImageGenerationOptions<TProviderOptions, TModelSizeByName[TModel]>

Returns

Promise<ImageGenerationResult>

kind

readonly kind: "image";

Defined in: packages/typescript/ai/src/activities/generateImage/adapter.ts:40

Discriminator for adapter kind - used by generate() to determine API shape

model

readonly model: TModel;

Defined in: packages/typescript/ai/src/activities/generateImage/adapter.ts:44

The model this adapter is configured for

name

readonly name: string;

Defined in: packages/typescript/ai/src/activities/generateImage/adapter.ts:42

Adapter name identifier