Skip to content

FalProvider

Namespace: Vercel.AI.Fal

public sealed class FalProvider : OpenAICompatibleProvider

Fal provider.

Inheritance: object → ProviderBase → OpenAICompatibleProvider

View source

FalProvider(HttpClient, OpenAICompatibleOptions?)

Section titled “FalProvider(HttpClient, OpenAICompatibleOptions?)”
public FalProvider(HttpClient httpClient, OpenAICompatibleOptions? options = null)

Creates a provider.

Parameters

Name Type Description
httpClient HttpClient
options OpenAICompatibleOptions

View source

public const string DefaultBaseUrl = "https://fal.run"

Default API origin.

Value: string

View source

public const string ProviderId = "fal"

Provider id.

Value: string

View source

Create(OpenAICompatibleOptions?, HttpMessageHandler?)

Section titled “Create(OpenAICompatibleOptions?, HttpMessageHandler?)”
public static FalProvider Create(OpenAICompatibleOptions? options = null, HttpMessageHandler? handler = null)

Creates a provider.

Parameters

Name Type Description
options OpenAICompatibleOptions
handler HttpMessageHandler

Returns: FalProvider

View source

GenerateImageAsync(string, ImageCallOptions, IDictionary<string, string>?, CancellationToken)

Section titled “GenerateImageAsync(string, ImageCallOptions, IDictionary<string, string>?, CancellationToken)”
public Task<ImageGenerationResult> GenerateImageAsync(string modelId, ImageCallOptions options, IDictionary<string, string>? headers, CancellationToken cancellationToken)

Posts <code class=“paramref”>options</code> to {base}/{modelId}. <code class=“paramref”>headers</code> override the provider headers.

Parameters

Name Type Description
modelId string
options ImageCallOptions
headers IDictionary<string, string>
cancellationToken CancellationToken

Returns: Task<ImageGenerationResult>

View source

public override IImageModel ImageModel(string modelId)

Returns an image model.

Parameters

Name Type Description
modelId string

Returns: IImageModel

View source

public override ILanguageModel LanguageModel(string modelId)

Returns a language model.

Parameters

Name Type Description
modelId string

Returns: ILanguageModel

View source

public override ISpeechModel SpeechModel(string modelId)

Returns a speech model.

Parameters

Name Type Description
modelId string

Returns: ISpeechModel

View source

public override ITranscriptionModel TranscriptionModel(string modelId)

Returns a transcription model.

Parameters

Name Type Description
modelId string

Returns: ITranscriptionModel

View source

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