Class Image
-
- All Implemented Interfaces:
public final class ImageRepresents the content or the URL of an image generated by the OpenAI API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classImage.BuilderA builder for Image.
-
Method Summary
Modifier and Type Method Description final Optional<String>b64Json()The base64-encoded JSON of the generated image. final Optional<String>revisedPrompt()For dall-e-3only, the revised prompt that was used to generate the image.final Optional<String>url()When using dall-e-2ordall-e-3, the URL of the generated image ifresponse_formatis set tourl(default value).final JsonField<String>_b64Json()Returns the raw JSON value of b64Json. final JsonField<String>_revisedPrompt()Returns the raw JSON value of revisedPrompt. final JsonField<String>_url()Returns the raw JSON value of url. final Map<String, JsonValue>_additionalProperties()final Image.BuildertoBuilder()final Imagevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Image.Builderbuilder()Returns a mutable builder for constructing an instance of Image. -
-
Method Detail
-
b64Json
final Optional<String> b64Json()
The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if
response_formatis set tob64_jsonfordall-e-2anddall-e-3.
-
revisedPrompt
final Optional<String> revisedPrompt()
For
dall-e-3only, the revised prompt that was used to generate the image.
-
url
final Optional<String> url()
When using
dall-e-2ordall-e-3, the URL of the generated image ifresponse_formatis set tourl(default value). Unsupported for the GPT image models.
-
_b64Json
final JsonField<String> _b64Json()
Returns the raw JSON value of b64Json.
Unlike b64Json, this method doesn't throw if the JSON field has an unexpected type.
-
_revisedPrompt
final JsonField<String> _revisedPrompt()
Returns the raw JSON value of revisedPrompt.
Unlike revisedPrompt, this method doesn't throw if the JSON field has an unexpected type.
-
_url
final JsonField<String> _url()
Returns the raw JSON value of url.
Unlike url, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Image.Builder toBuilder()
-
validate
final Image validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static Image.Builder builder()
Returns a mutable builder for constructing an instance of Image.
-
-
-
-