Skip to content

ImagePrompt

Namespace: Vercel.AI.Operations

public sealed class ImagePrompt

A string prompt or an image edit prompt.

Inheritance: object

View source

public ImagePrompt(string text)

Creates a text prompt.

Parameters

Name Type Description
text string

View source

ImagePrompt(string?, IReadOnlyList<object?>, object?)

Section titled “ImagePrompt(string?, IReadOnlyList<object?>, object?)”
public ImagePrompt(string? text, IReadOnlyList<object?> images, object? mask = null)

Creates an edit prompt.

Parameters

Name Type Description
text string
images IReadOnlyList<object>
mask object

View source

public bool HasImages { get; }

True when the caller passed the object form.

Value: bool

View source

public IReadOnlyList<object?> Images { get; }

Reference images when this is an edit prompt.

Value: IReadOnlyList<object>

View source

public object? Mask { get; }

Optional mask.

Value: object

View source

public string? Text { get; }

Prompt text.

Value: string

View source

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