Class WorkersAiImageModel

java.lang.Object

dev.langchain4j.model.workersai.client.AbstractWorkersAIModel

dev.langchain4j.model.workersai.WorkersAiImageModel

All Implemented Interfaces:

ImageModel

public class WorkersAiImageModel
extends AbstractWorkersAIModel
implements ImageModel

WorkerAI Image model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkersAiImageModel.Builder	Internal Builder.

Field Summary

Fields inherited from class AbstractWorkersAIModel

accountId, modelName, workerAiClient

Constructor Summary

Constructors

Constructor	Description
WorkersAiImageModel(WorkersAiImageModel.Builder builder)	Constructor with Builder.
WorkersAiImageModel(String accountId, String modelName, String apiToken)	Constructor with Builder.

Method Summary

Modifier and Type	Method	Description
static WorkersAiImageModel.Builder	builder()	Builder access.
Image	convertAsImage(byte[] data)	Convert Workers AI Image Generation output to LangChain4j model.
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<File>	generate(String prompt, String destinationFile)	Generate image and save to file.
int[]	getPixels(URL imageUrl)	Convert an image into a array of number, supposedly the Pixels.

Methods inherited from class AbstractWorkersAIModel

processErrors

Methods inherited from class Object

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

Methods inherited from interface ImageModel

generate

Constructor Details

WorkersAiImageModel

public WorkersAiImageModel(WorkersAiImageModel.Builder builder)

Constructor with Builder.

Parameters:

builder - builder.

WorkersAiImageModel

public WorkersAiImageModel(String accountId,
 String modelName,
 String apiToken)

Constructor with Builder.

Parameters:

accountId - account identifier

modelName - model name

apiToken - api token

Method Details

builder

public static WorkersAiImageModel.Builder builder()

Builder access.

Returns:

builder instance

generate

public Response<Image> generate(String prompt)

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.

edit

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

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)

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.

generate

public Response<File> generate(String prompt,
 String destinationFile)

Generate image and save to file.

Parameters:

prompt - current prompt

destinationFile - local file

Returns:

response with the destination file

getPixels

public int[] getPixels(URL imageUrl)
                throws Exception

Convert an image into a array of number, supposedly the Pixels.

Parameters:

imageUrl - current image URL

Returns:

pixels of the image

Throws:

Exception - return an exception if pixel not returned

convertAsImage

public Image convertAsImage(byte[] data)

Convert Workers AI Image Generation output to LangChain4j model.

Parameters:

data - output image

Returns:

output image converted