Skip to content

OpenAICompatibleImageModel

Namespace: Vercel.AI.OpenAICompatible

public sealed class OpenAICompatibleImageModel : IImageModel

OpenAI-compatible image model.

Inheritance: object

Implements: IImageModel

View source

OpenAICompatibleImageModel(OpenAICompatibleProvider, string, Func<DateTimeOffset>?)

Section titled “OpenAICompatibleImageModel(OpenAICompatibleProvider, string, Func<DateTimeOffset>?)”
public OpenAICompatibleImageModel(OpenAICompatibleProvider provider, string modelId, Func<DateTimeOffset>? clock = null)

Creates an image model.

Parameters

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

View source

public string ModelId { get; }

Model id.

Value: string

View source

public string Provider { get; }

Provider id.

Value: string

View source

DoGenerateAsync(ImageCallOptions, CancellationToken)

Section titled “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

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product