Class ImageService

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

Inheritance
object
CrudServiceBase<OpenAIClient>
ImageService
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.OpenAI.Services
Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll
Syntax
public sealed class ImageService : CrudServiceBase<OpenAIClient>, ICrudService

Constructors

| Edit this page View Source

ImageService(OpenAIClient)

Declaration
public ImageService(OpenAIClient client)
Parameters
Type Name Description
OpenAIClient client

Fields

| Edit this page View Source

k_Child_Edits

Declaration
public const string k_Child_Edits = "edits"
Field Value
Type Description
string
| Edit this page View Source

k_Child_Generations

Declaration
public const string k_Child_Generations = "generations"
Field Value
Type Description
string
| Edit this page View Source

k_Child_Variations

Declaration
public const string k_Child_Variations = "variations"
Field Value
Type Description
string

Methods

| Edit this page View Source

CreateAsync(ImageGenerationRequest, RequestOptions)

Creates an image given a prompt.

Declaration
public UniTask<Generated<IImageAsset>> CreateAsync(ImageGenerationRequest request, RequestOptions options = null)
Parameters
Type Name Description
ImageGenerationRequest request
RequestOptions options
Returns
Type Description
UniTask<Generated<IImageAsset>>
| Edit this page View Source

CreateVariationAsync(ImageEditRequest, RequestOptions)

Creates a variation of a given image.

Declaration
public UniTask<Generated<IImageAsset>> CreateVariationAsync(ImageEditRequest request, RequestOptions options = null)
Parameters
Type Name Description
ImageEditRequest request
RequestOptions options
Returns
Type Description
UniTask<Generated<IImageAsset>>
| Edit this page View Source

EditAsync(ImageEditRequest, RequestOptions)

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

Declaration
public UniTask<Generated<IImageAsset>> EditAsync(ImageEditRequest request, RequestOptions options = null)
Parameters
Type Name Description
ImageEditRequest request
RequestOptions options
Returns
Type Description
UniTask<Generated<IImageAsset>>
| Edit this page View Source

StreamAsync(ImageGenerationRequest, RequestOptions)

Declaration
public IGenerativeStream<Delta<IImageChunk>, IImageAsset> StreamAsync(ImageGenerationRequest request, RequestOptions options = null)
Parameters
Type Name Description
ImageGenerationRequest request
RequestOptions options
Returns
Type Description
IGenerativeStream<Delta<IImageChunk>, IImageAsset>
| Edit this page View Source

StreamEditAsync(ImageEditRequest, RequestOptions)

Declaration
public IGenerativeStream<Delta<IImageChunk>, IImageAsset> StreamEditAsync(ImageEditRequest request, RequestOptions options = null)
Parameters
Type Name Description
ImageEditRequest request
RequestOptions options
Returns
Type Description
IGenerativeStream<Delta<IImageChunk>, IImageAsset>

Implements

Extension Methods