Class ImagePrompt

Namespace

Glitch9.AIDevKit

A specialized prompt for various image-related requests, such as image inpainting, rotation, animation, etc.
This class is used to pass the instruction and the image to the respective image model for processing.

public sealed class ImagePrompt : IPromptWithFiles, IPrompt, IModeratable

Inheritance

object

ImagePrompt

Implements

IPromptWithFiles

IPrompt

IModeratable

Extension Methods

FluentApiRequestCallerExt.GENModeration(IModeratable, IEnumerable<SafetySetting>)

IPromptExtensions.Validate(IPrompt)

FluentApiRequestCallerExt.GENInpaint(ImagePrompt)

FluentApiRequestCallerExt.GENVideo(ImagePrompt)

FluentApiRequestCallerExt.ImageToImage(ImagePrompt)

Constructors

ImagePrompt()

public ImagePrompt()

ImagePrompt(File<Texture2D>, File<Texture2D>)

public ImagePrompt(File<Texture2D> imageFile, File<Texture2D> maskFile = null)

Parameters

imageFile File<Texture2D>

maskFile File<Texture2D>

ImagePrompt(string, File<Texture2D>, File<Texture2D>)

public ImagePrompt(string instruction, File<Texture2D> imageFile, File<Texture2D> maskFile = null)

Parameters

instruction string

imageFile File<Texture2D>

maskFile File<Texture2D>

ImagePrompt(string, Texture2D, Texture2D)

public ImagePrompt(string instruction, Texture2D image = null, Texture2D mask = null)

Parameters

instruction string

image Texture2D

mask Texture2D

ImagePrompt(Texture2D, Texture2D)

public ImagePrompt(Texture2D image, Texture2D mask = null)

Parameters

image Texture2D

mask Texture2D

Properties

Image

public Prompt<Texture2D> Image { get; set; }

Property Value

Prompt<Texture2D>

Instruction

public string Instruction { get; set; }

Property Value

string

Mask

Optional. The mask to be used for inpainting.
The mask should be a black and white image where the white area is the area to be edited.

public Prompt<Texture2D> Mask { get; set; }

Property Value

Prompt<Texture2D>

PromptType

public PromptType PromptType { get; }

Property Value

PromptType

Methods

GetInputFiles()

public List<IFile> GetInputFiles()

Returns

List<IFile>

GetInputText()

public string GetInputText()

Returns

string

IsValid()

public bool IsValid()

Returns

bool

LoadFilesAsync()

public UniTask LoadFilesAsync()

Returns

UniTask

RequiresLoading()

public bool RequiresLoading()

Returns

bool

ToModerationPrompt()

public ModerationPrompt ToModerationPrompt()

Returns

ModerationPrompt