/
IFaceListOperations.xml
421 lines (418 loc) · 35.9 KB
/
IFaceListOperations.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
<Type Name="IFaceListOperations" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.IFaceListOperations">
<TypeSignature Language="C#" Value="public interface IFaceListOperations" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IFaceListOperations" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.IFaceListOperations" />
<TypeSignature Language="VB.NET" Value="Public Interface IFaceListOperations" />
<TypeSignature Language="F#" Value="type IFaceListOperations = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.7.0.0</AssemblyVersion>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
FaceListOperations operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddFaceFromStreamWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>> AddFaceFromStreamWithHttpMessagesAsync (string faceListId, System.IO.Stream image, string userData = default, System.Collections.Generic.IList<int> targetFace = default, string detectionModel = 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`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>> AddFaceFromStreamWithHttpMessagesAsync(string faceListId, class System.IO.Stream image, string userData, class System.Collections.Generic.IList`1<int32> targetFace, string detectionModel, 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.IFaceListOperations.AddFaceFromStreamWithHttpMessagesAsync(System.String,System.IO.Stream,System.String,System.Collections.Generic.IList{System.Int32},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function AddFaceFromStreamWithHttpMessagesAsync (faceListId As String, image As Stream, Optional userData As String = Nothing, Optional targetFace As IList(Of Integer) = Nothing, Optional detectionModel As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of PersistedFace))" />
<MemberSignature Language="F#" Value="abstract member AddFaceFromStreamWithHttpMessagesAsync : string * System.IO.Stream * string * System.Collections.Generic.IList<int> * 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.PersistedFace>>" Usage="iFaceListOperations.AddFaceFromStreamWithHttpMessagesAsync (faceListId, image, userData, targetFace, detectionModel, customHeaders, 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.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" 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="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="faceListId">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="customHeaders">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="AddFaceFromUrlWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>> AddFaceFromUrlWithHttpMessagesAsync (string faceListId, string url, string userData = default, System.Collections.Generic.IList<int> targetFace = default, string detectionModel = 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`1<class Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>> AddFaceFromUrlWithHttpMessagesAsync(string faceListId, string url, string userData, class System.Collections.Generic.IList`1<int32> targetFace, string detectionModel, 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.IFaceListOperations.AddFaceFromUrlWithHttpMessagesAsync(System.String,System.String,System.String,System.Collections.Generic.IList{System.Int32},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function AddFaceFromUrlWithHttpMessagesAsync (faceListId As String, url As String, Optional userData As String = Nothing, Optional targetFace As IList(Of Integer) = Nothing, Optional detectionModel As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of PersistedFace))" />
<MemberSignature Language="F#" Value="abstract member AddFaceFromUrlWithHttpMessagesAsync : string * string * string * System.Collections.Generic.IList<int> * 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.PersistedFace>>" Usage="iFaceListOperations.AddFaceFromUrlWithHttpMessagesAsync (faceListId, url, userData, targetFace, detectionModel, customHeaders, 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.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.PersistedFace>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" 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="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="faceListId">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="customHeaders">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="CreateWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> CreateWithHttpMessagesAsync (string faceListId, 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 faceListId, 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.IFaceListOperations.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 (faceListId 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>" Usage="iFaceListOperations.CreateWithHttpMessagesAsync (faceListId, name, userData, recognitionModel, customHeaders, 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.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" 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="faceListId">
Id referencing a particular 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="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Create an empty face list with user-specified faceListId, name, an
optional userData and recognitionModel. Up to 64 face lists are
allowed in one subscription.
<br /> Face list is a list of faces, up to 1,000 faces, and
used by [Face - Find
Similar](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237).
<br /> After creation, user should use [FaceList - Add
Face](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395250)
to import the faces. Faces are stored on server until [FaceList -
Delete](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524f)
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 /> Please consider
[LargeFaceList](/docs/services/563879b61984550e40cbbe8d/operations/5a157b68d2de3616c086f2cc)
when the face number is large. It can support up to 1,000,000
faces. 'recognitionModel' should be specified to associate with
this 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 face list will use the recognition model
that's already associated with the collection. Existing face
features in a 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>
<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>
</Docs>
</Member>
<Member MemberName="DeleteFaceWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> DeleteFaceWithHttpMessagesAsync (string faceListId, Guid persistedFaceId, 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> DeleteFaceWithHttpMessagesAsync(string faceListId, valuetype System.Guid persistedFaceId, 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.IFaceListOperations.DeleteFaceWithHttpMessagesAsync(System.String,System.Guid,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function DeleteFaceWithHttpMessagesAsync (faceListId As String, persistedFaceId As Guid, 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 DeleteFaceWithHttpMessagesAsync : string * Guid * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>" Usage="iFaceListOperations.DeleteFaceWithHttpMessagesAsync (faceListId, persistedFaceId, customHeaders, 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.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" Type="System.String" />
<Parameter Name="persistedFaceId" Type="System.Guid" />
<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="faceListId">
Id referencing a particular face list.
</param>
<param name="persistedFaceId">
Id referencing a particular persistedFaceId of an existing face.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Delete an existing face from a face list (given by a
persistedFaceId and a faceListId). Persisted image related to the
face 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>
</Docs>
</Member>
<Member MemberName="DeleteWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> DeleteWithHttpMessagesAsync (string faceListId, 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 faceListId, 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.IFaceListOperations.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 (faceListId 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>" Usage="iFaceListOperations.DeleteWithHttpMessagesAsync (faceListId, customHeaders, 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.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" 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="faceListId">
Id referencing a particular face list.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Delete an existing face list according to faceListId. Persisted
face images in the face list 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>
</Docs>
</Member>
<Member MemberName="GetWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList>> GetWithHttpMessagesAsync (string faceListId, 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.FaceList>> GetWithHttpMessagesAsync(string faceListId, 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.IFaceListOperations.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 (faceListId 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 FaceList))" />
<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.FaceList>>" Usage="iFaceListOperations.GetWithHttpMessagesAsync (faceListId, returnRecognitionModel, customHeaders, 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.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" 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="faceListId">
Id referencing a particular face list.
</param>
<param name="returnRecognitionModel">
A value indicating whether the operation should return
'recognitionModel' in response.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Retrieve a face list’s faceListId, name, userData, recognitionModel
and faces in the face list.
</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>
</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.FaceList>>> ListWithHttpMessagesAsync (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.FaceList>>> ListWithHttpMessagesAsync(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.IFaceListOperations.ListWithHttpMessagesAsync(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 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 FaceList)))" />
<MemberSignature Language="F#" Value="abstract member ListWithHttpMessagesAsync : 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.FaceList>>>" Usage="iFaceListOperations.ListWithHttpMessagesAsync (returnRecognitionModel, customHeaders, 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.Rest.HttpOperationResponse<System.Collections.Generic.IList<Microsoft.Azure.CognitiveServices.Vision.Face.Models.FaceList>>></ReturnType>
</ReturnValue>
<Parameters>
<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="returnRecognitionModel">
A value indicating whether the operation should return
'recognitionModel' in response.
</param>
<param name="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
List face lists’ faceListId, name, userData and recognitionModel.
<br />
To get face information inside faceList use [FaceList -
Get](/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c)
</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>
</Docs>
</Member>
<Member MemberName="UpdateWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> UpdateWithHttpMessagesAsync (string faceListId, 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 faceListId, 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.IFaceListOperations.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 (faceListId 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>" Usage="iFaceListOperations.UpdateWithHttpMessagesAsync (faceListId, name, userData, customHeaders, 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.Rest.HttpOperationResponse></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="faceListId" 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="faceListId">
Id referencing a particular 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="customHeaders">
The headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Update information of a face list.
</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>
</Docs>
</Member>
</Members>
</Type>