Package io.github.stefanbratanov.jvm.openai

Class CreateImageRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • prompt

      public CreateImageRequest.Builder prompt(String prompt)
      Parameters:
      prompt - A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

    • model

      public CreateImageRequest.Builder model(String model)
      Parameters:
      model - The model to use for image generation.

    • model

      public CreateImageRequest.Builder model(OpenAIModel model)
      Parameters:
      model - OpenAIModel to use for image generation.

    • n

      public CreateImageRequest.Builder n(int n)
      Parameters:
      n - The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

    • quality

      public CreateImageRequest.Builder quality(String quality)
      Parameters:
      quality - The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

    • responseFormat

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

    • size

      public CreateImageRequest.Builder size(String size)
      Parameters:
      size - The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3 models.

    • style

      public CreateImageRequest.Builder style(String style)
      Parameters:
      style - The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

    • user

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

    • build

      public CreateImageRequest build()