Package dev.langchain4j.model.openai

Class OpenAiImageModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiImageModel

All Implemented Interfaces:

ImageModel

public class OpenAiImageModel
extends Object
implements ImageModel

Represents an OpenAI DALL·E models to generate artistic images. Versions 2 and 3 (default) are supported.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiImageModel.OpenAiImageModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiImageModel(String baseUrl, String apiKey, String organizationId, String modelName, String size, String quality, String style, String user, String responseFormat, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses, Boolean withPersisting, Path persistTo, Map<String,String> customHeaders)	Instantiates OpenAI DALL·E image processing model.

Method Summary

Modifier and Type	Method	Description
static OpenAiImageModel.OpenAiImageModelBuilder	builder()
Response<Image>	generate(String prompt)	Given a prompt, generate an image.
Response<List<Image>>	generate(String prompt, int n)	Given a prompt, generate n images.
String	modelName()
static OpenAiImageModel	withApiKey(String apiKey)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead, and explicitly set the model name and, if necessary, other parameters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.image.ImageModel

edit, edit

Constructor Details

OpenAiImageModel

public OpenAiImageModel(String baseUrl,
 String apiKey,
 String organizationId,
 String modelName,
 String size,
 String quality,
 String style,
 String user,
 String responseFormat,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 Boolean withPersisting,
 Path persistTo,
 Map<String,String> customHeaders)

Instantiates OpenAI DALL·E image processing model. Find the parameters description here.

Parameters:

modelName - dall-e-3 is default one

withPersisting - generated response will be persisted under java.io.tmpdir. The URL within dev.ai4j.openai4j.image.GenerateImagesResponse will contain the URL to local images then.

persistTo - specifies the local path where the generated image will be downloaded to (in case provided). The URL within dev.ai4j.openai4j.image.GenerateImagesResponse will contain the URL to local images then.

Method Details

modelName

public String modelName()

generate

public Response<Image> generate(String prompt)

Description copied from interface: ImageModel

Given a prompt, generate an image.

Specified by:

generate in interface ImageModel

Parameters:

prompt - The prompt to generate an image from.

Returns:

The generated image Response.

generate

public Response<List<Image>> generate(String prompt,
 int n)

Description copied from interface: ImageModel

Given a prompt, generate n images.

Not supported by all models; as explicit support is needed to generate different images from the same prompt.

Specified by:

generate in interface ImageModel

Parameters:

prompt - The prompt to generate images from.

n - The number of images to generate.

Returns:

The generated images Response.

builder

public static OpenAiImageModel.OpenAiImageModelBuilder builder()

withApiKey

@Deprecated(forRemoval=true)
public static OpenAiImageModel withApiKey(String apiKey)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use builder() instead, and explicitly set the model name and, if necessary, other parameters. The default value for the model name will be removed in future releases!