Skip to content

Commit a987ddf

Browse files
authored
Update reference-model-inference-images-embeddings.md
1 parent 12d56cc commit a987ddf

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

articles/machine-learning/reference-model-inference-images-embeddings.md

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

32+
## Request Header
33+
34+
35+
| Name | Required | Type | Description |
36+
| --- | --- | --- | --- |
37+
| extra-parameters | | string | The behavior of the API when extra parameters are indicated in the payload. Using `pass-through` makes 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 `ignore` makes 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` makes the API to reject any extra parameter in the payload. Only parameters specified in this API can be indicated, or a 400 error is returned. |
38+
| azureml-model-deployment | | string | Name of the deployment you want to route the request to. Supported for endpoints that support multiple deployments. |
39+
3240
## Request Body
3341

3442

@@ -47,7 +55,7 @@ POST /images/embeddings?api-version=2024-04-01-preview
4755
| 200 OK | [CreateEmbeddingResponse](#createembeddingresponse) | OK |
4856
| 401 Unauthorized | [UnauthorizedError](#unauthorizederror) | Access token is missing or invalid<br><br>Headers<br><br>x-ms-error-code: string |
4957
| 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 |
50-
| 422 Unprocessable Entity | [UnprocessableContentError](#unprocessablecontenterror) | The request contains unprocessable content<br><br>Headers<br><br>x-ms-error-code: string |
58+
| 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 |
5159
| 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 |
5260
| Other Status Codes | [ContentFilterError](#contentfiltererror) | Bad request<br><br>Headers<br><br>x-ms-error-code: string |
5361

@@ -148,7 +156,7 @@ Status code: 200
148156
| [NotFoundError](#notfounderror) | |
149157
| [TooManyRequestsError](#toomanyrequestserror) | |
150158
| [UnauthorizedError](#unauthorizederror) | |
151-
| [UnprocessableContentError](#unprocessablecontenterror) | |
159+
| [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. |
152160
| [Usage](#usage) | The usage information for the request. |
153161

154162
### ContentFilterError
@@ -286,6 +294,7 @@ The object type, which is always "list".
286294

287295
### UnprocessableContentError
288296

297+
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.
289298

290299
| Name | Type | Description |
291300
| --- | --- | --- |
@@ -306,4 +315,4 @@ The usage information for the request.
306315
| prompt_patches | integer | The number of image patches used by the image prompt. |
307316
| prompt_tokens | integer | The number of tokens used by the prompt. |
308317
| total_patches | integer | The total number of patches used by the request. |
309-
| total_tokens | integer | The total number of tokens used by the request. |
318+
| total_tokens | integer | The total number of tokens used by the request. |

0 commit comments

Comments
 (0)