You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-foundry/openai/includes/api-versions/latest-inference-preview.md
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1215,6 +1215,8 @@ Generates a batch of images from a text caption on a given DALLE or gpt-image-1
1215
1215
| output_compression | integer | The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the jpeg output format. | No | 100 |
1216
1216
| output_format |[imagesOutputFormat](#imagesoutputformat)| The file format in which the generated images are returned. Only supported for gpt-image-1. | No | png |
1217
1217
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters for gpt-image-1 and 4000 characters for dall-e-3 | Yes ||
1218
+
|partial_images| integer | The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event. Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly. | 0 |
1219
+
| stream | boolean | Edit the image in streaming mode. | no |`false`|
1218
1220
| quality |[imageQuality](#imagequality)| The quality of the image that will be generated. | No | auto |
1219
1221
| response_format |[imagesResponseFormat](#imagesresponseformat)| The format in which the generated images are returned. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images.<br>Possible values: `url`, `b64_json`. | No | url |
1220
1222
| size |[imageSize](#imagesize)| The size of the generated images. | No | auto |
@@ -1349,10 +1351,13 @@ Edits an image from a text caption on a given gpt-image-1 model deployment
1349
1351
| Name | Type | Description | Required | Default |
| image | string or array | The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, or jpg file less than 50MB. | Yes ||
1354
+
| input_fidelity| string | Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Supports `high` and `low`. | no |`low`. |
1352
1355
| mask | string | An additional image whose fully transparent areas (e.g., where alpha is zero) indicate where the image should be edited. If there are multiple images provided, the mask will be applied to the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as the image. | No ||
1353
1356
| n | integer | The number of images to generate. Must be between 1 and 10. | No | 1 |
1354
1357
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters. | Yes ||
1355
1358
| quality |[imageQuality](#imagequality)| The quality of the image that will be generated. | No | auto |
1359
+
|partial_images| The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event. Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly. |
1360
+
| stream | boolean | Edit the image in streaming mode. | no |`false`|
1356
1361
| response_format |[imagesResponseFormat](#imagesresponseformat)| The format in which the generated images are returned. | No | url |
1357
1362
| size |[imageSize](#imagesize)| The size of the generated images. | No | auto |
1358
1363
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No ||
| image | string or array | The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, or jpg file less than 50MB. | Yes ||
668
+
| input_fidelity| string | Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Supports `high` and `low`. | no |`low`. |
668
669
| mask | string | An additional image whose fully transparent areas (e.g., where alpha is zero) indicate where the image should be edited. If there are multiple images provided, the mask will be applied to the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as the image. | No ||
669
670
| n | integer | The number of images to generate. | No | 1 |
670
671
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters. | Yes ||
671
672
| quality | enum | The quality of the image that will be generated. `high`, `medium` and `low` are only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality. Defaults to `auto`.<br>Possible values: `standard`, `low`, `medium`, `high`, `auto`| No ||
673
+
|partial_images| integer | The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event. Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly. | 0 |
674
+
| stream | boolean | Edit the image in streaming mode. | no |`false`|
672
675
| response_format | enum | The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for `dall-e-2`, as `gpt-image-1` will always return base64-encoded images.<br>Possible values: `url`, `b64_json`| No ||
673
676
| size | enum | The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.<br>Possible values: `256x256`, `512x512`, `1024x1024`, `1536x1024`, `1024x1536`, `auto`| No ||
674
677
| user | string | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. | No ||
@@ -693,7 +696,7 @@ Edits an image from a text caption on a given gpt-image-1 model deployment
POST {endpoint}/openai/v1/images/generations?api-version=preview
@@ -729,6 +732,8 @@ POST {endpoint}/openai/v1/images/generations?api-version=preview
729
732
| output_compression | integer | The compression level (0-100%) for the generated images. This parameter is only supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and defaults to 100. | No | 100 |
730
733
| output_format | enum | The format in which the generated images are returned. This parameter is only supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`.<br>Possible values: `png`, `jpeg`, `webp`| No ||
731
734
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters for `gpt-image-1`, 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`. | Yes ||
735
+
|partial_images| integer | The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event. Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly. | 0 |
736
+
| stream | boolean | Edit the image in streaming mode. | no |`false`|
732
737
| quality | enum | The quality of the image that will be generated. <br><br>- `auto` (default value) will automatically select the best quality for the given model.<br>- `high`, `medium` and `low` are supported for `gpt-image-1`.<br>- `hd` and `standard` are supported for `dall-e-3`.<br>- `standard` is the only option for `dall-e-2`.<br>Possible values: `standard`, `hd`, `low`, `medium`, `high`, `auto`| No ||
733
738
| response_format | enum | The format in which generated images with `dall-e-2` and `dall-e-3` are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for `gpt-image-1` which will always return base64-encoded images.<br>Possible values: `url`, `b64_json`| No ||
734
739
| size | enum | The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for `gpt-image-1`, one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`, and one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3`.<br>Possible values: `auto`, `1024x1024`, `1536x1024`, `1024x1536`, `256x256`, `512x512`, `1792x1024`, `1024x1792`| No ||
0 commit comments