FalImageModel

Namespace: Vercel.AI.Fal

public sealed class FalImageModel : IImageModel, IImageCaller

Fal image model. Posts to {baseURL}/{modelId} and downloads each returned image.

Inheritance: object

Implements: IImageModel, IImageCaller

View source

Constructors

FalImageModel(FalProvider, string, Func<DateTime>?)

public FalImageModel(FalProvider provider, string modelId, Func<DateTime>? clock = null)

Creates an image model. <code class=“paramref”>clock</code> sets the response timestamp.

Parameters

Name	Type	Description
provider	FalProvider
modelId	string
clock	Func<DateTime>

View source

Properties

MaxImagesPerCall

public int? MaxImagesPerCall { get; }

Fal returns one image per call.

Value: int?

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

SpecificationVersion

public string SpecificationVersion { get; }

Specification version.

Value: string

View source

SupportsFileInputs

public bool? SupportsFileInputs { get; }

True when the model takes input images, false when it does not, null when unknown. Maps to supportsFileInputs.

Value: bool?

View source

SupportsMaskInputs

public bool? SupportsMaskInputs { get; }

True when the model takes a mask, false when it takes input images but no mask, null when unknown. Maps to supportsMaskInputs.

Value: bool?

View source

Methods

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)

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)

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