Class ImageService

Partial Client class of OpenAIClient for Image requests. (Image Creation / Editing / Variation) Those requests have slightly different formats.

Inheritance

object

CRUDServiceBase<OpenAI>

ImageService

Namespace: Glitch9.AIDevKit.OpenAI.Services

Assembly: .dll

Syntax

public class ImageService : CRUDServiceBase<OpenAI>

Constructors

ImageService(OpenAI)

Declaration

public ImageService(OpenAI client)

Parameters

Type	Name	Description
OpenAI	client

Fields

kBaseUrl

Declaration

public const string kBaseUrl = "{ver}/images"

Field Value

Type	Description
string

kEditsEndpoint

Declaration

public const string kEditsEndpoint = "{ver}/images/edits"

Field Value

Type	Description
string

kGenerationEndpoint

Declaration

public const string kGenerationEndpoint = "{ver}/images/generations"

Field Value

Type	Description
string

kVariationsEndpoint

Declaration

public const string kVariationsEndpoint = "{ver}/images/variations"

Field Value

Type	Description
string

Methods

CreateAsync(ImageCreationRequest)

Creates an image given a prompt.

Declaration

public UniTask<GeneratedImage> CreateAsync(ImageCreationRequest req)

Parameters

Type	Name	Description
ImageCreationRequest	req

Returns

Type	Description
UniTask<GeneratedImage>

CreateVariation(FormFile, int, Model, ImageSize, string)

Declaration

public UniTask<GeneratedImage> CreateVariation(FormFile image, int imageCount, Model model = null, ImageSize size = ImageSize._1024x1024, string downloadDir = null)

Parameters

Type	Name	Description
FormFile	image
int	imageCount
Model	model
ImageSize	size
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>

CreateVariation(Sprite, int, Model, ImageSize, string)

Declaration

public UniTask<GeneratedImage> CreateVariation(Sprite image, int imageCount, Model model = null, ImageSize size = ImageSize._1024x1024, string downloadDir = null)

Parameters

Type	Name	Description
Sprite	image
int	imageCount
Model	model
ImageSize	size
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>

CreateVariation(Texture2D, int, Model, ImageSize, string)

Declaration

public UniTask<GeneratedImage> CreateVariation(Texture2D image, int imageCount, Model model = null, ImageSize size = ImageSize._1024x1024, string downloadDir = null)

Parameters

Type	Name	Description
Texture2D	image
int	imageCount
Model	model
ImageSize	size
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>

CreateVariationAsync(ImageVariationRequest)

Creates a variation of a given image.

Declaration

public UniTask<GeneratedImage> CreateVariationAsync(ImageVariationRequest req)

Parameters

Type	Name	Description
ImageVariationRequest	req

Returns

Type	Description
UniTask<GeneratedImage>

Edit(FormFile, string, FormFile?, int, Model, ImageSize, string)

Declaration

public UniTask<GeneratedImage> Edit(FormFile image, string prompt, FormFile? mask = null, int imageCount = 1, Model model = null, ImageSize size = ImageSize._1024x1024, string downloadDir = null)

Parameters

Type	Name	Description
FormFile	image
string	prompt
FormFile?	mask
int	imageCount
Model	model
ImageSize	size
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>

Edit(Sprite, string, Sprite, int, Model, ImageSize, string)

Declaration

public UniTask<GeneratedImage> Edit(Sprite image, string prompt, Sprite mask = null, int imageCount = 1, Model model = null, ImageSize size = ImageSize._1024x1024, string downloadDir = null)

Parameters

Type	Name	Description
Sprite	image
string	prompt
Sprite	mask
int	imageCount
Model	model
ImageSize	size
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>

Edit(Texture2D, string, Texture2D, int, Model, ImageSize, string)

Declaration

public UniTask<GeneratedImage> Edit(Texture2D image, string prompt, Texture2D mask = null, int imageCount = 1, Model model = null, ImageSize size = ImageSize._1024x1024, string downloadDir = null)

Parameters

Type	Name	Description
Texture2D	image
string	prompt
Texture2D	mask
int	imageCount
Model	model
ImageSize	size
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>

EditAsync(ImageEditRequest)

Creates an edited or extended image given an original image and a prompt.

Declaration

public UniTask<GeneratedImage> EditAsync(ImageEditRequest req)

Parameters

Type	Name	Description
ImageEditRequest	req

Returns

Type	Description
UniTask<GeneratedImage>

Generate(string, int, Model, ImageSize, ImageQuality, ImageStyle, string)

Declaration

public UniTask<GeneratedImage> Generate(string prompt, int imageCount, Model model = null, ImageSize size = ImageSize._1024x1024, ImageQuality quality = ImageQuality.Standard, ImageStyle style = ImageStyle.Vivid, string downloadDir = null)

Parameters

Type	Name	Description
string	prompt
int	imageCount
Model	model
ImageSize	size
ImageQuality	quality
ImageStyle	style
string	downloadDir

Returns

Type	Description
UniTask<GeneratedImage>