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/machine-learning/reference-model-inference-images-embeddings.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,14 @@ POST /images/embeddings?api-version=2024-04-01-preview
29
29
| --- | --- | --- | --- | --- |
30
30
| api-version | query | True | string | The version of the API in the format "YYYY-MM-DD" or "YYYY-MM-DD-preview". |
31
31
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
+
32
40
## Request Body
33
41
34
42
@@ -47,7 +55,7 @@ POST /images/embeddings?api-version=2024-04-01-preview
47
55
| 200 OK |[CreateEmbeddingResponse](#createembeddingresponse)| OK |
48
56
| 401 Unauthorized |[UnauthorizedError](#unauthorizederror)| Access token is missing or invalid<br><br>Headers<br><br>x-ms-error-code: string |
49
57
| 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 |
| 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 |
51
59
| 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 |
52
60
| Other Status Codes |[ContentFilterError](#contentfiltererror)| Bad request<br><br>Headers<br><br>x-ms-error-code: string |
|[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.|
152
160
|[Usage](#usage)| The usage information for the request. |
153
161
154
162
### ContentFilterError
@@ -286,6 +294,7 @@ The object type, which is always "list".
286
294
287
295
### UnprocessableContentError
288
296
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.
289
298
290
299
| Name | Type | Description |
291
300
| --- | --- | --- |
@@ -306,4 +315,4 @@ The usage information for the request.
306
315
| prompt_patches | integer | The number of image patches used by the image prompt. |
307
316
| prompt_tokens | integer | The number of tokens used by the prompt. |
308
317
| 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