Package bg.codexio.ai.openai.api.sdk.images

Class EditingActionTypeStage

java.lang.Object

bg.codexio.ai.openai.api.sdk.images.EditingActionTypeStage

All Implemented Interfaces:

StartStage

public class EditingActionTypeStage
extends Object
implements StartStage

Explicit marker action type stage for flows where only editing is possible
E.g. when only a EditImageHttpExecutor has been provided

Method Summary

Modifier and Type	Method	Description
EditingMaskStage<bg.codexio.ai.openai.api.payload.images.request.EditImageRequest,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.EditImageRequest>>	editing(File image)

Methods inherited from class java.lang.Object

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

Method Details

editing

public EditingMaskStage<bg.codexio.ai.openai.api.payload.images.request.EditImageRequest,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.EditImageRequest>> editing(File image)

Parameters:

image - the original image passed to the model, baseline for the generated responses Creates edited or extended image given an original image and a prompt.

Important note: The image must be a valid PNG file, less than 4MB, and square. If mask is not provided (see EditingMaskStage), image must have transparency, which will be used as the mask.

Corresponds with /v1/images/edits endpoint