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. Find the parameters description here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiImageModel.OpenAiImageModelBuilder

Constructor Summary

Constructors

Constructor	Description
OpenAiImageModel(OpenAiImageModel.OpenAiImageModelBuilder builder)

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()

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(OpenAiImageModel.OpenAiImageModelBuilder builder)

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()