-
Notifications
You must be signed in to change notification settings - Fork 256
/
DictionaryDecompounderTokenFilter.xml
261 lines (261 loc) · 15.4 KB
/
DictionaryDecompounderTokenFilter.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
<Type Name="DictionaryDecompounderTokenFilter" FullName="Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter">
<TypeSignature Language="C#" Value="public class DictionaryDecompounderTokenFilter : Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DictionaryDecompounderTokenFilter extends Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class DictionaryDecompounderTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type DictionaryDecompounderTokenFilter = class
 inherit TokenFilter" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Search.Models.TokenFilter</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Decomposes compound words found in many Germanic languages. This token
filter is implemented using Apache Lucene.
<see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DictionaryDecompounderTokenFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the DictionaryDecompounderTokenFilter
class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DictionaryDecompounderTokenFilter (string name, System.Collections.Generic.IList<string> wordList, int? minWordSize = default, int? minSubwordSize = default, int? maxSubwordSize = default, bool? onlyLongestMatch = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class System.Collections.Generic.IList`1<string> wordList, valuetype System.Nullable`1<int32> minWordSize, valuetype System.Nullable`1<int32> minSubwordSize, valuetype System.Nullable`1<int32> maxSubwordSize, valuetype System.Nullable`1<bool> onlyLongestMatch) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, wordList As IList(Of String), Optional minWordSize As Nullable(Of Integer) = Nothing, Optional minSubwordSize As Nullable(Of Integer) = Nothing, Optional maxSubwordSize As Nullable(Of Integer) = Nothing, Optional onlyLongestMatch As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter : string * System.Collections.Generic.IList<string> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> -> Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter" Usage="new Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter (name, wordList, minWordSize, minSubwordSize, maxSubwordSize, onlyLongestMatch)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="wordList" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="minWordSize" Type="System.Nullable<System.Int32>" />
<Parameter Name="minSubwordSize" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxSubwordSize" Type="System.Nullable<System.Int32>" />
<Parameter Name="onlyLongestMatch" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="name">The name of the token filter. It must only
contain letters, digits, spaces, dashes or underscores, can only
start and end with alphanumeric characters, and is limited to 128
characters.</param>
<param name="wordList">The list of words to match against.</param>
<param name="minWordSize">The minimum word size. Only words longer
than this get processed. Default is 5. Maximum is 300.</param>
<param name="minSubwordSize">The minimum subword size. Only
subwords longer than this are outputted. Default is 2. Maximum is
300.</param>
<param name="maxSubwordSize">The maximum subword size. Only
subwords shorter than this are outputted. Default is 15. Maximum is
300.</param>
<param name="onlyLongestMatch">A value indicating whether to add
only the longest matching subword to the output. Default is
false.</param>
<summary>
Initializes a new instance of the DictionaryDecompounderTokenFilter
class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxSubwordSize">
<MemberSignature Language="C#" Value="public int? MaxSubwordSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxSubwordSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MaxSubwordSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxSubwordSize As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxSubwordSize : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MaxSubwordSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxSubwordSize")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxSubwordSize")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum subword size. Only subwords shorter than
this are outputted. Default is 15. Maximum is 300.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinSubwordSize">
<MemberSignature Language="C#" Value="public int? MinSubwordSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MinSubwordSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MinSubwordSize" />
<MemberSignature Language="VB.NET" Value="Public Property MinSubwordSize As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MinSubwordSize : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MinSubwordSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="minSubwordSize")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="minSubwordSize")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the minimum subword size. Only subwords longer than
this are outputted. Default is 2. Maximum is 300.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinWordSize">
<MemberSignature Language="C#" Value="public int? MinWordSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MinWordSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MinWordSize" />
<MemberSignature Language="VB.NET" Value="Public Property MinWordSize As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MinWordSize : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.MinWordSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="minWordSize")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="minWordSize")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the minimum word size. Only words longer than this get
processed. Default is 5. Maximum is 300.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnlyLongestMatch">
<MemberSignature Language="C#" Value="public bool? OnlyLongestMatch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> OnlyLongestMatch" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.OnlyLongestMatch" />
<MemberSignature Language="VB.NET" Value="Public Property OnlyLongestMatch As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.OnlyLongestMatch : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.OnlyLongestMatch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="onlyLongestMatch")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="onlyLongestMatch")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether to add only the longest
matching subword to the output. Default is false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="dictionaryDecompounderTokenFilter.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.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>
<Member MemberName="WordList">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> WordList { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> WordList" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.WordList" />
<MemberSignature Language="VB.NET" Value="Public Property WordList As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.WordList : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.DictionaryDecompounderTokenFilter.WordList" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="wordList")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="wordList")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of words to match against.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>