Skip to content

ByteDanceImageModel

Namespace: Vercel.AI.ByteDance

public sealed class ByteDanceImageModel : IImageModel, IImageCaller

ByteDance Seedream image model. Input files turn a generation into an edit.

Inheritance: object

Implements: IImageModel, IImageCaller

View source

ByteDanceImageModel(ByteDanceProvider, string, Func<DateTimeOffset>?)

Section titled “ByteDanceImageModel(ByteDanceProvider, string, Func<DateTimeOffset>?)”
public ByteDanceImageModel(ByteDanceProvider provider, string modelId, Func<DateTimeOffset>? clock = null)

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

Parameters

Name Type Description
provider ByteDanceProvider
modelId string
clock Func<DateTimeOffset>

View source

public int? MaxImagesPerCall { get; }

The API has no output count, so each call returns one image.

Value: int?

View source

public string ModelId { get; }

Model id.

Value: string

View source

public string Provider { get; }

Provider id.

Value: string

View source

DoGenerateAsync(ImageModelCall, CancellationToken)

Section titled “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)

Section titled “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)

Section titled “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

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