-
Notifications
You must be signed in to change notification settings - Fork 257
/
PersonGroupOperations.xml
532 lines (530 loc) · 42.9 KB
/
PersonGroupOperations.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
<Type Name="PersonGroupOperations" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations">
<TypeSignature Language="C#" Value="public class PersonGroupOperations : Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations, Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PersonGroupOperations extends System.Object implements class Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations, class Microsoft.Rest.IServiceOperations`1<class Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations" />
<TypeSignature Language="VB.NET" Value="Public Class PersonGroupOperations
Implements IPersonGroupOperations, IServiceOperations(Of FaceClient)" />
<TypeSignature Language="F#" Value="type PersonGroupOperations = class
 interface IServiceOperations<FaceClient>
 interface IPersonGroupOperations" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.7.0.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
PersonGroupOperations operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PersonGroupOperations (Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient client);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.#ctor(Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (client As FaceClient)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations : Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient -> Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations" Usage="new Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations client" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="client" Type="Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient" />
</Parameters>
<Docs>
<param name="client">
Reference to the service client.
</param>
<summary>
Initializes a new instance of the PersonGroupOperations class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient Client { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient Client" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.Client" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Client As FaceClient" />
<MemberSignature Language="F#" Value="member this.Client : Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.Client" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.CognitiveServices.Vision.Face.FaceClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a reference to the FaceClient
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> CreateWithHttpMessagesAsync (string personGroupId, string name, string userData = default, string recognitionModel = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse> CreateWithHttpMessagesAsync(string personGroupId, string name, string userData, string recognitionModel, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.CreateWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateWithHttpMessagesAsync (personGroupId As String, name As String, Optional userData As String = Nothing, Optional recognitionModel As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)" />
<MemberSignature Language="F#" Value="abstract member CreateWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.CreateWithHttpMessagesAsync : string * string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="personGroupOperations.CreateWithHttpMessagesAsync (personGroupId, name, userData, recognitionModel, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.CreateWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="recognitionModel" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="personGroupId">
Id referencing a particular person group.
</param>
<param name="name">
User defined name, maximum length is 128.
</param>
<param name="userData">
User specified data. Length should not exceed 16KB.
</param>
<param name="recognitionModel">
Possible values include: 'recognition_01', 'recognition_02'
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Create a new person group with specified personGroupId, name, user-provided
userData and recognitionModel.
<br /> A person group is the container of the uploaded person data,
including face images and face recognition features.
<br /> After creation, use [PersonGroup Person -
Create](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523c)
to add persons into the group, and then call [PersonGroup -
Train](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249)
to get this group ready for [Face -
Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
<br /> The person's face, image, and userData will be stored on
server until [PersonGroup Person -
Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523d)
or [PersonGroup -
Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395245)
is called.
<br />
* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000
persons.
* S0-tier subscription quota: 1,000,000 person groups. Each holds up to
10,000 persons.
* to handle larger scale face identification problem, please consider using
[LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d).
<br />
'recognitionModel' should be specified to associate with this person group.
The default value for 'recognitionModel' is 'recognition_01', if the latest
model needed, please explicitly specify the model you need in this
parameter. New faces that are added to an existing person group will use
the recognition model that's already associated with the collection.
Existing face features in a person group can't be updated to features
extracted by another version of recognition model.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="DeleteWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> DeleteWithHttpMessagesAsync (string personGroupId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse> DeleteWithHttpMessagesAsync(string personGroupId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.DeleteWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeleteWithHttpMessagesAsync (personGroupId As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)" />
<MemberSignature Language="F#" Value="abstract member DeleteWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.DeleteWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="personGroupOperations.DeleteWithHttpMessagesAsync (personGroupId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.DeleteWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="personGroupId">
Id referencing a particular person group.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Delete an existing person group. Persisted face features of all people in
the person group will also be deleted.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="GetTrainingStatusWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus>> GetTrainingStatusWithHttpMessagesAsync (string personGroupId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus>> GetTrainingStatusWithHttpMessagesAsync(string personGroupId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.GetTrainingStatusWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetTrainingStatusWithHttpMessagesAsync (personGroupId As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of TrainingStatus))" />
<MemberSignature Language="F#" Value="abstract member GetTrainingStatusWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus>>
override this.GetTrainingStatusWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus>>" Usage="personGroupOperations.GetTrainingStatusWithHttpMessagesAsync (personGroupId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.GetTrainingStatusWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="personGroupId">
Id referencing a particular person group.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve the training status of a person group (completed or ongoing).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="GetWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>> GetWithHttpMessagesAsync (string personGroupId, bool? returnRecognitionModel = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>> GetWithHttpMessagesAsync(string personGroupId, valuetype System.Nullable`1<bool> returnRecognitionModel, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.GetWithHttpMessagesAsync(System.String,System.Nullable{System.Boolean},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetWithHttpMessagesAsync (personGroupId As String, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of PersonGroup))" />
<MemberSignature Language="F#" Value="abstract member GetWithHttpMessagesAsync : string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>
override this.GetWithHttpMessagesAsync : string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>" Usage="personGroupOperations.GetWithHttpMessagesAsync (personGroupId, returnRecognitionModel, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.GetWithHttpMessagesAsync(System.String,System.Nullable{System.Boolean},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="personGroupId">
Id referencing a particular person group.
</param>
<param name="returnRecognitionModel">
A value indicating whether the operation should return 'recognitionModel'
in response.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve person group name, userData and recognitionModel. To get person
information under this personGroup, use [PersonGroup Person -
List](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395241).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="ListWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>> ListWithHttpMessagesAsync (string start = default, int? top = 1000, bool? returnRecognitionModel = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>> ListWithHttpMessagesAsync(string start, valuetype System.Nullable`1<int32> top, valuetype System.Nullable`1<bool> returnRecognitionModel, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.ListWithHttpMessagesAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ListWithHttpMessagesAsync (Optional start As String = Nothing, Optional top As Nullable(Of Integer) = 1000, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of IList(Of PersonGroup)))" />
<MemberSignature Language="F#" Value="abstract member ListWithHttpMessagesAsync : string * Nullable<int> * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>>
override this.ListWithHttpMessagesAsync : string * Nullable<int> * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>>" Usage="personGroupOperations.ListWithHttpMessagesAsync (start, top, returnRecognitionModel, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.ListWithHttpMessagesAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersonGroup>>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="start" Type="System.String" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="start">
List person groups from the least personGroupId greater than the "start".
</param>
<param name="top">
The number of person groups to list.
</param>
<param name="returnRecognitionModel">
A value indicating whether the operation should return 'recognitionModel'
in response.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
List person groups’s personGroupId, name, userData and
recognitionModel.<br />
* Person groups are stored in alphabetical order of personGroupId.
* "start" parameter (string, optional) is a user-provided personGroupId
value that returned entries have larger ids by string comparison. "start"
set to empty to indicate return from the first item.
* "top" parameter (int, optional) specifies the number of entries to
return. A maximal of 1000 entries can be returned in one call. To fetch
more, you can specify "start" with the last retuned entry’s Id of the
current call.
<br />
For example, total 5 person groups: "group1", ..., "group5".
<br /> "start=&top=" will return all 5 groups.
<br /> "start=&top=2" will return "group1", "group2".
<br /> "start=group2&top=3" will return "group3", "group4",
"group5".
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="TrainWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> TrainWithHttpMessagesAsync (string personGroupId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse> TrainWithHttpMessagesAsync(string personGroupId, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.TrainWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function TrainWithHttpMessagesAsync (personGroupId As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)" />
<MemberSignature Language="F#" Value="abstract member TrainWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.TrainWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="personGroupOperations.TrainWithHttpMessagesAsync (personGroupId, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.TrainWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="personGroupId">
Id referencing a particular person group.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Queue a person group training task, the training task may not be started
immediately.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
<Member MemberName="UpdateWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> UpdateWithHttpMessagesAsync (string personGroupId, string name = default, string userData = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse> UpdateWithHttpMessagesAsync(string personGroupId, string name, string userData, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.PersonGroupOperations.UpdateWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function UpdateWithHttpMessagesAsync (personGroupId As String, Optional name As String = Nothing, Optional userData As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)" />
<MemberSignature Language="F#" Value="abstract member UpdateWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>
override this.UpdateWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="personGroupOperations.UpdateWithHttpMessagesAsync (personGroupId, name, userData, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Vision.Face.IPersonGroupOperations.UpdateWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="personGroupId">
Id referencing a particular person group.
</param>
<param name="name">
User defined name, maximum length is 128.
</param>
<param name="userData">
User specified data. Length should not exceed 16KB.
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Update an existing person group's display name and userData. The properties
which does not appear in request body will not be updated.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.APIErrorException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
</Members>
</Type>