Skip to content

Commit 51039ad

Browse files
Merge pull request #4338 from PatrickFarley/imagen
fix ref docs
2 parents ed66fcf + c4aef7e commit 51039ad

File tree

1 file changed

+42
-13
lines changed

1 file changed

+42
-13
lines changed

articles/ai-services/openai/includes/api-versions/latest-inference-preview.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,17 +1215,21 @@ Generates a batch of images from a text caption on a given DALL-E or GPT-image-1
12151215

12161216
**Content-Type**: application/json
12171217

1218+
12181219
| Name | Type | Description | Required | Default |
12191220
|------|------|-------------|----------|---------|
12201221
| n | integer | The number of images to generate. | No | 1 |
12211222
| prompt | string | A text description of the desired image(s). The maximum length is 4000 characters. | Yes | |
12221223
| quality | [imageQuality](#imagequality) | The quality of the image that will be generated. | No | standard (for DALL-E)</br>high (for GPT-image-1) |
12231224
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
12241225
| size | [imageSize](#imagesize) | The size of the generated images. | No | 1024x1024 |
1225-
| style | [imageStyle](#imagestyle) | The style of the generated images. | No | vivid |
1226+
| style | [imageStyle](#imagestyle) | The style of the generated images. (DALL-E 3 only)| No | vivid |
12261227
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
1227-
| output_format | string | The format in which the generated images are returned. GPT-image-1 models only. | No | PNG |
1228-
| output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
1228+
| output_format | [imageOutputFormat](#imageoutputformat) | The format in which the generated images are returned. (GPT-image-1 only) | No | PNG |
1229+
| safety | [imageSafety](#imagesafety) | The safety setting of the image generation process. (GPT-image-1 only) | No | auto |
1230+
| No | auto |
1231+
| background | [imageBackground](#imagebackground) | The desired appearance of the background of the image. (GPT-image-1 only) | No | auto |
1232+
| compression_level | integer | The compression level (on a scale of 0-100) of the generated images. (GPT-image-1 only) | No | 0 |
12291233

12301234
### Responses
12311235

@@ -1355,6 +1359,7 @@ Generates an image based on an input image and text prompt instructions. Require
13551359

13561360
**Content-Type**: application/json
13571361

1362+
13581363
| Name | Type | Description | Required | Default |
13591364
|------|------|-------------|----------|---------|
13601365
| image | file | The input image to edit. Must be a valid image URL or base64-encoded image. | Yes | |
@@ -1364,10 +1369,8 @@ Generates an image based on an input image and text prompt instructions. Require
13641369
| quality | string | The quality of the image that will be generated. Values are 'low', 'medium', 'high' | No | high |
13651370
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
13661371
| size | [imageSize](#imagesize) | The size of the generated images. | No | 1024x1024 |
1367-
| style | [imageStyle](#imagestyle) | The style of the generated images. | No | vivid |
13681372
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
13691373
| output_format | [imageOutputFormat](#imageoutputformat) | The format in which the generated images are returned. | No | PNG |
1370-
| output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
13711374

13721375

13731376
### Responses
@@ -6121,13 +6124,24 @@ Speech request.
61216124
| speed | number | The speed of the synthesized audio. Select a value from `0.25` to `4.0`. `1.0` is the default. | No | 1.0 |
61226125
| voice | enum | The voice to use for speech synthesis.<br>Possible values: `alloy`, `echo`, `fable`, `onyx`, `nova`, `shimmer` | Yes | |
61236126

6127+
### imageBackground
6128+
6129+
The desired appearance of the background of the image.
6130+
6131+
| Property | Value |
6132+
|----------|-------|
6133+
| **Description** | The desired appearance of the background of the image. |
6134+
| **Type** | string |
6135+
| **Default** | auto |
6136+
| **Values** | `transparent`</br>`opaque`</br>`auto`|
6137+
61246138
### imageOutputFormat
61256139

6126-
The requested output format for the generated image.
6140+
The format in which the generated images are returned.
61276141

61286142
| Property | Value |
61296143
|----------|-------|
6130-
| **Description** | The requested output format for the generated image. |
6144+
| **Description** | The format in which the generated images are returned. |
61316145
| **Type** | string |
61326146
| **Default** | PNG |
61336147
| **Values** | `PNG`<br>`JPEG` |
@@ -6154,6 +6168,19 @@ The format in which the generated images are returned.
61546168
| **Default** | url |
61556169
| **Values** | `url`<br>`b64_json` |
61566170

6171+
### imageSafety
6172+
6173+
The safety setting of the image generation process.
6174+
6175+
| Property | Value |
6176+
|----------|-------|
6177+
| **Description** | The safety setting of the image generation process. |
6178+
| **Type** | string |
6179+
| **Default** | auto |
6180+
| **Values** | `strict`</br>`auto`|
6181+
6182+
6183+
61576184
### imageSize
61586185

61596186
The size of the generated images.
@@ -6163,7 +6190,7 @@ The size of the generated images.
61636190
| **Description** | The size of the generated images. |
61646191
| **Type** | string |
61656192
| **Default** | 1024x1024 |
6166-
| **Values** | `256x256`<br>`512x512`<br>`1792x1024`<br>`1024x1792`<br>`1024x1024` |
6193+
| **Values** | `256x256`, `512x512`, `1792x1024`, `1024x1792`, `1024x1024` (for DALL-E)</br>`1024x1024`, `1024x1536`, `1536x1024` (for GPT-image-1) |
61676194

61686195
### imageStyle
61696196

@@ -6185,10 +6212,13 @@ The style of the generated images.
61856212
| quality | [imageQuality](#imagequality) | The quality of the image that will be generated. | No | standard (for DALL-E)</br>high (for GPT-image-1) |
61866213
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
61876214
| size | [imageSize](#imagesize) | The size of the generated images. | No | 1024x1024 |
6188-
| style | [imageStyle](#imagestyle) | The style of the generated images. | No | vivid |
6215+
| style | [imageStyle](#imagestyle) | The style of the generated images. (DALL-E 3 only)| No | vivid |
61896216
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
6190-
| output_format | string | The format in which the generated images are returned. GPT-image-1 models only. | No | PNG |
6191-
| output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
6217+
| output_format | [imageOutputFormat](#imageoutputformat) | The format in which the generated images are returned. (GPT-image-1 only) | No | PNG |
6218+
| safety | [imageSafety](#imagesafety) | The safety setting of the image generation process. (GPT-image-1 only) | No | auto |
6219+
| No | auto |
6220+
| background | [imageBackground](#imagebackground) | The desired appearance of the background of the image. (GPT-image-1 only) | No | auto |
6221+
| compression_level | integer | The compression level (on a scale of 0-100) of the generated images. (GPT-image-1 only) | No | 0 |
61926222

61936223
### imageEditsRequest
61946224

@@ -6202,10 +6232,9 @@ The style of the generated images.
62026232
| quality | string | The quality of the image that will be generated. Values are 'low', 'medium', 'high' | No | high |
62036233
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
62046234
| size | [imageSize](#imagesize) | The size of the generated images. | No | 1024x1024 |
6205-
| style | [imageStyle](#imagestyle) | The style of the generated images. | No | vivid |
62066235
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
62076236
| output_format | [imageOutputFormat](#imageoutputformat) | The format in which the generated images are returned. | No | PNG |
6208-
| output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
6237+
62096238

62106239

62116240

0 commit comments

Comments
 (0)