Skip to content

Commit f7e05ad

Browse files
authored
Update reference-model-inference-images-embeddings.md
1 parent 0c7a671 commit f7e05ad

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

articles/ai-studio/reference/reference-model-inference-images-embeddings.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ POST /images/embeddings?api-version=2024-04-01-preview
3030
| --- | --- | --- | --- | --- |
3131
| api-version | query | True | string | The version of the API in the format "YYYY-MM-DD" or "YYYY-MM-DD-preview". |
3232

33+
## Request Header
34+
35+
36+
| Name | Required | Type | Description |
37+
| --- | --- | --- | --- |
38+
| extra-parameters | | string | The behavior of the API when extra parameters are indicated in the payload. Using `allow` will make the API to pass the parameter to the underlying model. Use this value when you want to pass parameters that you know the underlying model can support. Using `drop` will make the API to drop any unsupported parameter. Use this value when you need to use the same payload across different models, but one of the extra parameters may make a model to error out if not supported. Using `error` will make the API to reject any extra parameter in the payload. Only parameters specified int this API can be indicated, or an 400 error is returned. |
39+
| azureml-model-deployment | | string | Name of the deployment you want to route the request to. Supported for endpoints that support multiple deployments. |
40+
3341
## Request Body
3442

3543

@@ -48,7 +56,7 @@ POST /images/embeddings?api-version=2024-04-01-preview
4856
| 200 OK | [CreateEmbeddingResponse](#createembeddingresponse) | OK |
4957
| 401 Unauthorized | [UnauthorizedError](#unauthorizederror) | Access token is missing or invalid<br><br>Headers<br><br>x-ms-error-code: string |
5058
| 404 Not Found | [NotFoundError](#notfounderror) | Modality not supported by the model. Check the documentation of the model to see which routes are available.<br><br>Headers<br><br>x-ms-error-code: string |
51-
| 422 Unprocessable Entity | [UnprocessableContentError](#unprocessablecontenterror) | The request contains unprocessable content<br><br>Headers<br><br>x-ms-error-code: string |
59+
| 422 Unprocessable Entity | [UnprocessableContentError](#unprocessablecontenterror) | The request contains unprocessable content. The error is returned when the payload indicated is valid according to this specification. However, some of the instructions indicated in the payload are not supported by the underlying model. Use the `details` section to understand the offending parameter.<br><br>Headers<br><br>x-ms-error-code: string |
5260
| 429 Too Many Requests | [TooManyRequestsError](#toomanyrequestserror) | You have hit your assigned rate limit and your request need to be paced.<br><br>Headers<br><br>x-ms-error-code: string |
5361
| Other Status Codes | [ContentFilterError](#contentfiltererror) | Bad request<br><br>Headers<br><br>x-ms-error-code: string |
5462

@@ -287,6 +295,7 @@ The object type, which is always "list".
287295

288296
### UnprocessableContentError
289297

298+
The request contains unprocessable content. The error is returned when the payload indicated is valid according to this specification. However, some of the instructions indicated in the payload are not supported by the underlying model. Use the `details` section to understand the offending parameter.
290299

291300
| Name | Type | Description |
292301
| --- | --- | --- |
@@ -307,4 +316,4 @@ The usage information for the request.
307316
| prompt_patches | integer | The number of image patches used by the image prompt. |
308317
| prompt_tokens | integer | The number of tokens used by the prompt. |
309318
| total_patches | integer | The total number of patches used by the request. |
310-
| total_tokens | integer | The total number of tokens used by the request. |
319+
| total_tokens | integer | The total number of tokens used by the request. |

0 commit comments

Comments
 (0)