GenerateImageResult

Namespace: Vercel.AI.Operations

public sealed class GenerateImageResult

Result of CancellationToken).

Inheritance: object

View source

Constructors

GenerateImageResult(IReadOnlyList<GeneratedImage>, IReadOnlyList<ImageCallResult>, IReadOnlyList<OperationWarning>, IReadOnlyList<ProviderResponse>, JsonElement, OperationUsage)

public GenerateImageResult(IReadOnlyList<GeneratedImage> images, IReadOnlyList<ImageCallResult> calls, IReadOnlyList<OperationWarning> warnings, IReadOnlyList<ProviderResponse> responses, JsonElement providerMetadata, OperationUsage usage)

Creates a result.

Parameters

Name	Type	Description
images	IReadOnlyList<GeneratedImage>
calls	IReadOnlyList<ImageCallResult>
warnings	IReadOnlyList<OperationWarning>
responses	IReadOnlyList<ProviderResponse>
providerMetadata	JsonElement
usage	OperationUsage

View source

Properties

Calls

public IReadOnlyList<ImageCallResult> Calls { get; }

Underlying calls, including empty retries that were later replaced.

Value: IReadOnlyList<ImageCallResult>

View source

Image

public GeneratedImage Image { get; }

First image.

Value: GeneratedImage

View source

Images

public IReadOnlyList<GeneratedImage> Images { get; }

All images.

Value: IReadOnlyList<GeneratedImage>

View source

ProviderMetadata

public JsonElement ProviderMetadata { get; }

Merged provider metadata.

Value: JsonElement

View source

Responses

public IReadOnlyList<ProviderResponse> Responses { get; }

One response per collected call.

Value: IReadOnlyList<ProviderResponse>

View source

Usage

public OperationUsage Usage { get; }

Summed usage. Counts stay null until a provider reports them.

Value: OperationUsage

View source

Warnings

public IReadOnlyList<OperationWarning> Warnings { get; }

Aggregated warnings.

Value: IReadOnlyList<OperationWarning>

View source