/
IdentifyRequest.xml
300 lines (300 loc) · 18 KB
/
IdentifyRequest.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
<Type Name="IdentifyRequest" FullName="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest">
<TypeSignature Language="C#" Value="public class IdentifyRequest" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IdentifyRequest extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest" />
<TypeSignature Language="VB.NET" Value="Public Class IdentifyRequest" />
<TypeSignature Language="F#" Value="type IdentifyRequest = 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>
Request body for identify face operation.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IdentifyRequest ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the IdentifyRequest class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IdentifyRequest (System.Collections.Generic.IList<Guid> faceIds, string personGroupId = default, string largePersonGroupId = default, string dynamicPersonGroupId = default, System.Collections.Generic.IList<string> personIds = default, int? maxNumOfCandidatesReturned = default, double? confidenceThreshold = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<valuetype System.Guid> faceIds, string personGroupId, string largePersonGroupId, string dynamicPersonGroupId, class System.Collections.Generic.IList`1<string> personIds, valuetype System.Nullable`1<int32> maxNumOfCandidatesReturned, valuetype System.Nullable`1<float64> confidenceThreshold) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.#ctor(System.Collections.Generic.IList{System.Guid},System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.Nullable{System.Double})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (faceIds As IList(Of Guid), Optional personGroupId As String = Nothing, Optional largePersonGroupId As String = Nothing, Optional dynamicPersonGroupId As String = Nothing, Optional personIds As IList(Of String) = Nothing, Optional maxNumOfCandidatesReturned As Nullable(Of Integer) = Nothing, Optional confidenceThreshold As Nullable(Of Double) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest : System.Collections.Generic.IList<Guid> * string * string * string * System.Collections.Generic.IList<string> * Nullable<int> * Nullable<double> -> Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest" Usage="new Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest (faceIds, personGroupId, largePersonGroupId, dynamicPersonGroupId, personIds, maxNumOfCandidatesReturned, confidenceThreshold)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="faceIds" Type="System.Collections.Generic.IList<System.Guid>" />
<Parameter Name="personGroupId" Type="System.String" />
<Parameter Name="largePersonGroupId" Type="System.String" />
<Parameter Name="dynamicPersonGroupId" Type="System.String" />
<Parameter Name="personIds" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="maxNumOfCandidatesReturned" Type="System.Nullable<System.Int32>" />
<Parameter Name="confidenceThreshold" Type="System.Nullable<System.Double>" />
</Parameters>
<Docs>
<param name="faceIds">To be added.</param>
<param name="personGroupId">To be added.</param>
<param name="largePersonGroupId">To be added.</param>
<param name="dynamicPersonGroupId">To be added.</param>
<param name="personIds">To be added.</param>
<param name="maxNumOfCandidatesReturned">To be added.</param>
<param name="confidenceThreshold">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ConfidenceThreshold">
<MemberSignature Language="C#" Value="public double? ConfidenceThreshold { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> ConfidenceThreshold" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.ConfidenceThreshold" />
<MemberSignature Language="VB.NET" Value="Public Property ConfidenceThreshold As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.ConfidenceThreshold : Nullable<double> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.ConfidenceThreshold" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="confidenceThreshold")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="confidenceThreshold")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets confidence threshold of identification, used to judge
whether one face belong to one person. The range of
confidenceThreshold is [0, 1] (default specified by algorithm).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DynamicPersonGroupId">
<MemberSignature Language="C#" Value="public string DynamicPersonGroupId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DynamicPersonGroupId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.DynamicPersonGroupId" />
<MemberSignature Language="VB.NET" Value="Public Property DynamicPersonGroupId As String" />
<MemberSignature Language="F#" Value="member this.DynamicPersonGroupId : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.DynamicPersonGroupId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="dynamicPersonGroupId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="dynamicPersonGroupId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FaceIds">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Guid> FaceIds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<valuetype System.Guid> FaceIds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.FaceIds" />
<MemberSignature Language="VB.NET" Value="Public Property FaceIds As IList(Of Guid)" />
<MemberSignature Language="F#" Value="member this.FaceIds : System.Collections.Generic.IList<Guid> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.FaceIds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="faceIds")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="faceIds")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Guid></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets array of query faces faceIds, created by the Face -
Detect. Each of the faces are identified independently. The valid
number of faceIds is between [1, 10].
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LargePersonGroupId">
<MemberSignature Language="C#" Value="public string LargePersonGroupId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string LargePersonGroupId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.LargePersonGroupId" />
<MemberSignature Language="VB.NET" Value="Public Property LargePersonGroupId As String" />
<MemberSignature Language="F#" Value="member this.LargePersonGroupId : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.LargePersonGroupId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="largePersonGroupId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="largePersonGroupId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets largePersonGroupId of the target large person group,
created by LargePersonGroup - Create. Parameter personGroupId and
largePersonGroupId should not be provided at the same time.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxNumOfCandidatesReturned">
<MemberSignature Language="C#" Value="public int? MaxNumOfCandidatesReturned { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxNumOfCandidatesReturned" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.MaxNumOfCandidatesReturned" />
<MemberSignature Language="VB.NET" Value="Public Property MaxNumOfCandidatesReturned As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxNumOfCandidatesReturned : Nullable<int> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.MaxNumOfCandidatesReturned" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxNumOfCandidatesReturned")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxNumOfCandidatesReturned")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the range of maxNumOfCandidatesReturned is between 1
and 5 (default is 1).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PersonGroupId">
<MemberSignature Language="C#" Value="public string PersonGroupId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PersonGroupId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.PersonGroupId" />
<MemberSignature Language="VB.NET" Value="Public Property PersonGroupId As String" />
<MemberSignature Language="F#" Value="member this.PersonGroupId : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.PersonGroupId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="personGroupId")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="personGroupId")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets personGroupId of the target person group, created by
PersonGroup - Create. Parameter personGroupId and
largePersonGroupId should not be provided at the same time.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PersonIds">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> PersonIds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> PersonIds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.PersonIds" />
<MemberSignature Language="VB.NET" Value="Public Property PersonIds As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.PersonIds : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.PersonIds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="personIds")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="personIds")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Vision.Face.Models.IdentifyRequest.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="identifyRequest.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Vision.Face</AssemblyName>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>