ImageGenerationResult

Namespace: Vercel.AI.Provider

public class ImageGenerationResult

Image generation result.

Inheritance: object

Derived: LumaImageGeneration

View source

Constructors

ImageGenerationResult(IReadOnlyList<GeneratedImage>, IReadOnlyList<CallWarning>?, ImageResponseInfo?, LanguageModelUsage?, JsonElement?, bool?)

public ImageGenerationResult(IReadOnlyList<GeneratedImage> images, IReadOnlyList<CallWarning>? warnings = null, ImageResponseInfo? response = null, LanguageModelUsage? usage = null, JsonElement? providerMetadata = null, bool? isRetryable = null)

Creates an image result.

Parameters

Name	Type	Description
images	IReadOnlyList<GeneratedImage>
warnings	IReadOnlyList<CallWarning>
response	ImageResponseInfo
usage	LanguageModelUsage
providerMetadata	JsonElement?
isRetryable	bool?

View source

Properties

CallWarnings

public IReadOnlyList<CallWarning> CallWarnings { get; }

Warnings of this call. Maps to warnings.

Value: IReadOnlyList<CallWarning>

View source

Images

public IReadOnlyList<GeneratedImage> Images { get; }

Generated images.

Value: IReadOnlyList<GeneratedImage>

View source

IsRetryable

public bool? IsRetryable { get; }

<a href=“https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool"&gt;false&lt;/a> when an empty result must not be retried. Maps to isRetryable.

Value: bool?

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; }

Provider metadata of this call, keyed by provider name. Maps to providerMetadata.

Value: JsonElement?

View source

Response

public ImageResponseInfo? Response { get; }

Response metadata of this call, when the model reports it.

Value: ImageResponseInfo

View source

Usage

public LanguageModelUsage? Usage { get; }

Token usage, when the response included it.

Value: LanguageModelUsage

View source