Package io.github.stefanbratanov.jvm.openai

Class CreateImageVariationRequest.Builder

java.lang.Object

io.github.stefanbratanov.jvm.openai.CreateImageVariationRequest.Builder

Enclosing class:

CreateImageVariationRequest

public static class CreateImageVariationRequest.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateImageVariationRequest	build()
CreateImageVariationRequest.Builder	image(Path image)
CreateImageVariationRequest.Builder	model(OpenAIModel model)
CreateImageVariationRequest.Builder	model(String model)
CreateImageVariationRequest.Builder	n(int n)
CreateImageVariationRequest.Builder	responseFormat(String responseFormat)
CreateImageVariationRequest.Builder	size(String size)
CreateImageVariationRequest.Builder	user(String user)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

image

public CreateImageVariationRequest.Builder image(Path image)

Parameters:

image - The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

model

public CreateImageVariationRequest.Builder model(String model)

Parameters:

model - The model to use for image generation. Only dall-e-2 is supported at this time.

model

public CreateImageVariationRequest.Builder model(OpenAIModel model)

Parameters:

model - OpenAIModel to use for image generation. Only OpenAIModel.DALL_E_2 is supported at this time.

n

public CreateImageVariationRequest.Builder n(int n)

Parameters:

n - The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

responseFormat

public CreateImageVariationRequest.Builder responseFormat(String responseFormat)

Parameters:

responseFormat - The format in which the generated images are returned. Must be one of url or b64_json.

size

public CreateImageVariationRequest.Builder size(String size)

Parameters:

size - The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

user

public CreateImageVariationRequest.Builder user(String user)

Parameters:

user - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

build

public CreateImageVariationRequest build()