@azure-rest/ai-vision-face 1.0.0-alpha.20241030.1 → 1.0.0-alpha.20241111.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/LICENSE +21 -0
  3. package/dist/browser/clientDefinitions.d.ts +401 -380
  4. package/dist/browser/clientDefinitions.d.ts.map +1 -1
  5. package/dist/browser/clientDefinitions.js.map +1 -1
  6. package/dist/browser/faceClient.d.ts +3 -1
  7. package/dist/browser/faceClient.d.ts.map +1 -1
  8. package/dist/browser/faceClient.js +5 -4
  9. package/dist/browser/faceClient.js.map +1 -1
  10. package/dist/browser/isUnexpected.d.ts +34 -32
  11. package/dist/browser/isUnexpected.d.ts.map +1 -1
  12. package/dist/browser/isUnexpected.js +30 -29
  13. package/dist/browser/isUnexpected.js.map +1 -1
  14. package/dist/browser/models.d.ts +92 -12
  15. package/dist/browser/models.d.ts.map +1 -1
  16. package/dist/browser/models.js.map +1 -1
  17. package/dist/browser/outputModels.d.ts +253 -161
  18. package/dist/browser/outputModels.d.ts.map +1 -1
  19. package/dist/browser/outputModels.js.map +1 -1
  20. package/dist/browser/parameters.d.ts +326 -297
  21. package/dist/browser/parameters.d.ts.map +1 -1
  22. package/dist/browser/parameters.js.map +1 -1
  23. package/dist/browser/pollingHelper.d.ts +5 -4
  24. package/dist/browser/pollingHelper.d.ts.map +1 -1
  25. package/dist/browser/pollingHelper.js +3 -3
  26. package/dist/browser/pollingHelper.js.map +1 -1
  27. package/dist/browser/responses.d.ts +573 -539
  28. package/dist/browser/responses.d.ts.map +1 -1
  29. package/dist/browser/responses.js.map +1 -1
  30. package/dist/commonjs/clientDefinitions.d.ts +401 -380
  31. package/dist/commonjs/clientDefinitions.d.ts.map +1 -1
  32. package/dist/commonjs/clientDefinitions.js.map +1 -1
  33. package/dist/commonjs/faceClient.d.ts +3 -1
  34. package/dist/commonjs/faceClient.d.ts.map +1 -1
  35. package/dist/commonjs/faceClient.js +5 -4
  36. package/dist/commonjs/faceClient.js.map +1 -1
  37. package/dist/commonjs/isUnexpected.d.ts +34 -32
  38. package/dist/commonjs/isUnexpected.d.ts.map +1 -1
  39. package/dist/commonjs/isUnexpected.js +30 -29
  40. package/dist/commonjs/isUnexpected.js.map +1 -1
  41. package/dist/commonjs/models.d.ts +92 -12
  42. package/dist/commonjs/models.d.ts.map +1 -1
  43. package/dist/commonjs/models.js.map +1 -1
  44. package/dist/commonjs/outputModels.d.ts +253 -161
  45. package/dist/commonjs/outputModels.d.ts.map +1 -1
  46. package/dist/commonjs/outputModels.js.map +1 -1
  47. package/dist/commonjs/parameters.d.ts +326 -297
  48. package/dist/commonjs/parameters.d.ts.map +1 -1
  49. package/dist/commonjs/parameters.js.map +1 -1
  50. package/dist/commonjs/pollingHelper.d.ts +5 -4
  51. package/dist/commonjs/pollingHelper.d.ts.map +1 -1
  52. package/dist/commonjs/pollingHelper.js +3 -3
  53. package/dist/commonjs/pollingHelper.js.map +1 -1
  54. package/dist/commonjs/responses.d.ts +573 -539
  55. package/dist/commonjs/responses.d.ts.map +1 -1
  56. package/dist/commonjs/responses.js.map +1 -1
  57. package/dist/esm/clientDefinitions.d.ts +401 -380
  58. package/dist/esm/clientDefinitions.d.ts.map +1 -1
  59. package/dist/esm/clientDefinitions.js.map +1 -1
  60. package/dist/esm/faceClient.d.ts +3 -1
  61. package/dist/esm/faceClient.d.ts.map +1 -1
  62. package/dist/esm/faceClient.js +5 -4
  63. package/dist/esm/faceClient.js.map +1 -1
  64. package/dist/esm/isUnexpected.d.ts +34 -32
  65. package/dist/esm/isUnexpected.d.ts.map +1 -1
  66. package/dist/esm/isUnexpected.js +30 -29
  67. package/dist/esm/isUnexpected.js.map +1 -1
  68. package/dist/esm/models.d.ts +92 -12
  69. package/dist/esm/models.d.ts.map +1 -1
  70. package/dist/esm/models.js.map +1 -1
  71. package/dist/esm/outputModels.d.ts +253 -161
  72. package/dist/esm/outputModels.d.ts.map +1 -1
  73. package/dist/esm/outputModels.js.map +1 -1
  74. package/dist/esm/parameters.d.ts +326 -297
  75. package/dist/esm/parameters.d.ts.map +1 -1
  76. package/dist/esm/parameters.js.map +1 -1
  77. package/dist/esm/pollingHelper.d.ts +5 -4
  78. package/dist/esm/pollingHelper.d.ts.map +1 -1
  79. package/dist/esm/pollingHelper.js +3 -3
  80. package/dist/esm/pollingHelper.js.map +1 -1
  81. package/dist/esm/responses.d.ts +573 -539
  82. package/dist/esm/responses.d.ts.map +1 -1
  83. package/dist/esm/responses.js.map +1 -1
  84. package/dist/react-native/clientDefinitions.d.ts +401 -380
  85. package/dist/react-native/clientDefinitions.d.ts.map +1 -1
  86. package/dist/react-native/clientDefinitions.js.map +1 -1
  87. package/dist/react-native/faceClient.d.ts +3 -1
  88. package/dist/react-native/faceClient.d.ts.map +1 -1
  89. package/dist/react-native/faceClient.js +5 -4
  90. package/dist/react-native/faceClient.js.map +1 -1
  91. package/dist/react-native/isUnexpected.d.ts +34 -32
  92. package/dist/react-native/isUnexpected.d.ts.map +1 -1
  93. package/dist/react-native/isUnexpected.js +30 -29
  94. package/dist/react-native/isUnexpected.js.map +1 -1
  95. package/dist/react-native/models.d.ts +92 -12
  96. package/dist/react-native/models.d.ts.map +1 -1
  97. package/dist/react-native/models.js.map +1 -1
  98. package/dist/react-native/outputModels.d.ts +253 -161
  99. package/dist/react-native/outputModels.d.ts.map +1 -1
  100. package/dist/react-native/outputModels.js.map +1 -1
  101. package/dist/react-native/parameters.d.ts +326 -297
  102. package/dist/react-native/parameters.d.ts.map +1 -1
  103. package/dist/react-native/parameters.js.map +1 -1
  104. package/dist/react-native/pollingHelper.d.ts +5 -4
  105. package/dist/react-native/pollingHelper.d.ts.map +1 -1
  106. package/dist/react-native/pollingHelper.js +3 -3
  107. package/dist/react-native/pollingHelper.js.map +1 -1
  108. package/dist/react-native/responses.d.ts +573 -539
  109. package/dist/react-native/responses.d.ts.map +1 -1
  110. package/dist/react-native/responses.js.map +1 -1
  111. package/package.json +39 -33
  112. package/review/ai-vision-face.api.md +375 -296
@@ -1,15 +1,23 @@
1
1
  import type { RequestParameters } from "@azure-rest/core-client";
2
- import type { DetectionModel, RecognitionModel, FaceAttributeType, FindSimilarMatchMode, CreateLivenessSessionContent, CreateLivenessWithVerifySessionContent } from "./models.js";
2
+ import type { DetectionModel, RecognitionModel, FaceAttributeType, FindSimilarMatchMode, CreateCollectionRequest, UserDefinedFieldsForUpdate, AddFaceFromUrlRequest, FaceUserData, UserDefinedFields, CreateLivenessSessionContent, CreateLivenessWithVerifySessionMultipartContent, CreateLivenessWithVerifySessionJsonContent } from "./models.js";
3
3
  export type GetOperationResultParameters = RequestParameters;
4
4
  export interface DetectFromUrlBodyParam {
5
- body?: {
5
+ body: {
6
6
  url: string;
7
7
  };
8
8
  }
9
9
  export interface DetectFromUrlQueryParamProperties {
10
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
10
+ /**
11
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. 'detection_03' is recommended since its accuracy is improved on smaller faces (64x64 pixels) and rotated face orientations.
12
+ *
13
+ * Possible values: "detection_01", "detection_02", "detection_03"
14
+ */
11
15
  detectionModel?: DetectionModel;
12
- /** The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. */
16
+ /**
17
+ * The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.
18
+ *
19
+ * Possible values: "recognition_01", "recognition_02", "recognition_03", "recognition_04"
20
+ */
13
21
  recognitionModel?: RecognitionModel;
14
22
  /** Return faceIds of the detected faces or not. The default value is true. */
15
23
  returnFaceId?: boolean;
@@ -39,9 +47,17 @@ export interface DetectBodyParam {
39
47
  body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream;
40
48
  }
41
49
  export interface DetectQueryParamProperties {
42
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
50
+ /**
51
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. 'detection_03' is recommended since its accuracy is improved on smaller faces (64x64 pixels) and rotated face orientations.
52
+ *
53
+ * Possible values: "detection_01", "detection_02", "detection_03"
54
+ */
43
55
  detectionModel?: DetectionModel;
44
- /** The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. */
56
+ /**
57
+ * The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.
58
+ *
59
+ * Possible values: "recognition_01", "recognition_02", "recognition_03", "recognition_04"
60
+ */
45
61
  recognitionModel?: RecognitionModel;
46
62
  /** Return faceIds of the detected faces or not. The default value is true. */
47
63
  returnFaceId?: boolean;
@@ -62,8 +78,45 @@ export interface DetectMediaTypesParam {
62
78
  contentType: "application/octet-stream";
63
79
  }
64
80
  export type DetectParameters = DetectQueryParam & DetectMediaTypesParam & DetectBodyParam & RequestParameters;
81
+ export interface DetectFromSessionImageIdBodyParam {
82
+ body: {
83
+ sessionImageId: string;
84
+ };
85
+ }
86
+ export interface DetectFromSessionImageIdQueryParamProperties {
87
+ /**
88
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. 'detection_03' is recommended since its accuracy is improved on smaller faces (64x64 pixels) and rotated face orientations.
89
+ *
90
+ * Possible values: "detection_01", "detection_02", "detection_03"
91
+ */
92
+ detectionModel?: DetectionModel;
93
+ /**
94
+ * The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.
95
+ *
96
+ * Possible values: "recognition_01", "recognition_02", "recognition_03", "recognition_04"
97
+ */
98
+ recognitionModel?: RecognitionModel;
99
+ /** Return faceIds of the detected faces or not. The default value is true. */
100
+ returnFaceId?: boolean;
101
+ /** Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and time cost. */
102
+ returnFaceAttributes?: FaceAttributeType[];
103
+ /** Return face landmarks of the detected faces or not. The default value is false. */
104
+ returnFaceLandmarks?: boolean;
105
+ /** Return 'recognitionModel' or not. The default value is false. This is only applicable when returnFaceId = true. */
106
+ returnRecognitionModel?: boolean;
107
+ /** The number of seconds for the face ID being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). */
108
+ faceIdTimeToLive?: number;
109
+ }
110
+ export interface DetectFromSessionImageIdQueryParam {
111
+ queryParameters?: DetectFromSessionImageIdQueryParamProperties;
112
+ }
113
+ export interface DetectFromSessionImageIdMediaTypesParam {
114
+ /** The format of the HTTP payload. */
115
+ contentType: "application/json";
116
+ }
117
+ export type DetectFromSessionImageIdParameters = DetectFromSessionImageIdQueryParam & DetectFromSessionImageIdMediaTypesParam & DetectFromSessionImageIdBodyParam & RequestParameters;
65
118
  export interface FindSimilarBodyParam {
66
- body?: {
119
+ body: {
67
120
  faceId: string;
68
121
  maxNumOfCandidatesReturned?: number;
69
122
  mode?: FindSimilarMatchMode;
@@ -72,7 +125,7 @@ export interface FindSimilarBodyParam {
72
125
  }
73
126
  export type FindSimilarParameters = FindSimilarBodyParam & RequestParameters;
74
127
  export interface FindSimilarFromFaceListBodyParam {
75
- body?: {
128
+ body: {
76
129
  faceId: string;
77
130
  maxNumOfCandidatesReturned?: number;
78
131
  mode?: FindSimilarMatchMode;
@@ -81,7 +134,7 @@ export interface FindSimilarFromFaceListBodyParam {
81
134
  }
82
135
  export type FindSimilarFromFaceListParameters = FindSimilarFromFaceListBodyParam & RequestParameters;
83
136
  export interface FindSimilarFromLargeFaceListBodyParam {
84
- body?: {
137
+ body: {
85
138
  faceId: string;
86
139
  maxNumOfCandidatesReturned?: number;
87
140
  mode?: FindSimilarMatchMode;
@@ -90,7 +143,7 @@ export interface FindSimilarFromLargeFaceListBodyParam {
90
143
  }
91
144
  export type FindSimilarFromLargeFaceListParameters = FindSimilarFromLargeFaceListBodyParam & RequestParameters;
92
145
  export interface IdentifyFromPersonGroupBodyParam {
93
- body?: {
146
+ body: {
94
147
  faceIds: string[];
95
148
  personGroupId: string;
96
149
  maxNumOfCandidatesReturned?: number;
@@ -99,7 +152,7 @@ export interface IdentifyFromPersonGroupBodyParam {
99
152
  }
100
153
  export type IdentifyFromPersonGroupParameters = IdentifyFromPersonGroupBodyParam & RequestParameters;
101
154
  export interface IdentifyFromLargePersonGroupBodyParam {
102
- body?: {
155
+ body: {
103
156
  faceIds: string[];
104
157
  largePersonGroupId: string;
105
158
  maxNumOfCandidatesReturned?: number;
@@ -108,7 +161,7 @@ export interface IdentifyFromLargePersonGroupBodyParam {
108
161
  }
109
162
  export type IdentifyFromLargePersonGroupParameters = IdentifyFromLargePersonGroupBodyParam & RequestParameters;
110
163
  export interface IdentifyFromPersonDirectoryBodyParam {
111
- body?: {
164
+ body: {
112
165
  faceIds: string[];
113
166
  personIds: string[];
114
167
  maxNumOfCandidatesReturned?: number;
@@ -117,7 +170,7 @@ export interface IdentifyFromPersonDirectoryBodyParam {
117
170
  }
118
171
  export type IdentifyFromPersonDirectoryParameters = IdentifyFromPersonDirectoryBodyParam & RequestParameters;
119
172
  export interface IdentifyFromDynamicPersonGroupBodyParam {
120
- body?: {
173
+ body: {
121
174
  faceIds: string[];
122
175
  dynamicPersonGroupId: string;
123
176
  maxNumOfCandidatesReturned?: number;
@@ -126,14 +179,14 @@ export interface IdentifyFromDynamicPersonGroupBodyParam {
126
179
  }
127
180
  export type IdentifyFromDynamicPersonGroupParameters = IdentifyFromDynamicPersonGroupBodyParam & RequestParameters;
128
181
  export interface VerifyFaceToFaceBodyParam {
129
- body?: {
182
+ body: {
130
183
  faceId1: string;
131
184
  faceId2: string;
132
185
  };
133
186
  }
134
187
  export type VerifyFaceToFaceParameters = VerifyFaceToFaceBodyParam & RequestParameters;
135
188
  export interface VerifyFromPersonGroupBodyParam {
136
- body?: {
189
+ body: {
137
190
  faceId: string;
138
191
  personGroupId: string;
139
192
  personId: string;
@@ -141,7 +194,7 @@ export interface VerifyFromPersonGroupBodyParam {
141
194
  }
142
195
  export type VerifyFromPersonGroupParameters = VerifyFromPersonGroupBodyParam & RequestParameters;
143
196
  export interface VerifyFromLargePersonGroupBodyParam {
144
- body?: {
197
+ body: {
145
198
  faceId: string;
146
199
  largePersonGroupId: string;
147
200
  personId: string;
@@ -149,84 +202,20 @@ export interface VerifyFromLargePersonGroupBodyParam {
149
202
  }
150
203
  export type VerifyFromLargePersonGroupParameters = VerifyFromLargePersonGroupBodyParam & RequestParameters;
151
204
  export interface VerifyFromPersonDirectoryBodyParam {
152
- body?: {
205
+ body: {
153
206
  faceId: string;
154
207
  personId: string;
155
208
  };
156
209
  }
157
210
  export type VerifyFromPersonDirectoryParameters = VerifyFromPersonDirectoryBodyParam & RequestParameters;
158
211
  export interface GroupBodyParam {
159
- body?: {
212
+ body: {
160
213
  faceIds: string[];
161
214
  };
162
215
  }
163
216
  export type GroupParameters = GroupBodyParam & RequestParameters;
164
- export interface CreateLivenessSessionBodyParam {
165
- body?: CreateLivenessSessionContent;
166
- }
167
- export type CreateLivenessSessionParameters = CreateLivenessSessionBodyParam & RequestParameters;
168
- export type DeleteLivenessSessionParameters = RequestParameters;
169
- export type GetLivenessSessionResultParameters = RequestParameters;
170
- export interface GetLivenessSessionsQueryParamProperties {
171
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
172
- start?: string;
173
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
174
- top?: number;
175
- }
176
- export interface GetLivenessSessionsQueryParam {
177
- queryParameters?: GetLivenessSessionsQueryParamProperties;
178
- }
179
- export type GetLivenessSessionsParameters = GetLivenessSessionsQueryParam & RequestParameters;
180
- export interface GetLivenessSessionAuditEntriesQueryParamProperties {
181
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
182
- start?: string;
183
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
184
- top?: number;
185
- }
186
- export interface GetLivenessSessionAuditEntriesQueryParam {
187
- queryParameters?: GetLivenessSessionAuditEntriesQueryParamProperties;
188
- }
189
- export type GetLivenessSessionAuditEntriesParameters = GetLivenessSessionAuditEntriesQueryParam & RequestParameters;
190
- export interface CreateLivenessWithVerifySessionWithVerifyImageBodyParam {
191
- body?: CreateLivenessWithVerifySessionContent;
192
- }
193
- export interface CreateLivenessWithVerifySessionWithVerifyImageMediaTypesParam {
194
- /** The content type for the operation. Always multipart/form-data for this operation. */
195
- contentType: "multipart/form-data";
196
- }
197
- export type CreateLivenessWithVerifySessionWithVerifyImageParameters = CreateLivenessWithVerifySessionWithVerifyImageMediaTypesParam & CreateLivenessWithVerifySessionWithVerifyImageBodyParam & RequestParameters;
198
- export interface CreateLivenessWithVerifySessionBodyParam {
199
- body?: CreateLivenessSessionContent;
200
- }
201
- export type CreateLivenessWithVerifySessionParameters = CreateLivenessWithVerifySessionBodyParam & RequestParameters;
202
- export type DeleteLivenessWithVerifySessionParameters = RequestParameters;
203
- export type GetLivenessWithVerifySessionResultParameters = RequestParameters;
204
- export interface GetLivenessWithVerifySessionsQueryParamProperties {
205
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
206
- start?: string;
207
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
208
- top?: number;
209
- }
210
- export interface GetLivenessWithVerifySessionsQueryParam {
211
- queryParameters?: GetLivenessWithVerifySessionsQueryParamProperties;
212
- }
213
- export type GetLivenessWithVerifySessionsParameters = GetLivenessWithVerifySessionsQueryParam & RequestParameters;
214
- export interface GetLivenessWithVerifySessionAuditEntriesQueryParamProperties {
215
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
216
- start?: string;
217
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
218
- top?: number;
219
- }
220
- export interface GetLivenessWithVerifySessionAuditEntriesQueryParam {
221
- queryParameters?: GetLivenessWithVerifySessionAuditEntriesQueryParamProperties;
222
- }
223
- export type GetLivenessWithVerifySessionAuditEntriesParameters = GetLivenessWithVerifySessionAuditEntriesQueryParam & RequestParameters;
224
217
  export interface CreateFaceListBodyParam {
225
- body?: {
226
- name: string;
227
- userData?: string;
228
- recognitionModel?: RecognitionModel;
229
- };
218
+ body: CreateCollectionRequest;
230
219
  }
231
220
  export type CreateFaceListParameters = CreateFaceListBodyParam & RequestParameters;
232
221
  export type DeleteFaceListParameters = RequestParameters;
@@ -239,10 +228,7 @@ export interface GetFaceListQueryParam {
239
228
  }
240
229
  export type GetFaceListParameters = GetFaceListQueryParam & RequestParameters;
241
230
  export interface UpdateFaceListBodyParam {
242
- body?: {
243
- name?: string;
244
- userData?: string;
245
- };
231
+ body: UserDefinedFieldsForUpdate;
246
232
  }
247
233
  export type UpdateFaceListParameters = UpdateFaceListBodyParam & RequestParameters;
248
234
  export interface GetFaceListsQueryParamProperties {
@@ -254,14 +240,16 @@ export interface GetFaceListsQueryParam {
254
240
  }
255
241
  export type GetFaceListsParameters = GetFaceListsQueryParam & RequestParameters;
256
242
  export interface AddFaceListFaceFromUrlBodyParam {
257
- body?: {
258
- url: string;
259
- };
243
+ body: AddFaceFromUrlRequest;
260
244
  }
261
245
  export interface AddFaceListFaceFromUrlQueryParamProperties {
262
246
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
263
247
  targetFace?: number[];
264
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
248
+ /**
249
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
250
+ *
251
+ * Possible values: "detection_01", "detection_02", "detection_03"
252
+ */
265
253
  detectionModel?: DetectionModel;
266
254
  /** User-provided data attached to the face. The size limit is 1K. */
267
255
  userData?: string;
@@ -281,7 +269,11 @@ export interface AddFaceListFaceBodyParam {
281
269
  export interface AddFaceListFaceQueryParamProperties {
282
270
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
283
271
  targetFace?: number[];
284
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
272
+ /**
273
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
274
+ *
275
+ * Possible values: "detection_01", "detection_02", "detection_03"
276
+ */
285
277
  detectionModel?: DetectionModel;
286
278
  /** User-provided data attached to the face. The size limit is 1K. */
287
279
  userData?: string;
@@ -296,11 +288,7 @@ export interface AddFaceListFaceMediaTypesParam {
296
288
  export type AddFaceListFaceParameters = AddFaceListFaceQueryParam & AddFaceListFaceMediaTypesParam & AddFaceListFaceBodyParam & RequestParameters;
297
289
  export type DeleteFaceListFaceParameters = RequestParameters;
298
290
  export interface CreateLargeFaceListBodyParam {
299
- body?: {
300
- name: string;
301
- userData?: string;
302
- recognitionModel?: RecognitionModel;
303
- };
291
+ body: CreateCollectionRequest;
304
292
  }
305
293
  export type CreateLargeFaceListParameters = CreateLargeFaceListBodyParam & RequestParameters;
306
294
  export type DeleteLargeFaceListParameters = RequestParameters;
@@ -313,10 +301,7 @@ export interface GetLargeFaceListQueryParam {
313
301
  }
314
302
  export type GetLargeFaceListParameters = GetLargeFaceListQueryParam & RequestParameters;
315
303
  export interface UpdateLargeFaceListBodyParam {
316
- body?: {
317
- name?: string;
318
- userData?: string;
319
- };
304
+ body: UserDefinedFieldsForUpdate;
320
305
  }
321
306
  export type UpdateLargeFaceListParameters = UpdateLargeFaceListBodyParam & RequestParameters;
322
307
  export interface GetLargeFaceListsQueryParamProperties {
@@ -334,14 +319,16 @@ export type GetLargeFaceListsParameters = GetLargeFaceListsQueryParam & RequestP
334
319
  export type GetLargeFaceListTrainingStatusParameters = RequestParameters;
335
320
  export type TrainLargeFaceListParameters = RequestParameters;
336
321
  export interface AddLargeFaceListFaceFromUrlBodyParam {
337
- body?: {
338
- url: string;
339
- };
322
+ body: AddFaceFromUrlRequest;
340
323
  }
341
324
  export interface AddLargeFaceListFaceFromUrlQueryParamProperties {
342
325
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
343
326
  targetFace?: number[];
344
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
327
+ /**
328
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
329
+ *
330
+ * Possible values: "detection_01", "detection_02", "detection_03"
331
+ */
345
332
  detectionModel?: DetectionModel;
346
333
  /** User-provided data attached to the face. The size limit is 1K. */
347
334
  userData?: string;
@@ -361,7 +348,11 @@ export interface AddLargeFaceListFaceBodyParam {
361
348
  export interface AddLargeFaceListFaceQueryParamProperties {
362
349
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
363
350
  targetFace?: number[];
364
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
351
+ /**
352
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
353
+ *
354
+ * Possible values: "detection_01", "detection_02", "detection_03"
355
+ */
365
356
  detectionModel?: DetectionModel;
366
357
  /** User-provided data attached to the face. The size limit is 1K. */
367
358
  userData?: string;
@@ -377,9 +368,7 @@ export type AddLargeFaceListFaceParameters = AddLargeFaceListFaceQueryParam & Ad
377
368
  export type DeleteLargeFaceListFaceParameters = RequestParameters;
378
369
  export type GetLargeFaceListFaceParameters = RequestParameters;
379
370
  export interface UpdateLargeFaceListFaceBodyParam {
380
- body?: {
381
- userData?: string;
382
- };
371
+ body: FaceUserData;
383
372
  }
384
373
  export type UpdateLargeFaceListFaceParameters = UpdateLargeFaceListFaceBodyParam & RequestParameters;
385
374
  export interface GetLargeFaceListFacesQueryParamProperties {
@@ -392,151 +381,8 @@ export interface GetLargeFaceListFacesQueryParam {
392
381
  queryParameters?: GetLargeFaceListFacesQueryParamProperties;
393
382
  }
394
383
  export type GetLargeFaceListFacesParameters = GetLargeFaceListFacesQueryParam & RequestParameters;
395
- export interface CreatePersonBodyParam {
396
- body?: {
397
- name: string;
398
- userData?: string;
399
- };
400
- }
401
- export type CreatePersonParameters = CreatePersonBodyParam & RequestParameters;
402
- export type DeletePersonParameters = RequestParameters;
403
- export type GetPersonParameters = RequestParameters;
404
- export interface UpdatePersonBodyParam {
405
- body?: {
406
- name?: string;
407
- userData?: string;
408
- };
409
- }
410
- export type UpdatePersonParameters = UpdatePersonBodyParam & RequestParameters;
411
- export interface GetPersonsQueryParamProperties {
412
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
413
- start?: string;
414
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
415
- top?: number;
416
- }
417
- export interface GetPersonsQueryParam {
418
- queryParameters?: GetPersonsQueryParamProperties;
419
- }
420
- export type GetPersonsParameters = GetPersonsQueryParam & RequestParameters;
421
- export interface GetDynamicPersonGroupReferencesQueryParamProperties {
422
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
423
- start?: string;
424
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
425
- top?: number;
426
- }
427
- export interface GetDynamicPersonGroupReferencesQueryParam {
428
- queryParameters?: GetDynamicPersonGroupReferencesQueryParamProperties;
429
- }
430
- export type GetDynamicPersonGroupReferencesParameters = GetDynamicPersonGroupReferencesQueryParam & RequestParameters;
431
- export interface AddPersonFaceBodyParam {
432
- /**
433
- * The image to be analyzed
434
- *
435
- * Value may contain any sequence of octets
436
- */
437
- body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream;
438
- }
439
- export interface AddPersonFaceQueryParamProperties {
440
- /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
441
- targetFace?: number[];
442
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
443
- detectionModel?: DetectionModel;
444
- /** User-provided data attached to the face. The size limit is 1K. */
445
- userData?: string;
446
- }
447
- export interface AddPersonFaceQueryParam {
448
- queryParameters?: AddPersonFaceQueryParamProperties;
449
- }
450
- export interface AddPersonFaceMediaTypesParam {
451
- /** The format of the HTTP payload. */
452
- contentType: "application/octet-stream";
453
- }
454
- export type AddPersonFaceParameters = AddPersonFaceQueryParam & AddPersonFaceMediaTypesParam & AddPersonFaceBodyParam & RequestParameters;
455
- export interface AddPersonFaceFromUrlBodyParam {
456
- body?: {
457
- url: string;
458
- };
459
- }
460
- export interface AddPersonFaceFromUrlQueryParamProperties {
461
- /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
462
- targetFace?: number[];
463
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
464
- detectionModel?: DetectionModel;
465
- /** User-provided data attached to the face. The size limit is 1K. */
466
- userData?: string;
467
- }
468
- export interface AddPersonFaceFromUrlQueryParam {
469
- queryParameters?: AddPersonFaceFromUrlQueryParamProperties;
470
- }
471
- export type AddPersonFaceFromUrlParameters = AddPersonFaceFromUrlQueryParam & AddPersonFaceFromUrlBodyParam & RequestParameters;
472
- export type DeletePersonFaceParameters = RequestParameters;
473
- export type GetPersonFaceParameters = RequestParameters;
474
- export interface UpdatePersonFaceBodyParam {
475
- body?: {
476
- userData?: string;
477
- };
478
- }
479
- export type UpdatePersonFaceParameters = UpdatePersonFaceBodyParam & RequestParameters;
480
- export type GetPersonFacesParameters = RequestParameters;
481
- export interface CreateDynamicPersonGroupWithPersonBodyParam {
482
- body?: {
483
- name: string;
484
- userData?: string;
485
- addPersonIds: string[];
486
- };
487
- }
488
- export type CreateDynamicPersonGroupWithPersonParameters = CreateDynamicPersonGroupWithPersonBodyParam & RequestParameters;
489
- export interface CreateDynamicPersonGroupBodyParam {
490
- body?: {
491
- name: string;
492
- userData?: string;
493
- };
494
- }
495
- export type CreateDynamicPersonGroupParameters = CreateDynamicPersonGroupBodyParam & RequestParameters;
496
- export type DeleteDynamicPersonGroupParameters = RequestParameters;
497
- export type GetDynamicPersonGroupParameters = RequestParameters;
498
- export interface UpdateDynamicPersonGroupWithPersonChangesBodyParam {
499
- body?: {
500
- name?: string;
501
- userData?: string;
502
- addPersonIds?: string[];
503
- removePersonIds?: string[];
504
- };
505
- }
506
- export type UpdateDynamicPersonGroupWithPersonChangesParameters = UpdateDynamicPersonGroupWithPersonChangesBodyParam & RequestParameters;
507
- export interface UpdateDynamicPersonGroupBodyParam {
508
- body?: {
509
- name?: string;
510
- userData?: string;
511
- };
512
- }
513
- export type UpdateDynamicPersonGroupParameters = UpdateDynamicPersonGroupBodyParam & RequestParameters;
514
- export interface GetDynamicPersonGroupsQueryParamProperties {
515
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
516
- start?: string;
517
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
518
- top?: number;
519
- }
520
- export interface GetDynamicPersonGroupsQueryParam {
521
- queryParameters?: GetDynamicPersonGroupsQueryParamProperties;
522
- }
523
- export type GetDynamicPersonGroupsParameters = GetDynamicPersonGroupsQueryParam & RequestParameters;
524
- export interface GetDynamicPersonGroupPersonsQueryParamProperties {
525
- /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
526
- start?: string;
527
- /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
528
- top?: number;
529
- }
530
- export interface GetDynamicPersonGroupPersonsQueryParam {
531
- queryParameters?: GetDynamicPersonGroupPersonsQueryParamProperties;
532
- }
533
- export type GetDynamicPersonGroupPersonsParameters = GetDynamicPersonGroupPersonsQueryParam & RequestParameters;
534
384
  export interface CreatePersonGroupBodyParam {
535
- body?: {
536
- name: string;
537
- userData?: string;
538
- recognitionModel?: RecognitionModel;
539
- };
385
+ body: CreateCollectionRequest;
540
386
  }
541
387
  export type CreatePersonGroupParameters = CreatePersonGroupBodyParam & RequestParameters;
542
388
  export type DeletePersonGroupParameters = RequestParameters;
@@ -549,10 +395,7 @@ export interface GetPersonGroupQueryParam {
549
395
  }
550
396
  export type GetPersonGroupParameters = GetPersonGroupQueryParam & RequestParameters;
551
397
  export interface UpdatePersonGroupBodyParam {
552
- body?: {
553
- name?: string;
554
- userData?: string;
555
- };
398
+ body: UserDefinedFieldsForUpdate;
556
399
  }
557
400
  export type UpdatePersonGroupParameters = UpdatePersonGroupBodyParam & RequestParameters;
558
401
  export interface GetPersonGroupsQueryParamProperties {
@@ -570,19 +413,13 @@ export type GetPersonGroupsParameters = GetPersonGroupsQueryParam & RequestParam
570
413
  export type GetPersonGroupTrainingStatusParameters = RequestParameters;
571
414
  export type TrainPersonGroupParameters = RequestParameters;
572
415
  export interface CreatePersonGroupPersonBodyParam {
573
- body?: {
574
- name: string;
575
- userData?: string;
576
- };
416
+ body: UserDefinedFields;
577
417
  }
578
418
  export type CreatePersonGroupPersonParameters = CreatePersonGroupPersonBodyParam & RequestParameters;
579
419
  export type DeletePersonGroupPersonParameters = RequestParameters;
580
420
  export type GetPersonGroupPersonParameters = RequestParameters;
581
421
  export interface UpdatePersonGroupPersonBodyParam {
582
- body?: {
583
- name?: string;
584
- userData?: string;
585
- };
422
+ body: UserDefinedFieldsForUpdate;
586
423
  }
587
424
  export type UpdatePersonGroupPersonParameters = UpdatePersonGroupPersonBodyParam & RequestParameters;
588
425
  export interface GetPersonGroupPersonsQueryParamProperties {
@@ -596,14 +433,16 @@ export interface GetPersonGroupPersonsQueryParam {
596
433
  }
597
434
  export type GetPersonGroupPersonsParameters = GetPersonGroupPersonsQueryParam & RequestParameters;
598
435
  export interface AddPersonGroupPersonFaceFromUrlBodyParam {
599
- body?: {
600
- url: string;
601
- };
436
+ body: AddFaceFromUrlRequest;
602
437
  }
603
438
  export interface AddPersonGroupPersonFaceFromUrlQueryParamProperties {
604
439
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
605
440
  targetFace?: number[];
606
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
441
+ /**
442
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
443
+ *
444
+ * Possible values: "detection_01", "detection_02", "detection_03"
445
+ */
607
446
  detectionModel?: DetectionModel;
608
447
  /** User-provided data attached to the face. The size limit is 1K. */
609
448
  userData?: string;
@@ -623,7 +462,11 @@ export interface AddPersonGroupPersonFaceBodyParam {
623
462
  export interface AddPersonGroupPersonFaceQueryParamProperties {
624
463
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
625
464
  targetFace?: number[];
626
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
465
+ /**
466
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
467
+ *
468
+ * Possible values: "detection_01", "detection_02", "detection_03"
469
+ */
627
470
  detectionModel?: DetectionModel;
628
471
  /** User-provided data attached to the face. The size limit is 1K. */
629
472
  userData?: string;
@@ -639,17 +482,11 @@ export type AddPersonGroupPersonFaceParameters = AddPersonGroupPersonFaceQueryPa
639
482
  export type DeletePersonGroupPersonFaceParameters = RequestParameters;
640
483
  export type GetPersonGroupPersonFaceParameters = RequestParameters;
641
484
  export interface UpdatePersonGroupPersonFaceBodyParam {
642
- body?: {
643
- userData?: string;
644
- };
485
+ body: FaceUserData;
645
486
  }
646
487
  export type UpdatePersonGroupPersonFaceParameters = UpdatePersonGroupPersonFaceBodyParam & RequestParameters;
647
488
  export interface CreateLargePersonGroupBodyParam {
648
- body?: {
649
- name: string;
650
- userData?: string;
651
- recognitionModel?: RecognitionModel;
652
- };
489
+ body: CreateCollectionRequest;
653
490
  }
654
491
  export type CreateLargePersonGroupParameters = CreateLargePersonGroupBodyParam & RequestParameters;
655
492
  export type DeleteLargePersonGroupParameters = RequestParameters;
@@ -662,10 +499,7 @@ export interface GetLargePersonGroupQueryParam {
662
499
  }
663
500
  export type GetLargePersonGroupParameters = GetLargePersonGroupQueryParam & RequestParameters;
664
501
  export interface UpdateLargePersonGroupBodyParam {
665
- body?: {
666
- name?: string;
667
- userData?: string;
668
- };
502
+ body: UserDefinedFieldsForUpdate;
669
503
  }
670
504
  export type UpdateLargePersonGroupParameters = UpdateLargePersonGroupBodyParam & RequestParameters;
671
505
  export interface GetLargePersonGroupsQueryParamProperties {
@@ -683,19 +517,13 @@ export type GetLargePersonGroupsParameters = GetLargePersonGroupsQueryParam & Re
683
517
  export type GetLargePersonGroupTrainingStatusParameters = RequestParameters;
684
518
  export type TrainLargePersonGroupParameters = RequestParameters;
685
519
  export interface CreateLargePersonGroupPersonBodyParam {
686
- body?: {
687
- name: string;
688
- userData?: string;
689
- };
520
+ body: UserDefinedFields;
690
521
  }
691
522
  export type CreateLargePersonGroupPersonParameters = CreateLargePersonGroupPersonBodyParam & RequestParameters;
692
523
  export type DeleteLargePersonGroupPersonParameters = RequestParameters;
693
524
  export type GetLargePersonGroupPersonParameters = RequestParameters;
694
525
  export interface UpdateLargePersonGroupPersonBodyParam {
695
- body?: {
696
- name?: string;
697
- userData?: string;
698
- };
526
+ body: UserDefinedFieldsForUpdate;
699
527
  }
700
528
  export type UpdateLargePersonGroupPersonParameters = UpdateLargePersonGroupPersonBodyParam & RequestParameters;
701
529
  export interface GetLargePersonGroupPersonsQueryParamProperties {
@@ -709,14 +537,16 @@ export interface GetLargePersonGroupPersonsQueryParam {
709
537
  }
710
538
  export type GetLargePersonGroupPersonsParameters = GetLargePersonGroupPersonsQueryParam & RequestParameters;
711
539
  export interface AddLargePersonGroupPersonFaceFromUrlBodyParam {
712
- body?: {
713
- url: string;
714
- };
540
+ body: AddFaceFromUrlRequest;
715
541
  }
716
542
  export interface AddLargePersonGroupPersonFaceFromUrlQueryParamProperties {
717
543
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
718
544
  targetFace?: number[];
719
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
545
+ /**
546
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
547
+ *
548
+ * Possible values: "detection_01", "detection_02", "detection_03"
549
+ */
720
550
  detectionModel?: DetectionModel;
721
551
  /** User-provided data attached to the face. The size limit is 1K. */
722
552
  userData?: string;
@@ -736,7 +566,11 @@ export interface AddLargePersonGroupPersonFaceBodyParam {
736
566
  export interface AddLargePersonGroupPersonFaceQueryParamProperties {
737
567
  /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
738
568
  targetFace?: number[];
739
- /** The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. */
569
+ /**
570
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
571
+ *
572
+ * Possible values: "detection_01", "detection_02", "detection_03"
573
+ */
740
574
  detectionModel?: DetectionModel;
741
575
  /** User-provided data attached to the face. The size limit is 1K. */
742
576
  userData?: string;
@@ -752,9 +586,204 @@ export type AddLargePersonGroupPersonFaceParameters = AddLargePersonGroupPersonF
752
586
  export type DeleteLargePersonGroupPersonFaceParameters = RequestParameters;
753
587
  export type GetLargePersonGroupPersonFaceParameters = RequestParameters;
754
588
  export interface UpdateLargePersonGroupPersonFaceBodyParam {
755
- body?: {
589
+ body: FaceUserData;
590
+ }
591
+ export type UpdateLargePersonGroupPersonFaceParameters = UpdateLargePersonGroupPersonFaceBodyParam & RequestParameters;
592
+ export interface CreateLivenessSessionBodyParam {
593
+ /** Body parameter. */
594
+ body: CreateLivenessSessionContent;
595
+ }
596
+ export type CreateLivenessSessionParameters = CreateLivenessSessionBodyParam & RequestParameters;
597
+ export type DeleteLivenessSessionParameters = RequestParameters;
598
+ export type GetLivenessSessionResultParameters = RequestParameters;
599
+ export interface GetLivenessSessionsQueryParamProperties {
600
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
601
+ start?: string;
602
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
603
+ top?: number;
604
+ }
605
+ export interface GetLivenessSessionsQueryParam {
606
+ queryParameters?: GetLivenessSessionsQueryParamProperties;
607
+ }
608
+ export type GetLivenessSessionsParameters = GetLivenessSessionsQueryParam & RequestParameters;
609
+ export interface GetLivenessSessionAuditEntriesQueryParamProperties {
610
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
611
+ start?: string;
612
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
613
+ top?: number;
614
+ }
615
+ export interface GetLivenessSessionAuditEntriesQueryParam {
616
+ queryParameters?: GetLivenessSessionAuditEntriesQueryParamProperties;
617
+ }
618
+ export type GetLivenessSessionAuditEntriesParameters = GetLivenessSessionAuditEntriesQueryParam & RequestParameters;
619
+ export interface CreateLivenessWithVerifySessionWithVerifyImageBodyParam {
620
+ /** Request content of liveness with verify session creation. */
621
+ body: CreateLivenessWithVerifySessionMultipartContent;
622
+ }
623
+ export interface CreateLivenessWithVerifySessionWithVerifyImageMediaTypesParam {
624
+ /** The content type for the operation. Always multipart/form-data for this operation. */
625
+ contentType: "multipart/form-data";
626
+ }
627
+ export type CreateLivenessWithVerifySessionWithVerifyImageParameters = CreateLivenessWithVerifySessionWithVerifyImageMediaTypesParam & CreateLivenessWithVerifySessionWithVerifyImageBodyParam & RequestParameters;
628
+ export interface CreateLivenessWithVerifySessionBodyParam {
629
+ /** Body parameter. */
630
+ body: CreateLivenessWithVerifySessionJsonContent;
631
+ }
632
+ export type CreateLivenessWithVerifySessionParameters = CreateLivenessWithVerifySessionBodyParam & RequestParameters;
633
+ export type DeleteLivenessWithVerifySessionParameters = RequestParameters;
634
+ export type GetLivenessWithVerifySessionResultParameters = RequestParameters;
635
+ export interface GetLivenessWithVerifySessionsQueryParamProperties {
636
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
637
+ start?: string;
638
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
639
+ top?: number;
640
+ }
641
+ export interface GetLivenessWithVerifySessionsQueryParam {
642
+ queryParameters?: GetLivenessWithVerifySessionsQueryParamProperties;
643
+ }
644
+ export type GetLivenessWithVerifySessionsParameters = GetLivenessWithVerifySessionsQueryParam & RequestParameters;
645
+ export interface GetLivenessWithVerifySessionAuditEntriesQueryParamProperties {
646
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
647
+ start?: string;
648
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
649
+ top?: number;
650
+ }
651
+ export interface GetLivenessWithVerifySessionAuditEntriesQueryParam {
652
+ queryParameters?: GetLivenessWithVerifySessionAuditEntriesQueryParamProperties;
653
+ }
654
+ export type GetLivenessWithVerifySessionAuditEntriesParameters = GetLivenessWithVerifySessionAuditEntriesQueryParam & RequestParameters;
655
+ export type GetSessionImageParameters = RequestParameters;
656
+ export interface CreatePersonBodyParam {
657
+ body: UserDefinedFields;
658
+ }
659
+ export type CreatePersonParameters = CreatePersonBodyParam & RequestParameters;
660
+ export type DeletePersonParameters = RequestParameters;
661
+ export type GetPersonParameters = RequestParameters;
662
+ export interface UpdatePersonBodyParam {
663
+ body: UserDefinedFieldsForUpdate;
664
+ }
665
+ export type UpdatePersonParameters = UpdatePersonBodyParam & RequestParameters;
666
+ export interface GetPersonsQueryParamProperties {
667
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
668
+ start?: string;
669
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
670
+ top?: number;
671
+ }
672
+ export interface GetPersonsQueryParam {
673
+ queryParameters?: GetPersonsQueryParamProperties;
674
+ }
675
+ export type GetPersonsParameters = GetPersonsQueryParam & RequestParameters;
676
+ export interface GetDynamicPersonGroupReferencesQueryParamProperties {
677
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
678
+ start?: string;
679
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
680
+ top?: number;
681
+ }
682
+ export interface GetDynamicPersonGroupReferencesQueryParam {
683
+ queryParameters?: GetDynamicPersonGroupReferencesQueryParamProperties;
684
+ }
685
+ export type GetDynamicPersonGroupReferencesParameters = GetDynamicPersonGroupReferencesQueryParam & RequestParameters;
686
+ export interface AddPersonFaceBodyParam {
687
+ /**
688
+ * The image to be analyzed
689
+ *
690
+ * Value may contain any sequence of octets
691
+ */
692
+ body: string | Uint8Array | ReadableStream<Uint8Array> | NodeJS.ReadableStream;
693
+ }
694
+ export interface AddPersonFaceQueryParamProperties {
695
+ /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
696
+ targetFace?: number[];
697
+ /**
698
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
699
+ *
700
+ * Possible values: "detection_01", "detection_02", "detection_03"
701
+ */
702
+ detectionModel?: DetectionModel;
703
+ /** User-provided data attached to the face. The size limit is 1K. */
704
+ userData?: string;
705
+ }
706
+ export interface AddPersonFaceQueryParam {
707
+ queryParameters?: AddPersonFaceQueryParamProperties;
708
+ }
709
+ export interface AddPersonFaceMediaTypesParam {
710
+ /** The format of the HTTP payload. */
711
+ contentType: "application/octet-stream";
712
+ }
713
+ export type AddPersonFaceParameters = AddPersonFaceQueryParam & AddPersonFaceMediaTypesParam & AddPersonFaceBodyParam & RequestParameters;
714
+ export interface AddPersonFaceFromUrlBodyParam {
715
+ body: {
716
+ url: string;
717
+ };
718
+ }
719
+ export interface AddPersonFaceFromUrlQueryParamProperties {
720
+ /** A face rectangle to specify the target face to be added to a person, in the format of 'targetFace=left,top,width,height'. */
721
+ targetFace?: number[];
722
+ /**
723
+ * The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.
724
+ *
725
+ * Possible values: "detection_01", "detection_02", "detection_03"
726
+ */
727
+ detectionModel?: DetectionModel;
728
+ /** User-provided data attached to the face. The size limit is 1K. */
729
+ userData?: string;
730
+ }
731
+ export interface AddPersonFaceFromUrlQueryParam {
732
+ queryParameters?: AddPersonFaceFromUrlQueryParamProperties;
733
+ }
734
+ export type AddPersonFaceFromUrlParameters = AddPersonFaceFromUrlQueryParam & AddPersonFaceFromUrlBodyParam & RequestParameters;
735
+ export type DeletePersonFaceParameters = RequestParameters;
736
+ export type GetPersonFaceParameters = RequestParameters;
737
+ export interface UpdatePersonFaceBodyParam {
738
+ body: FaceUserData;
739
+ }
740
+ export type UpdatePersonFaceParameters = UpdatePersonFaceBodyParam & RequestParameters;
741
+ export type GetPersonFacesParameters = RequestParameters;
742
+ export interface CreateDynamicPersonGroupWithPersonBodyParam {
743
+ body: {
744
+ name: string;
756
745
  userData?: string;
746
+ addPersonIds: string[];
757
747
  };
758
748
  }
759
- export type UpdateLargePersonGroupPersonFaceParameters = UpdateLargePersonGroupPersonFaceBodyParam & RequestParameters;
749
+ export type CreateDynamicPersonGroupWithPersonParameters = CreateDynamicPersonGroupWithPersonBodyParam & RequestParameters;
750
+ export interface CreateDynamicPersonGroupBodyParam {
751
+ body: UserDefinedFields;
752
+ }
753
+ export type CreateDynamicPersonGroupParameters = CreateDynamicPersonGroupBodyParam & RequestParameters;
754
+ export type DeleteDynamicPersonGroupParameters = RequestParameters;
755
+ export type GetDynamicPersonGroupParameters = RequestParameters;
756
+ export interface UpdateDynamicPersonGroupWithPersonChangesBodyParam {
757
+ body: {
758
+ name?: string;
759
+ userData?: string;
760
+ addPersonIds?: string[];
761
+ removePersonIds?: string[];
762
+ };
763
+ }
764
+ export type UpdateDynamicPersonGroupWithPersonChangesParameters = UpdateDynamicPersonGroupWithPersonChangesBodyParam & RequestParameters;
765
+ export interface UpdateDynamicPersonGroupBodyParam {
766
+ body: UserDefinedFieldsForUpdate;
767
+ }
768
+ export type UpdateDynamicPersonGroupParameters = UpdateDynamicPersonGroupBodyParam & RequestParameters;
769
+ export interface GetDynamicPersonGroupsQueryParamProperties {
770
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
771
+ start?: string;
772
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
773
+ top?: number;
774
+ }
775
+ export interface GetDynamicPersonGroupsQueryParam {
776
+ queryParameters?: GetDynamicPersonGroupsQueryParamProperties;
777
+ }
778
+ export type GetDynamicPersonGroupsParameters = GetDynamicPersonGroupsQueryParam & RequestParameters;
779
+ export interface GetDynamicPersonGroupPersonsQueryParamProperties {
780
+ /** List resources greater than the "start". It contains no more than 64 characters. Default is empty. */
781
+ start?: string;
782
+ /** The number of items to list, ranging in [1, 1000]. Default is 1000. */
783
+ top?: number;
784
+ }
785
+ export interface GetDynamicPersonGroupPersonsQueryParam {
786
+ queryParameters?: GetDynamicPersonGroupPersonsQueryParamProperties;
787
+ }
788
+ export type GetDynamicPersonGroupPersonsParameters = GetDynamicPersonGroupPersonsQueryParam & RequestParameters;
760
789
  //# sourceMappingURL=parameters.d.ts.map