Skip to content

Commit 91c8d3a

Browse files
committed
Merge branch 'main' into release-scommi
2 parents d857a02 + ce624c8 commit 91c8d3a

File tree

210 files changed

+1528
-970
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+1528
-970
lines changed

.openpublishing.redirection.azure-monitor.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6684,6 +6684,21 @@
66846684
"redirect_url": "/azure/azure-monitor/monitor-azure-monitor-reference",
66856685
"redirect_document_id": false
66866686
},
6687+
{
6688+
"source_path_from_root": "/articles/azure-monitor/ai-ops/responsible-ai-faq.md",
6689+
"redirect_url": "/azure/copilot/overview",
6690+
"redirect_document_id": false
6691+
},
6692+
{
6693+
"source_path_from_root": "/articles/azure-monitor/ai-ops/investigator-overview.md",
6694+
"redirect_url": "/azure/copilot/overview",
6695+
"redirect_document_id": false
6696+
},
6697+
{
6698+
"source_path_from_root": "/articles/azure-monitor/ai-ops/investigate-alert-instance.md",
6699+
"redirect_url": "/azure/copilot/overview",
6700+
"redirect_document_id": false
6701+
},
66876702
{
66886703
"source_path_from_root": "/articles/azure-monitor/insights/resource-group-insights.md",
66896704
"redirect_url": "/azure/azure-resource-manager/management/resource-group-insights",

articles/ai-services/.openpublishing.redirection.applied-ai-services.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,5 +240,15 @@
240240
"redirect_url": "/azure/ai-services/content-moderator/term-lists-quickstart-dotnet",
241241
"redirect_document_id": false
242242
},
243+
{
244+
"source_path_from_root": "/articles/ai-services/content-safety/concepts/incident-response.md",
245+
"redirect_url": "/azure/ai-services/content-safety/concepts/custom-categories-rapid",
246+
"redirect_document_id": true
247+
},
248+
{
249+
"source_path_from_root": "/articles/ai-services/content-safety/how-to/incident-response.md",
250+
"redirect_url": "/azure/ai-services/content-safety/how-to/custom-categories-rapid",
251+
"redirect_document_id": true
252+
}
243253
]
244254
}

articles/ai-services/computer-vision/identity-api-reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ Azure AI Face is a cloud-based service that provides algorithms for face detecti
2424
- [PersonGroup APIs](/rest/api/face/person-group-operations): Used to manage a PersonGroup dataset for [Identification From Person Group](/rest/api/face/face-recognition-operations/identify-from-person-group).
2525
- [LargePersonGroup APIs](/rest/api/face/person-group-operations): Used to manage a LargePersonGroup dataset for [Identification From Large Person Group](/rest/api/face/face-recognition-operations/identify-from-large-person-group).
2626
- [PersonDirectory APIs](/rest/api/face/person-directory-operations): Used to manage a PersonDirectory dataset for [Identification From Person Directory](/rest/api/face/face-recognition-operations/identify-from-person-directory) or [Identification From Dynamic Person Group](/rest/api/face/face-recognition-operations/identify-from-dynamic-person-group).
27+
- [Face API error codes](./reference-face-error-codes.md): A list of all error codes returned by the Face API operations.
Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
---
2+
title: Azure AI Face API error codes
3+
description: Error codes returned from Face API services.
4+
author: shaoli
5+
ms.service: azure-ai-vision
6+
ms.subservice: azure-ai-face
7+
ms.topic: reference
8+
ms.author: shaoli
9+
ms.date: 05/24/2024
10+
---
11+
12+
# Azure AI Face API error codes
13+
14+
15+
## Common error codes
16+
17+
These error codes can be returned by any Face API calls.
18+
19+
|Http status code|Error code|Error message|Description|
20+
|----------------|----------|-------------|-----------|
21+
|Bad Request (400)|BadArgument|Request body is invalid.||
22+
|Bad Request (400)|BadArgument|JSON parsing error.|Bad or unrecognizable request JSON body.|
23+
|Bad Request (400)|BadArgument|'recognitionModel' is invalid.||
24+
|Bad Request (400)|BadArgument|'detectionModel' is invalid.||
25+
|Bad Request (400)|BadArgument|'name' is empty.||
26+
|Bad Request (400)|BadArgument|'name' is too long.||
27+
|Bad Request (400)|BadArgument|'userData' is too long.||
28+
|Bad Request (400)|BadArgument|'start' is too long.||
29+
|Bad Request (400)|BadArgument|'top' is invalid.||
30+
|Bad Request (400)|BadArgument|Argument targetFace out of range.||
31+
|Bad Request (400)|BadArgument|Invalid argument targetFace.|Caused by invalid string format or invalid left/top/height/width value.|
32+
|Bad Request (400)|InvalidURL|Invalid image URL.|Supported formats include JPEG, PNG, GIF(the first frame) and BMP.|
33+
|Bad Request (400)|InvalidURL|Invalid image URL or error downloading from target server. Remote server error returned: "An error occurred while sending the request."||
34+
|Bad Request (400)|InvalidImage|Decoding error, image format unsupported.||
35+
|Bad Request (400)|InvalidImage|No face detected in the image.||
36+
|Bad Request (400)|InvalidImage|There is more than 1 face in the image.||
37+
|Bad Request (400)|InvalidImageSize|Image size is too small.|The valid image file size should be larger than or equal to 1 KB.|
38+
|Bad Request (400)|InvalidImageSize|Image size is too big.|The valid image file size should be no larger than 6 MB.|
39+
|Unauthorized (401)|401|Access denied due to invalid subscription key or wrong API endpoint. Make sure to provide a valid key for an active subscription and use a correct regional API endpoint for your resource.||
40+
|Conflict (409)|ConcurrentOperationConflict|There is a conflict operation on resource `<resourceName>`, please try later.||
41+
|Too Many Requests (429)|429|Rate limit is exceeded.||
42+
43+
44+
## Face Detection error codes
45+
46+
These error codes can be returned by Face Detection operation.
47+
48+
|Http status code|Error code|Error message|Description|
49+
|---|---|---|---|
50+
|Bad Request (400)|BadArgument|Invalid argument returnFaceAttributes.||
51+
|Bad Request (400)|BadArgument|'returnFaceAttributes' is not supported by detection_02.||
52+
|Bad Request (400)|BadArgument|'returnLandmarks' is not supported by detection_02.||
53+
54+
## Face Liveness Session error codes
55+
56+
These error codes can be returned by Face Liveness Session operations.
57+
58+
|Http status code|Error code|Error message|Description|
59+
|---|---|---|---|
60+
|Bad Request (400)|BadArgument|Start parameter is invalid. Please specify the 'Id' field of the last entry to continue the listing process.||
61+
|Bad Request (400)|BadArgument|Top parameter is invalid. Valid range is between 1 and 1000 inclusive.||
62+
|Bad Request (400)|InvalidRequestBody|Incorrect request body provided. Please check the operation schema and try again.||
63+
|Bad Request (400)|InvalidTokenLifetime|Invalid authTokenTimeToLiveInSeconds specified. Must be within 60 to 86400.||
64+
|Bad Request (400)|InvalidLivenessOperationMode|Invalid livenessOperationMode specified. Must be 'Passive'.||
65+
|Bad Request (400)|InvalidDeviceCorrelationId|A device correlation ID is required in the request body during session create or session start. Must not be null or empty, and be no more than 64 characters.||
66+
|Not Found (404)|SessionNotFound|Session ID is not found. The session ID is expired or does not exist.||
67+
68+
## Face Identify error codes
69+
70+
These error codes can be returned by Face Identify operation.
71+
72+
|Http status code|Error code|Error message|Description|
73+
|---|---|---|---|
74+
|Bad Request (400)|BadArgument|'recognitionModel' is incompatible.||
75+
|Bad Request (400)|BadArgument|Person group ID is invalid.||
76+
|Bad Request (400)|BadArgument|Large person group ID is invalid.||
77+
|Bad Request (400)|BadArgument|Dynamic person group ID is invalid.||
78+
|Bad Request (400)|BadArgument|The argument maxNumOfCandidatesReturned is not valid.|The valid range is between [1, 100].|
79+
|Bad Request (400)|BadArgument|The argument confidenceThreshold is not valid.|The valid range is between [0, 1].|
80+
|Bad Request (400)|BadArgument|The length of faceIds is not in a valid range.|The valid range is between [1, 10].|
81+
|Bad Request (400)|FaceNotFound|Face is not found.||
82+
|Bad Request (400)|PersonGroupNotFound|Person group is not found.||
83+
|Bad Request (400)|LargePersonGroupNotFound|Large person group is not found.||
84+
|Bad Request (400)|DynamicPersonGroupNotFound|Dynamic person group is not found.||
85+
|Bad Request (400)|PersonGroupNotTrained|Person group not trained.||
86+
|Bad Request (400)|LargePersonGroupNotTrained|Large person group not trained.||
87+
|Bad Request (400)|PersonGroupIdAndLargePersonGroupIdBothNotNull|Large person group ID and person group ID are both not null.||
88+
|Bad Request (400)|PersonGroupIdAndLargePersonGroupIdBothNull|Large person group ID and person group ID are both null.||
89+
|Bad Request (400)|MissingIdentificationScopeParameters|No identification scope parameter is present in the request.||
90+
|Bad Request (400)|IncompatibleIdentificationScopeParametersCombination|Incompatible identification scope parameters are present in the request.||
91+
|Conflict (409)|PersonGroupTrainingNotFinished|Person group is under training.||
92+
|Conflict (409)|LargePersonGroupTrainingNotFinished|Large person group is under training.||
93+
94+
## Face Verify error codes
95+
96+
These error codes can be returned by Face Verify operation.
97+
98+
|Http status code|Error code|Error message|Description|
99+
|---|---|---|---|
100+
|Bad Request (400)|BadArgument|'recognitionModel' is incompatible.||
101+
|Bad Request (400)|BadArgument|Face ID is invalid.|A valid faceId comes from Face - Detect.|
102+
|Bad Request (400)|BadArgument|Person ID is invalid.|A valid personId is generated from Create Person Group Person, Create Large Person Group Person or Person Directory - Create Person.|
103+
|Bad Request (400)|BadArgument|Person group ID is invalid.||
104+
|Bad Request (400)|BadArgument|Large person group ID is invalid.||
105+
|Bad Request (400)|PersonNotFound|Person is not found.||
106+
|Bad Request (400)|PersonGroupNotFound|Person Group is not found.||
107+
|Bad Request (400)|LargePersonGroupNotFound|Large Person Group is not found.||
108+
|Not Found (404)|FaceNotFound|Face is not found.||
109+
|Not Found (404)|PersonNotFound|Person is not found.||
110+
|Not Found (404)|PersistedFaceNotFound|No persisted face of the person is found.||
111+
112+
## Find Similar error codes
113+
114+
These error codes can be returned by Face Find Similar operation.
115+
116+
|Http status code|Error code|Error message|Description|
117+
|---|---|---|---|
118+
|Bad Request (400)|BadArgument|'recognitionModel' is incompatible.||
119+
|Bad Request (400)|BadArgument|Mode is invalid.||
120+
|Bad Request (400)|BadArgument|Face list ID is invalid.||
121+
|Bad Request (400)|BadArgument|Large face list ID is invalid.||
122+
|Bad Request (400)|BadArgument|LargeFaceListId, faceListId and faceIds, not exactly one of them is valid.||
123+
|Bad Request (400)|BadArgument|LargeFaceListId, faceListId and faceIds are all null.||
124+
|Bad Request (400)|BadArgument|2 or more of largeFaceListId, faceListId and faceIds are not null.||
125+
|Bad Request (400)|BadArgument|The argument maxNumOfCandidatesReturned is not valid.|The valid range is between [1, 1000].|
126+
|Bad Request (400)|BadArgument|The length of faceIds is not in a valid range.|The valid range is between [1, 1000].|
127+
|Bad Request (400)|FaceNotFound|Face is not found.||
128+
|Bad Request (400)|FaceListNotFound|Face list is not found.||
129+
|Bad Request (400)|LargeFaceListNotFound|Large face list is not found.||
130+
|Bad Request (400)|LargeFaceListNotTrained|Large face list is not trained.||
131+
|Bad Request (400)|FaceListNotReady|Face list is empty.||
132+
|Conflict (409)|LargeFaceListTrainingNotFinished|Large face list is under training.||
133+
134+
## Face Group error codes
135+
136+
These error codes can be returned by Face Group operation.
137+
138+
|Http status code|Error code|Error message|Description|
139+
|---|---|---|---|
140+
|Bad Request (400)|BadArgument|'recognitionModel' is incompatible.||
141+
|Bad Request (400)|BadArgument|The length of faceIds is not in a valid range.|The valid range is between [2, 1000].|
142+
143+
144+
## Person Group operations
145+
146+
These error codes can be returned by Person Group operations.
147+
148+
### Person Group error codes
149+
150+
|Http status code|Error code|Error message|Description|
151+
|---|---|---|---|
152+
|Bad Request (400)|BadArgument|Person group ID is invalid.|Valid character is English letter in lower case, digit, '-' or '_'. Maximum length is 64.|
153+
|Forbidden (403)|QuotaExceeded|Person group number reached subscription level limit.||
154+
|Forbidden (403)|QuotaExceeded|Person number reached person group level limit.||
155+
|Forbidden (403)|QuotaExceeded|Person number reached subscription level limit.||
156+
|Forbidden (403)|QuotaExceeded|Persisted face number reached limit.||
157+
|Not Found (404)|PersonGroupNotFound|Person group is not found.||
158+
|Not Found (404)|PersonGroupNotFound|Person group ID is invalid.||
159+
|Not Found (404)|PersonNotFound|Person `<personId>` is not found.||
160+
|Not Found (404)|PersonNotFound|Person ID is invalid.||
161+
|Not Found (404)|PersistedFaceNotFound|Persisted face is not found.||
162+
|Not Found (404)|PersistedFaceNotFound|Persisted face `<faceId>` is not found.||
163+
|Not Found (404)|PersistedFaceNotFound|Persisted face ID is invalid.||
164+
|Not Found (404)|PersonGroupNotTrained|Person group not trained.|This error appears on getting training status of a group which never been trained.|
165+
|Conflict (409)|PersonGroupExists|Person group already exists.||
166+
|Conflict (409)|PersonGroupTrainingNotFinished|Person group is under training.|Try again after training completed.|
167+
168+
### Large Person Group error codes
169+
170+
|Http status code|Error code|Error message|Description|
171+
|---|---|---|---|
172+
|Bad Request (400)|BadArgument|Large person group ID is invalid.|Valid character is English letter in lower case, digit, '-' or '_'. Maximum length is 64.|
173+
|Bad Request (400)|BadArgument|Both 'name' and 'userData' are empty.||
174+
|Forbidden (403)|QuotaExceeded|Large person group number reached subscription level limit.||
175+
|Forbidden (403)|QuotaExceeded|Person number reached large person group level limit.||
176+
|Forbidden (403)|QuotaExceeded|Person number reached subscription level limit.||
177+
|Forbidden (403)|QuotaExceeded|Persisted face number reached limit.||
178+
|Not Found (404)|LargePersonGroupNotFound|Large person group is not found.||
179+
|Not Found (404)|LargePersonGroupNotFound|Large person group ID is invalid.||
180+
|Not Found (404)|PersonNotFound|Person `<personId>` is not found.||
181+
|Not Found (404)|PersonNotFound|Person ID is invalid.||
182+
|Not Found (404)|PersistedFaceNotFound|Persisted face is not found.||
183+
|Not Found (404)|PersistedFaceNotFound|Persisted face `<faceId>` is not found.||
184+
|Not Found (404)|PersistedFaceNotFound|Persisted face ID is invalid.||
185+
|Not Found (404)|LargePersonGroupNotTrained|Large person group not trained.|This error appears on getting training status of a group which never been trained.|
186+
|Conflict (409)|LargePersonGroupExists|Large person group already exists.||
187+
|Conflict (409)|LargePersonGroupTrainingNotFinished|Large person group is under training.|Try again after training completed.|
188+
189+
## Face List operations
190+
191+
These error codes can be returned by Face List operations.
192+
193+
### Face List error codes
194+
195+
|Http status code|Error code|Error message|Description|
196+
|---|---|---|---|
197+
|Bad Request (400)|BadArgument|Face list ID is invalid.|Valid character is English letter in lower case, digit, '-' or '_'. Maximum length is 64.|
198+
|Forbidden (403)|QuotaExceeded|Persisted face number reached limit.||
199+
|Not Found (404)|FaceListNotFound|Face list is not found.||
200+
|Not Found (404)|FaceListNotFound|Face list ID is invalid.||
201+
|Not Found (404)|PersistedFaceNotFound|Persisted face is not found.||
202+
|Not Found (404)|PersistedFaceNotFound|Persisted face ID is invalid.||
203+
|Conflict (409)|FaceListExists|Face list already exists.||
204+
205+
### Large Face List error codes
206+
207+
|Http status code|Error code|Error message|Description|
208+
|---|---|---|---|
209+
|Bad Request (400)|BadArgument|Large face list ID is invalid.|Valid character is English letter in lower case, digit, '-' or '_'. Maximum length is 64.|
210+
|Bad Request (400)|BadArgument|Both 'name' and 'userData' are empty.||
211+
|Forbidden (403)|QuotaExceeded|Large Face List number reached limit.||
212+
|Forbidden (403)|QuotaExceeded|Persisted face number reached limit.||
213+
|Not Found (404)|LargeFaceListNotFound|Large face list is not found.||
214+
|Not Found (404)|LargeFaceListNotFound|Large face list ID is invalid.||
215+
|Not Found (404)|PersistedFaceNotFound|Large Face List Face `<faceId>` is not found.||
216+
|Not Found (404)|PersistedFaceNotFound|Persisted face ID is invalid.||
217+
|Not Found (404)|LargeFaceListNotTrained|Large face list not trained.|This error appears on getting training status of a large face list which never been trained.|
218+
|Conflict (409)|LargeFaceListExists|Large face list already exists.||
219+
|Conflict (409)|LargeFaceListTrainingNotFinished|Large face list is under training.|Try again after training completed.|
220+
221+
## Person Directory operations
222+
223+
These error codes can be returned by Person Directory operations.
224+
225+
### Person Directory error codes
226+
227+
|Http status code|Error code|Error message|Description|
228+
|---|---|---|---|
229+
|Bad Request (400)|BadArgument|Recognition model is not supported for this feature.||
230+
|Bad Request (400)|BadArgument|'start' is not valid person ID.||
231+
|Bad Request (400)|BadArgument|Both 'name' and 'userData' are empty.||
232+
|Bad Request (400)|DynamicPersonGroupNotFound|Dynamic person group ID is invalid.||
233+
|Forbidden (403)|QuotaExceeded|Person number reached subscription level limit.||
234+
|Forbidden (403)|QuotaExceeded|Persisted face number reached limit.||
235+
|Not Found (404)|DynamicPersonGroupNotFound|Dynamic person group was not found.||
236+
|Not Found (404)|DynamicPersonGroupNotFound|DynamicPersonGroupPersonReference `<groupId>` is not found.||
237+
|Not Found (404)|PersonNotFound|Person is not found.||
238+
|Not Found (404)|PersonNotFound|Person ID is invalid.||
239+
|Not Found (404)|PersistedFaceNotFound|Persisted face is not found.||
240+
|Not Found (404)|PersistedFaceNotFound|Persisted face `<faceId>` is not found.||
241+
|Not Found (404)|PersistedFaceNotFound|Persisted Face ID is invalid.||
242+
|Conflict (409)|DynamicPersonGroupExists|Dynamic person group ID `<groupId>` already exists.||
243+
244+
Next steps
245+
246+
- [Face API reference](/rest/api/face/operation-groups)

articles/ai-services/computer-vision/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,8 @@ items:
364364
items:
365365
- name: Face REST API
366366
href: identity-api-reference.md
367+
- name: Face API error codes
368+
href: reference-face-error-codes.md
367369
- name: .NET
368370
href: /dotnet/api/overview/azure/cognitiveservices/face
369371
- name: Java

0 commit comments

Comments
 (0)