OpenAIImageModel

Namespace: Vercel.AI.OpenAI

public sealed class OpenAIImageModel : IImageModel

OpenAI image generation and edit model.

Inheritance: object

Implements: IImageModel

View source

Constructors

OpenAIImageModel(OpenAIProvider, string, Func<DateTimeOffset>?)

public OpenAIImageModel(OpenAIProvider provider, string modelId, Func<DateTimeOffset>? clock = null)

Creates an image model.

Parameters

Name	Type	Description
provider	OpenAIProvider
modelId	string
clock	Func<DateTimeOffset>

View source

Properties

MaxImagesPerCall

public int MaxImagesPerCall { get; }

Maximum images accepted by one call for this model id.

Value: int

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

Methods

DoGenerateAsync(ImageCallOptions, CancellationToken)

public Task<ImageGenerationResult> DoGenerateAsync(ImageCallOptions options, CancellationToken cancellationToken)

Generates images. Maps to doGenerate on an image model.

Parameters

Name	Type	Description
options	ImageCallOptions
cancellationToken	CancellationToken

Returns: Task<ImageGenerationResult>

View source

GenerateAsync(OpenAIImageCall, CancellationToken)

public Task<OpenAIImageGeneration> GenerateAsync(OpenAIImageCall call, CancellationToken cancellationToken)

Generates or edits images.

Parameters

Name	Type	Description
call	OpenAIImageCall
cancellationToken	CancellationToken

Returns: Task<OpenAIImageGeneration>

View source

MaxImages(string)

public static int MaxImages(string modelId)

Maximum images for <code class=“paramref”>modelId</code>.

Parameters

Name	Type	Description
modelId	string

Returns: int

View source

OmitsResponseFormat(string)

public static bool OmitsResponseFormat(string modelId)

True when the model rejects an explicit response_format.

Parameters

Name	Type	Description
modelId	string

Returns: bool

View source