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

Class ActionTypeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>

java.lang.Object
bg.codexio.ai.openai.api.sdk.images.ActionTypeStage<R>
All Implemented Interfaces:
StartStage
public class ActionTypeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> extends Object implements StartStage
A stage to choose the Images related action desired Current version includes following possibilities:
  • Creating images
  • Editing images
  • Generating images variations

  • Method Details

    • creating

      public AIModelStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest>> creating()
      Creates images given a prompt.
      Corresponds with /v1/images/generations endpoint

    • 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

    • another

      public ChoicesStage<bg.codexio.ai.openai.api.payload.images.request.ImageVariationRequest,PromptlessImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.ImageVariationRequest>> another(File image)
      Parameters:
      image - the original image passed to the model, baseline for the generated responses Creates variations of given image.
      Corresponds with /v1/images/variations endpoint