Package io.github.stefanbratanov.jvm.openai

Class EditImageRequest.Builder

java.lang.Object
io.github.stefanbratanov.jvm.openai.EditImageRequest.Builder
Enclosing class:
EditImageRequest
public static class EditImageRequest.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • image

      public EditImageRequest.Builder image(Path image)
      Parameters:
      image - The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

    • prompt

      public EditImageRequest.Builder prompt(String prompt)
      Parameters:
      prompt - A text description of the desired image(s). The maximum length is 1000 characters.

    • mask

      public EditImageRequest.Builder mask(Path mask)
      Parameters:
      mask - An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

    • model

      public EditImageRequest.Builder model(String model)
      Parameters:
      model - The model to use for image generation. Only dall-e-2 is supported at this time.

    • model

      public EditImageRequest.Builder model(OpenAIModel model)
      Parameters:
      model - OpenAIModel to use for image generation. Only OpenAIModel.DALL_E_2 is supported at this time.

    • n

      public EditImageRequest.Builder n(int n)
      Parameters:
      n - The number of images to generate. Must be between 1 and 10.

    • size

      public EditImageRequest.Builder size(String size)
      Parameters:
      size - The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

    • responseFormat

      public EditImageRequest.Builder responseFormat(String responseFormat)
      Parameters:
      responseFormat - The format in which the generated images are returned. Must be one of url or b64_json.

    • user

      public EditImageRequest.Builder user(String user)
      Parameters:
      user - A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

    • build

      public EditImageRequest build()