Package com.openai.models.images
See: Description
-
Class Summary Class Description Builder A builder for Image. Image Represents the content or the URL of an image generated by the OpenAI API. Builder A builder for ImageCreateVariationParams. Builder A builder for Body. Body ResponseFormat The format in which the generated images are returned. Size The size of the generated images. ImageCreateVariationParams Creates a variation of a given image. Builder A builder for ImageEditCompletedEvent. Background The background setting for the edited image. OutputFormat The output format for the edited image. Quality The quality setting for the edited image. Size The size of the edited image. Builder A builder for Usage. Builder A builder for InputTokensDetails. InputTokensDetails The input tokens detailed information for the image generation. Usage For gpt-image-1only, the token usage information for the image generation.ImageEditCompletedEvent Emitted when image editing has completed and the final image is available. Builder A builder for ImageEditParams. Builder A builder for Body. Body Image The image(s) to edit. Background Allows to set transparency for the background of the generated image(s). InputFidelity Control how much effort the model will exert to match the style and features, especially facial features, of input images. OutputFormat The format in which the generated images are returned. Quality The quality of the image that will be generated. ResponseFormat The format in which the generated images are returned. Size The size of the generated images. ImageEditParams Creates an edited or extended image given one or more source images and a prompt. Builder A builder for ImageEditPartialImageEvent. Background The background setting for the requested edited image. OutputFormat The output format for the requested edited image. Quality The quality setting for the requested edited image. Size The size of the requested edited image. ImageEditPartialImageEvent Emitted when a partial image is available during image editing streaming. ImageEditStreamEvent Emitted when a partial image is available during image editing streaming. Builder A builder for ImageGenCompletedEvent. Background The background setting for the generated image. OutputFormat The output format for the generated image. Quality The quality setting for the generated image. Size The size of the generated image. Builder A builder for Usage. Builder A builder for InputTokensDetails. InputTokensDetails The input tokens detailed information for the image generation. Usage For gpt-image-1only, the token usage information for the image generation.ImageGenCompletedEvent Emitted when image generation has completed and the final image is available. Builder A builder for ImageGenPartialImageEvent. Background The background setting for the requested image. OutputFormat The output format for the requested image. Quality The quality setting for the requested image. Size The size of the requested image. ImageGenPartialImageEvent Emitted when a partial image is available during image generation streaming. ImageGenStreamEvent Emitted when a partial image is available during image generation streaming. Builder A builder for ImageGenerateParams. Builder A builder for Body. Body Background Allows to set transparency for the background of the generated image(s). Moderation Control the content-moderation level for images generated by gpt-image-1.OutputFormat The format in which the generated images are returned. Quality The quality of the image that will be generated. ResponseFormat The format in which generated images with dall-e-2anddall-e-3are returned.Size The size of the generated images. Style The style of the generated images. ImageGenerateParams Creates an image given a prompt. ImageModel Builder A builder for ImagesResponse. Background The background parameter used for the image generation. OutputFormat The output format of the image generation. Quality The quality of the image generated. Size The size of the image generated. Builder A builder for Usage. Builder A builder for InputTokensDetails. InputTokensDetails The input tokens detailed information for the image generation. Usage For gpt-image-1only, the token usage information for the image generation.ImagesResponse The response from the image generation endpoint. -
Enum Summary Enum Description Known An enum containing ResponseFormat's known values. Value An enum containing ResponseFormat's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing InputFidelity's known values. Value An enum containing InputFidelity's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing ResponseFormat's known values. Value An enum containing ResponseFormat's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing Moderation's known values. Value An enum containing Moderation's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing ResponseFormat's known values. Value An enum containing ResponseFormat's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. Known An enum containing Style's known values. Value An enum containing Style's known values, as well as an _UNKNOWN member. Known An enum containing ImageModel's known values. Value An enum containing ImageModel's known values, as well as an _UNKNOWN member. Known An enum containing Background's known values. Value An enum containing Background's known values, as well as an _UNKNOWN member. Known An enum containing OutputFormat's known values. Value An enum containing OutputFormat's known values, as well as an _UNKNOWN member. Known An enum containing Quality's known values. Value An enum containing Quality's known values, as well as an _UNKNOWN member. Known An enum containing Size's known values. Value An enum containing Size's known values, as well as an _UNKNOWN member. -
Interface Summary Interface Description Visitor An interface that defines how to map each variant of Image to a value of type T. Visitor An interface that defines how to map each variant of ImageEditStreamEvent to a value of type T. Visitor An interface that defines how to map each variant of ImageGenStreamEvent to a value of type T.