-
Notifications
You must be signed in to change notification settings - Fork 256
/
PatternMatchingEntity.xml
272 lines (272 loc) · 18.5 KB
/
PatternMatchingEntity.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
<Type Name="PatternMatchingEntity" FullName="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity">
<TypeSignature Language="C#" Value="public class PatternMatchingEntity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PatternMatchingEntity extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity" />
<TypeSignature Language="VB.NET" Value="Public Class PatternMatchingEntity" />
<TypeSignature Language="F#" Value="type PatternMatchingEntity = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.20.0.28</AssemblyVersion>
<AssemblyVersion>1.21.0.28</AssemblyVersion>
<AssemblyVersion>1.22.0.28</AssemblyVersion>
<AssemblyVersion>1.23.0.28</AssemblyVersion>
<AssemblyVersion>1.24.0.28</AssemblyVersion>
<AssemblyVersion>1.24.1.28</AssemblyVersion>
<AssemblyVersion>1.25.1.26</AssemblyVersion>
<AssemblyVersion>1.27.0.28</AssemblyVersion>
<AssemblyVersion>1.28.0.28</AssemblyVersion>
<AssemblyVersion>1.30.0.28</AssemblyVersion>
<AssemblyVersion>1.31.0.28</AssemblyVersion>
<AssemblyVersion>1.32.1.28</AssemblyVersion>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a pattern matching entity used for intent recognition.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected PatternMatchingEntity (string entityId, Microsoft.CognitiveServices.Speech.Intent.EntityType type, Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode mode = Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode.Basic, System.Collections.Generic.IEnumerable<string> phrases = default);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string entityId, valuetype Microsoft.CognitiveServices.Speech.Intent.EntityType type, valuetype Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode mode, class System.Collections.Generic.IEnumerable`1<string> phrases) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.#ctor(System.String,Microsoft.CognitiveServices.Speech.Intent.EntityType,Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode,System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (entityId As String, type As EntityType, Optional mode As EntityMatchMode = Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode.Basic, Optional phrases As IEnumerable(Of String) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity : string * Microsoft.CognitiveServices.Speech.Intent.EntityType * Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode * seq<string> -> Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity" Usage="new Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity (entityId, type, mode, phrases)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="entityId" Type="System.String" />
<Parameter Name="type" Type="Microsoft.CognitiveServices.Speech.Intent.EntityType" />
<Parameter Name="mode" Type="Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode" />
<Parameter Name="phrases" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="entityId">The entityId.</param>
<param name="type">The EntityType.</param>
<param name="mode">The EntityMatchMode.</param>
<param name="phrases" />
<summary>
Protected constructor that sets the properties with the input parameters.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateAnyEntity">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateAnyEntity (string entityId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateAnyEntity(string entityId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateAnyEntity(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateAnyEntity (entityId As String) As PatternMatchingEntity" />
<MemberSignature Language="F#" Value="static member CreateAnyEntity : string -> Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateAnyEntity entityId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entityId" Type="System.String" />
</Parameters>
<Docs>
<param name="entityId">A string that represents a unique Id for this entity.</param>
<summary>
Creates a pattern matching entity using the specified intent ID.
</summary>
<returns>The Pattern Matching Entity being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateIntegerEntity">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateIntegerEntity (string entityId);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateIntegerEntity(string entityId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateIntegerEntity(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateIntegerEntity (entityId As String) As PatternMatchingEntity" />
<MemberSignature Language="F#" Value="static member CreateIntegerEntity : string -> Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateIntegerEntity entityId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entityId" Type="System.String" />
</Parameters>
<Docs>
<param name="entityId">A string that represents a unique Id for this entity.</param>
<summary>
Creates a pattern matching entity using the specified intent ID. The PrebuiltInteger Entity will match words representing numbers in lexical, digit, and ordinal formats.
</summary>
<returns>The Pattern Matching Entity being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateListEntity">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateListEntity (string entityId, Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode mode, System.Collections.Generic.IEnumerable<string> phrases);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateListEntity(string entityId, valuetype Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode mode, class System.Collections.Generic.IEnumerable`1<string> phrases) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateListEntity(System.String,Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode,System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateListEntity (entityId As String, mode As EntityMatchMode, phrases As IEnumerable(Of String)) As PatternMatchingEntity" />
<MemberSignature Language="F#" Value="static member CreateListEntity : string * Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode * seq<string> -> Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateListEntity (entityId, mode, phrases)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entityId" Type="System.String" />
<Parameter Name="mode" Type="Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode" />
<Parameter Name="phrases" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="entityId">A string that represents a unique Id for this entity.</param>
<param name="mode">The EntityMatchMode for the List entity. Strict means the captured entity must appear in the phrases list.</param>
<param name="phrases">A list of phrases used to match the list entity.</param>
<summary>
Creates a pattern matching entity using the specified intent ID, EntityMatchMode, phrases. This entity type will match based on the phrases provided.
</summary>
<returns>The Pattern Matching Entity being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateListEntity">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateListEntity (string entityId, Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode mode, params string[] phrases);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity CreateListEntity(string entityId, valuetype Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode mode, string[] phrases) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateListEntity(System.String,Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode,System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateListEntity (entityId As String, mode As EntityMatchMode, ParamArray phrases As String()) As PatternMatchingEntity" />
<MemberSignature Language="F#" Value="static member CreateListEntity : string * Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode * string[] -> Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.CreateListEntity (entityId, mode, phrases)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entityId" Type="System.String" />
<Parameter Name="mode" Type="Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode" />
<Parameter Name="phrases" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="entityId">A string that represents a unique Id for this entity.</param>
<param name="mode">The EntityMatchMode for the List entity. Strict means the captured entity must appear in the phrases list.</param>
<param name="phrases">A list of phrases used to match the list entity.</param>
<summary>
Creates a pattern matching entity using the specified intent ID, EntityMatchMode, phrases. This entity type will match based on the phrases provided.
</summary>
<returns>The Pattern Matching Entity being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EntityId">
<MemberSignature Language="C#" Value="public string EntityId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EntityId" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.EntityId" />
<MemberSignature Language="VB.NET" Value="Public Property EntityId As String" />
<MemberSignature Language="F#" Value="member this.EntityId : string with get, set" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.EntityId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
An Id used to define this entity if it is matched. This id must appear in an intent phrase
or the entity will never be matched.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Mode">
<MemberSignature Language="C#" Value="public Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode Mode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode Mode" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.Mode" />
<MemberSignature Language="VB.NET" Value="Public Property Mode As EntityMatchMode" />
<MemberSignature Language="F#" Value="member this.Mode : Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode with get, set" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.Mode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Intent.EntityMatchMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
The EntityMatchMode of this Entity.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Phrases">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> Phrases { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Phrases" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.Phrases" />
<MemberSignature Language="VB.NET" Value="Public Property Phrases As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Phrases : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.Phrases" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
A list of strings used to match the entity for List type entities. Strict Mode means the entity must appear in the list.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Microsoft.CognitiveServices.Speech.Intent.EntityType Type { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.CognitiveServices.Speech.Intent.EntityType Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.Type" />
<MemberSignature Language="VB.NET" Value="Public Property Type As EntityType" />
<MemberSignature Language="F#" Value="member this.Type : Microsoft.CognitiveServices.Speech.Intent.EntityType with get, set" Usage="Microsoft.CognitiveServices.Speech.Intent.PatternMatchingEntity.Type" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Intent.EntityType</ReturnType>
</ReturnValue>
<Docs>
<summary>
The EntityType of this Entity.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>