Skip to content

ImageCallOptions

Namespace: Vercel.AI.Provider

public sealed class ImageCallOptions

Image call settings.

Inheritance: object

View source

public ImageCallOptions(string prompt)

Creates image call options.

Parameters

Name Type Description
prompt string

View source

public string? AspectRatio { get; set; }

Aspect ratio such as 16:9.

Value: string

View source

public int Count { get; set; }

How many images to generate.

Value: int

View source

public IReadOnlyList<ImageModelFile>? Files { get; set; }

Input images for an edit. Maps to files.

Value: IReadOnlyList<ImageModelFile>

View source

public IReadOnlyDictionary<string, string?>? Headers { get; set; }

Headers for this call. They override the provider headers.

Value: IReadOnlyDictionary<string, string>

View source

public ImageModelFile? Mask { get; set; }

Edit mask.

Value: ImageModelFile

View source

public string Prompt { get; }

Image prompt.

Value: string

View source

public IReadOnlyDictionary<string, JsonElement>? ProviderOptions { get; set; }

Provider options, keyed by provider id.

Value: IReadOnlyDictionary<string, JsonElement>

View source

public int? Seed { get; set; }

Seed. Models that do not support it add a warning.

Value: int?

View source

public string? Size { get; set; }

Size string such as 1024x1024.

Value: string

View source

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