Package io.github.stefanbratanov.jvm.openai

Class ImagesClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.ImagesClient

public final class ImagesClient
extends Object

Given a prompt and/or an input image, the model will generate a new image.

Based on Images

Method Summary

Modifier and Type	Method	Description
Images	createImage(CreateImageRequest request)	Creates an image given a prompt.
CompletableFuture<Images>	createImageAsync(CreateImageRequest request)	Same as createImage(CreateImageRequest) but returns a response in a CompletableFuture
Images	createImageVariation(CreateImageVariationRequest request)	Creates a variation of a given image.
CompletableFuture<Images>	createImageVariationAsync(CreateImageVariationRequest request)	Same as createImageVariation(CreateImageVariationRequest) but returns a response in a CompletableFuture
Images	editImage(EditImageRequest request)	Creates an edited or extended image given an original image and a prompt.
CompletableFuture<Images>	editImageAsync(EditImageRequest request)	Same as editImage(EditImageRequest) but returns a response in a CompletableFuture

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createImage

public Images createImage(CreateImageRequest request)

Creates an image given a prompt.

Throws:

OpenAIException - in case of API errors

createImageAsync

public CompletableFuture<Images> createImageAsync(CreateImageRequest request)

Same as createImage(CreateImageRequest) but returns a response in a CompletableFuture

editImage

public Images editImage(EditImageRequest request)

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

Throws:

OpenAIException - in case of API errors

editImageAsync

public CompletableFuture<Images> editImageAsync(EditImageRequest request)

Same as editImage(EditImageRequest) but returns a response in a CompletableFuture

createImageVariation

public Images createImageVariation(CreateImageVariationRequest request)

Creates a variation of a given image.

Throws:

OpenAIException - in case of API errors

createImageVariationAsync

public CompletableFuture<Images> createImageVariationAsync(CreateImageVariationRequest request)

Same as createImageVariation(CreateImageVariationRequest) but returns a response in a CompletableFuture