Package com.azure.ai.openai.models

Class ImageGenerationOptions

java.lang.Object
com.azure.ai.openai.models.ImageGenerationOptions
public final class ImageGenerationOptions extends Object
Represents the request data used to generate images.

  • Constructor Details

    • ImageGenerationOptions

      public ImageGenerationOptions(String prompt)
      Creates an instance of ImageGenerationOptions class.
      Parameters:
      prompt - the prompt value to set.

  • Method Details

    • getPrompt

      public String getPrompt()
      Get the prompt property: A description of the desired images.
      Returns:
      the prompt value.

    • getN

      public Integer getN()
      Get the n property: The number of images to generate (defaults to 1).
      Returns:
      the n value.

    • setN

      public ImageGenerationOptions setN(Integer n)
      Set the n property: The number of images to generate (defaults to 1).
      Parameters:
      n - the n value to set.
      Returns:
      the ImageGenerationOptions object itself.

    • getSize

      public ImageSize getSize()
      Get the size property: The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).
      Returns:
      the size value.

    • setSize

      public ImageGenerationOptions setSize(ImageSize size)
      Set the size property: The desired size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (defaults to 1024x1024).
      Parameters:
      size - the size value to set.
      Returns:
      the ImageGenerationOptions object itself.

    • getUser

      public String getUser()
      Get the user property: A unique identifier representing your end-user, which can help to monitor and detect abuse.
      Returns:
      the user value.

    • setUser

      public ImageGenerationOptions setUser(String user)
      Set the user property: A unique identifier representing your end-user, which can help to monitor and detect abuse.
      Parameters:
      user - the user value to set.
      Returns:
      the ImageGenerationOptions object itself.