-
Notifications
You must be signed in to change notification settings - Fork 260
/
LargeFaceListOperationsExtensions.xml
578 lines (577 loc) · 47.2 KB
/
LargeFaceListOperationsExtensions.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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
<Type Name="LargeFaceListOperationsExtensions" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions">
<TypeSignature Language="C#" Value="public static class LargeFaceListOperationsExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit LargeFaceListOperationsExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module LargeFaceListOperationsExtensions" />
<TypeSignature Language="F#" Value="type LargeFaceListOperationsExtensions = class" />
<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 />
<Docs>
<summary>
Extension methods for LargeFaceListOperations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddFaceFromStreamAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace> AddFaceFromStreamAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, System.IO.Stream image, string userData = default, System.Collections.Generic.IList<int> targetFace = default, string detectionModel = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace> AddFaceFromStreamAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, class System.IO.Stream image, string userData, class System.Collections.Generic.IList`1<int32> targetFace, string detectionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.AddFaceFromStreamAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.IO.Stream,System.String,System.Collections.Generic.IList{System.Int32},System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFaceFromStreamAsync (operations As ILargeFaceListOperations, largeFaceListId As String, image As Stream, Optional userData As String = Nothing, Optional targetFace As IList(Of Integer) = Nothing, Optional detectionModel As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PersistedFace)" />
<MemberSignature Language="F#" Value="static member AddFaceFromStreamAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * System.IO.Stream * string * System.Collections.Generic.IList<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.AddFaceFromStreamAsync (operations, largeFaceListId, image, userData, targetFace, detectionModel, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="image" Type="System.IO.Stream" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="targetFace" Type="System.Collections.Generic.IList<System.Int32>" />
<Parameter Name="detectionModel" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">To be added.</param>
<param name="largeFaceListId">To be added.</param>
<param name="image">To be added.</param>
<param name="userData">To be added.</param>
<param name="targetFace">To be added.</param>
<param name="detectionModel">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddFaceFromUrlAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace> AddFaceFromUrlAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string url, string userData = default, System.Collections.Generic.IList<int> targetFace = default, string detectionModel = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace> AddFaceFromUrlAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string url, string userData, class System.Collections.Generic.IList`1<int32> targetFace, string detectionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.AddFaceFromUrlAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.String,System.String,System.Collections.Generic.IList{System.Int32},System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddFaceFromUrlAsync (operations As ILargeFaceListOperations, largeFaceListId As String, url As String, Optional userData As String = Nothing, Optional targetFace As IList(Of Integer) = Nothing, Optional detectionModel As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PersistedFace)" />
<MemberSignature Language="F#" Value="static member AddFaceFromUrlAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * string * string * System.Collections.Generic.IList<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.AddFaceFromUrlAsync (operations, largeFaceListId, url, userData, targetFace, detectionModel, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="url" Type="System.String" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="targetFace" Type="System.Collections.Generic.IList<System.Int32>" />
<Parameter Name="detectionModel" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">To be added.</param>
<param name="largeFaceListId">To be added.</param>
<param name="url">To be added.</param>
<param name="userData">To be added.</param>
<param name="targetFace">To be added.</param>
<param name="detectionModel">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task CreateAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string name, string userData = default, string recognitionModel = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task CreateAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string name, string userData, string recognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.CreateAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function CreateAsync (operations As ILargeFaceListOperations, largeFaceListId As String, name As String, Optional userData As String = Nothing, Optional recognitionModel As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member CreateAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.CreateAsync (operations, largeFaceListId, name, userData, recognitionModel, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="recognitionModel" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</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="cancellationToken">
The cancellation token.
</param>
<summary>
Create an empty large face list with user-specified largeFaceListId, name,
an optional userData and recognitionModel.
<br /> Large face list is a list of faces, up to 1,000,000 faces, and
used by [Face - Find
Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
<br /> After creation, user should use [LargeFaceList Face -
Add](/docs/services/563879b61984550e40cbbe8d/operations/5a158c10d2de3616c086f2d3)
to import the faces and [LargeFaceList -
Train](/docs/services/563879b61984550e40cbbe8d/operations/5a158422d2de3616c086f2d1)
to make it ready for [Face -
FindSimilar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
Faces are stored on server until [LargeFaceList -
Delete](/docs/services/563879b61984550e40cbbe8d/operations/5a1580d5d2de3616c086f2cd)
is called.
<br /> Find Similar is used for scenario like finding celebrity-like
faces, similar face filtering, or as a light way face identification. But
if the actual use is to identify person, please use
[PersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395244)
/
[LargePersonGroup](/docs/services/563879b61984550e40cbbe8d/operations/599acdee6ac60f11b48b5a9d)
and [Face -
Identify](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239).
<br />
* Free-tier subscription quota: 64 large face lists.
* S0-tier subscription quota: 1,000,000 large face lists.
<br />
'recognitionModel' should be specified to associate with this large face
list. 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 large face list will use
the recognition model that's already associated with the collection.
Existing face features in a large face list can't be updated to features
extracted by another version of recognition model.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task DeleteAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task DeleteAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.DeleteAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DeleteAsync (operations As ILargeFaceListOperations, largeFaceListId As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member DeleteAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.DeleteAsync (operations, largeFaceListId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Delete an existing large face list according to faceListId. Persisted face
images in the large face list will also be deleted.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeleteFaceAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task DeleteFaceAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, Guid persistedFaceId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task DeleteFaceAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Guid persistedFaceId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.DeleteFaceAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Guid,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DeleteFaceAsync (operations As ILargeFaceListOperations, largeFaceListId As String, persistedFaceId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member DeleteFaceAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.DeleteFaceAsync (operations, largeFaceListId, persistedFaceId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="persistedFaceId" Type="System.Guid" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="persistedFaceId">
Id referencing a particular persistedFaceId of an existing face.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Delete an existing face from a large face list (given by a persistedFaceId
and a largeFaceListId). Persisted image related to the face will also be
deleted.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList> GetAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, bool? returnRecognitionModel = False, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList> GetAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Nullable`1<bool> returnRecognitionModel, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.GetAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetAsync (operations As ILargeFaceListOperations, largeFaceListId As String, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional cancellationToken As CancellationToken = Nothing) As Task(Of LargeFaceList)" />
<MemberSignature Language="F#" Value="static member GetAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.GetAsync (operations, largeFaceListId, returnRecognitionModel, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="returnRecognitionModel">
A value indicating whether the operation should return 'recognitionModel'
in response.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve a large face list’s largeFaceListId, name, userData and
recognitionModel.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetFaceAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace> GetFaceAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, Guid persistedFaceId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace> GetFaceAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Guid persistedFaceId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.GetFaceAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Guid,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetFaceAsync (operations As ILargeFaceListOperations, largeFaceListId As String, persistedFaceId As Guid, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PersistedFace)" />
<MemberSignature Language="F#" Value="static member GetFaceAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * Guid * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.GetFaceAsync (operations, largeFaceListId, persistedFaceId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="persistedFaceId" Type="System.Guid" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="persistedFaceId">
Id referencing a particular persistedFaceId of an existing face.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve information about a persisted face (specified by persistedFaceId
and its belonging largeFaceListId).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTrainingStatusAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus> GetTrainingStatusAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus> GetTrainingStatusAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.GetTrainingStatusAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetTrainingStatusAsync (operations As ILargeFaceListOperations, largeFaceListId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TrainingStatus)" />
<MemberSignature Language="F#" Value="static member GetTrainingStatusAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.GetTrainingStatusAsync (operations, largeFaceListId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Vision.Face.Models.TrainingStatus></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve the training status of a large face list (completed or ongoing).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList>> ListAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, bool? returnRecognitionModel = False, string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList>> ListAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, valuetype System.Nullable`1<bool> returnRecognitionModel, string start, valuetype System.Nullable`1<int32> top, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.ListAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.Nullable{System.Boolean},System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ListAsync (operations As ILargeFaceListOperations, Optional returnRecognitionModel As Nullable(Of Boolean) = False, Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of LargeFaceList))" />
<MemberSignature Language="F#" Value="static member ListAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * Nullable<bool> * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList>>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.ListAsync (operations, returnRecognitionModel, start, top, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.LargeFaceList>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="returnRecognitionModel" Type="System.Nullable<System.Boolean>" />
<Parameter Name="start" Type="System.String" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">To be added.</param>
<param name="returnRecognitionModel">To be added.</param>
<param name="start">To be added.</param>
<param name="top">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListFacesAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>> ListFacesAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string start = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>> ListFacesAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string start, valuetype System.Nullable`1<int32> top, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.ListFacesAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ListFacesAsync (operations As ILargeFaceListOperations, largeFaceListId As String, Optional start As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of PersistedFace))" />
<MemberSignature Language="F#" Value="static member ListFacesAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>>" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.ListFacesAsync (operations, largeFaceListId, start, top, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="start" Type="System.String" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="start">
Starting face id to return (used to list a range of faces).
</param>
<param name="top">
Number of faces to return starting with the face id indicated by the
'start' parameter.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
List all faces in a large face list, and retrieve face information
(including userData and persistedFaceIds of registered faces of the face).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrainAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task TrainAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task TrainAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.TrainAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function TrainAsync (operations As ILargeFaceListOperations, largeFaceListId As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member TrainAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.TrainAsync (operations, largeFaceListId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Queue a large face list training task, the training task may not be started
immediately.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task UpdateAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string name = default, string userData = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task UpdateAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, string name, string userData, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.UpdateAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UpdateAsync (operations As ILargeFaceListOperations, largeFaceListId As String, Optional name As String = Nothing, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member UpdateAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.UpdateAsync (operations, largeFaceListId, name, userData, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</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="cancellationToken">
The cancellation token.
</param>
<summary>
Update information of a large face list.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateFaceAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task UpdateFaceAsync (this Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, Guid persistedFaceId, string userData = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task UpdateFaceAsync(class Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations operations, string largeFaceListId, valuetype System.Guid persistedFaceId, string userData, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.UpdateFaceAsync(Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations,System.String,System.Guid,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function UpdateFaceAsync (operations As ILargeFaceListOperations, largeFaceListId As String, persistedFaceId As Guid, Optional userData As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member UpdateFaceAsync : Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations * string * Guid * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.LargeFaceListOperationsExtensions.UpdateFaceAsync (operations, largeFaceListId, persistedFaceId, userData, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Vision.Face.ILargeFaceListOperations" RefType="this" />
<Parameter Name="largeFaceListId" Type="System.String" />
<Parameter Name="persistedFaceId" Type="System.Guid" />
<Parameter Name="userData" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="largeFaceListId">
Id referencing a particular large face list.
</param>
<param name="persistedFaceId">
Id referencing a particular persistedFaceId of an existing face.
</param>
<param name="userData">
User-provided data attached to the face. The size limit is 1KB.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Update a persisted face's userData field.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>