Skip to content

GatewayImageModel

Namespace: Vercel.AI.Gateway

public sealed class GatewayImageModel : IImageModel, IImageCaller

Gateway image model.

Inheritance: object

Implements: IImageModel, IImageCaller

View source

GatewayImageModel(GatewayProvider, string, string?)

Section titled “GatewayImageModel(GatewayProvider, string, string?)”
public GatewayImageModel(GatewayProvider provider, string modelId, string? providerName = null)

Creates a Gateway image model.

Parameters

Name Type Description
provider GatewayProvider Gateway provider that sends the requests.
modelId string Model id.
providerName string Value of Provider (upstream GatewayConfig.provider). Defaults to gateway.

View source

public int? MaxImagesPerCall { get; }

Large so that requests are never split client-side.

Value: int?

View source

public string ModelId { get; }

Model id.

Value: string

View source

public string Provider { get; }

Provider id.

Value: string

View source

public string SpecificationVersion { get; }

Specification version.

Value: string

View source

DoGenerateAsync(ImageModelCall, CancellationToken)

Section titled “DoGenerateAsync(ImageModelCall, CancellationToken)”
public Task<ImageModelResult> DoGenerateAsync(ImageModelCall call, CancellationToken cancellationToken)

Generates images.

Parameters

Name Type Description
call ImageModelCall
cancellationToken CancellationToken

Returns: Task<ImageModelResult>

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

ResolveMaxImagesPerCallAsync(CancellationToken)

Section titled “ResolveMaxImagesPerCallAsync(CancellationToken)”
public Task<int?> ResolveMaxImagesPerCallAsync(CancellationToken cancellationToken)

Resolves a functional per-call limit. The default returns MaxImagesPerCall.

Parameters

Name Type Description
cancellationToken CancellationToken

Returns: Task<int?>

View source

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