Class ImageService

Namespace

Glitch9.AIDevKit.OpenAI.Services

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

public class ImageService : CrudServiceBase<OpenAIClient>

Inheritance

object

ImageService

Constructors

ImageService(OpenAIClient)

public ImageService(OpenAIClient client)

Parameters

client OpenAIClient

Fields

kBaseUrl

public const string kBaseUrl = "VERSION/images"

Field Value

string

kEditsEndpoint

public const string kEditsEndpoint = "VERSION/images/edits"

Field Value

string

kGenerationEndpoint

public const string kGenerationEndpoint = "VERSION/images/generations"

Field Value

string

kVariationsEndpoint

public const string kVariationsEndpoint = "VERSION/images/variations"

Field Value

string

Methods

CreateAsync(ImageGenerationRequest, RESTOptions)

Creates an image given a prompt.

public UniTask<Generated<Texture2D>> CreateAsync(ImageGenerationRequest req, RESTOptions options = null)

Parameters

req ImageGenerationRequest

options RESTOptions

Returns

UniTask<Generated<Texture2D>>

CreateVariationAsync(ImageInpaintingRequest, RESTOptions)

Creates a variation of a given image.

public UniTask<Generated<Texture2D>> CreateVariationAsync(ImageInpaintingRequest req, RESTOptions options = null)

Parameters

req ImageInpaintingRequest

options RESTOptions

Returns

UniTask<Generated<Texture2D>>

EditAsync(ImageInpaintingRequest, RESTOptions)

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

public UniTask<Generated<Texture2D>> EditAsync(ImageInpaintingRequest req, RESTOptions options = null)

Parameters

req ImageInpaintingRequest

options RESTOptions

Returns

UniTask<Generated<Texture2D>>

StreamCreateAsync(ImageGenerationRequest, RESTOptions)

public UniTask<IRESTStream<OpenAIImageStreamEvent>> StreamCreateAsync(ImageGenerationRequest req, RESTOptions options = null)

Parameters

req ImageGenerationRequest

options RESTOptions

Returns

UniTask<IRESTStream<OpenAIImageStreamEvent>>

StreamEditAsync(ImageInpaintingRequest, RESTOptions)

public UniTask<IRESTStream<OpenAIImageStreamEvent>> StreamEditAsync(ImageInpaintingRequest req, RESTOptions options = null)

Parameters

req ImageInpaintingRequest

options RESTOptions

Returns

UniTask<IRESTStream<OpenAIImageStreamEvent>>