Skip to content

Commit 908ffa2

Browse files
committed
update input requirements
1 parent 3014939 commit 908ffa2

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1216,7 +1216,7 @@ Generates a batch of images from a text caption on a given DALLE or gpt-image-1
12161216
| output_format | [imagesOutputFormat](#imagesoutputformat) | The file format in which the generated images are returned. Only supported for gpt-image-1. | No | png |
12171217
| 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 | |
12181218
| quality | [imageQuality](#imagequality) | The quality of the image that will be generated. | No | auto |
1219-
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
1219+
| 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 |
12201220
| size | [imageSize](#imagesize) | The size of the generated images. | No | auto |
12211221
| style | [imageStyle](#imagestyle) | The style of the generated images. Only supported for dall-e-3. | No | vivid |
12221222
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
@@ -1348,9 +1348,9 @@ Edits an image from a text caption on a given gpt-image-1 model deployment
13481348

13491349
| Name | Type | Description | Required | Default |
13501350
|------|------|-------------|----------|---------|
1351-
| 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 25MB. | Yes | |
1351+
| 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 | |
13521352
| 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-
| n | integer | The number of images to generate. | No | 1 |
1353+
| n | integer | The number of images to generate. Must be between 1 and 10. | No | 1 |
13541354
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters. | Yes | |
13551355
| quality | [imageQuality](#imagequality) | The quality of the image that will be generated. | No | auto |
13561356
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
@@ -6237,7 +6237,7 @@ Allows to set transparency for the background of the generated image(s). This pa
62376237
| output_format | [imagesOutputFormat](#imagesoutputformat) | The file format in which the generated images are returned. Only supported for gpt-image-1. | No | png |
62386238
| 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 | |
62396239
| quality | [imageQuality](#imagequality) | The quality of the image that will be generated. | No | auto |
6240-
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
6240+
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. Only supported for dall-e-3. | No | url |
62416241
| size | [imageSize](#imagesize) | The size of the generated images. | No | auto |
62426242
| style | [imageStyle](#imagestyle) | The style of the generated images. Only supported for dall-e-3. | No | vivid |
62436243
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |

articles/ai-foundry/openai/includes/api-versions/new-inference-preview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -664,7 +664,7 @@ Edits an image from a text caption on a given gpt-image-1 model deployment
664664

665665
| Name | Type | Description | Required | Default |
666666
|------|------|-------------|----------|---------|
667-
| 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 25MB. | Yes | |
667+
| 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 | |
668668
| 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 | |
669669
| n | integer | The number of images to generate. | No | 1 |
670670
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters. | Yes | |
@@ -2024,13 +2024,13 @@ Represents a completion response from the API. Note: both the streamed and non-s
20242024
| Name | Type | Description | Required | Default |
20252025
|------|------|-------------|----------|---------|
20262026
| background | enum | Allows to set transparency for the background of the generated image(s). <br>This parameter is only supported for `gpt-image-1`. Must be one of `transparent`, `opaque` or `auto` (default value). When `auto` is used, the model will automatically determine the best background for the image.<br><br>If `transparent`, the output format needs to support transparency, so it should be set to either `png` (default value) or `webp`.<br>Possible values: `transparent`, `opaque`, `auto` | No | |
2027-
| image | string or array | | Yes | |
2027+
| 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 | |
20282028
| mask | string | | No | |
20292029
| model | string | The model deployment to use for the image edit operation. | Yes | |
20302030
| n | integer | The number of images to generate. Must be between 1 and 10. | No | 1 |
20312031
| prompt | string | A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2`, and 32000 characters for `gpt-image-1`. | Yes | |
20322032
| 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 | |
2033-
| 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 | |
2033+
| response_format | enum | The format in which the generated images are returned. Must be one of `url` or `b64_json`. <br>Possible values: `url`, `b64_json` | No | |
20342034
| 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 | |
20352035
| user | string | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. | No | |
20362036

0 commit comments

Comments
 (0)