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 and Description
static class	OpenAiImageModel.OpenAiImageModelBuilder

Constructor Summary

Constructors

Constructor and Description
OpenAiImageModel(String baseUrl, @NonNull 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) Instantiates OpenAI DALL·E image processing model.

Method Summary

Modifier and Type	Method and Description
Response<Image>	generate(String prompt)
Response<List<Image>>	generate(String prompt, int n)
static OpenAiImageModel	withApiKey(String apiKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAiImageModel

public OpenAiImageModel(String baseUrl,
                        @NonNull
                        @NonNull 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)

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

Parameters:

modelName - dall-e-3 is default one

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.

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.

Method Detail

generate

public Response<Image> generate(String prompt)

Specified by:

generate in interface ImageModel

generate

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

Specified by:

generate in interface ImageModel

withApiKey

public static OpenAiImageModel withApiKey(String apiKey)