Class OpenAiImageModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiImageModel

All Implemented Interfaces:

ImageModel

public class OpenAiImageModel
extends Object
implements ImageModel

Represents an OpenAI image generation model. 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>	edit(Image image, Image mask, String prompt)	Given an existing image, edit this image following the given prompt and apply the changes only to the part of the image specified by the given mask.
Response<Image>	edit(Image image, String prompt)	Given an existing image, edit this image following the given prompt.
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 Object

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

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.

edit

public Response<Image> edit(Image image,
 String prompt)

Description copied from interface: ImageModel

Given an existing image, edit this image following the given prompt.

Specified by:

edit in interface ImageModel

Parameters:

image - The image to be edited.

prompt - The prompt to edit the image.

Returns:

The generated image Response.

edit

public Response<Image> edit(Image image,
 Image mask,
 String prompt)

Description copied from interface: ImageModel

Given an existing image, edit this image following the given prompt and apply the changes only to the part of the image specified by the given mask.

Specified by:

edit in interface ImageModel

Parameters:

image - The image to be edited.

mask - The image mask to apply to delimit the area to edit.

prompt - The prompt to edit the image.

Returns:

The generated image Response.

builder

public static OpenAiImageModel.OpenAiImageModelBuilder builder()