-
Notifications
You must be signed in to change notification settings - Fork 256
/
WordDelimiterTokenFilter.xml
260 lines (260 loc) · 16.3 KB
/
WordDelimiterTokenFilter.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
<Type Name="WordDelimiterTokenFilter" FullName="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter">
<TypeSignature Language="C#" Value="public class WordDelimiterTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WordDelimiterTokenFilter extends Azure.Search.Documents.Indexes.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class WordDelimiterTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type WordDelimiterTokenFilter = class
 inherit TokenFilter" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.2.0.0</AssemblyVersion>
<AssemblyVersion>11.2.1.0</AssemblyVersion>
<AssemblyVersion>11.3.0.0</AssemblyVersion>
<AssemblyVersion>11.4.0.0</AssemblyVersion>
<AssemblyVersion>11.5.0.0</AssemblyVersion>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Search.Documents.Indexes.Models.TokenFilter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WordDelimiterTokenFilter (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter : string -> Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter" Usage="new Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter name" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
</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>
<summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CatenateAll">
<MemberSignature Language="C#" Value="public bool? CatenateAll { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> CatenateAll" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.CatenateAll" />
<MemberSignature Language="VB.NET" Value="Public Property CatenateAll As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.CatenateAll : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.CatenateAll" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether all subword parts will be catenated. For example, if this is set to true, "Azure-Search-1" becomes "AzureSearch1". Default is false. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CatenateNumbers">
<MemberSignature Language="C#" Value="public bool? CatenateNumbers { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> CatenateNumbers" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.CatenateNumbers" />
<MemberSignature Language="VB.NET" Value="Public Property CatenateNumbers As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.CatenateNumbers : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.CatenateNumbers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, "1-2" becomes "12". Default is false. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CatenateWords">
<MemberSignature Language="C#" Value="public bool? CatenateWords { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> CatenateWords" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.CatenateWords" />
<MemberSignature Language="VB.NET" Value="Public Property CatenateWords As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.CatenateWords : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.CatenateWords" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, "Azure-Search" becomes "AzureSearch". Default is false. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateNumberParts">
<MemberSignature Language="C#" Value="public bool? GenerateNumberParts { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> GenerateNumberParts" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.GenerateNumberParts" />
<MemberSignature Language="VB.NET" Value="Public Property GenerateNumberParts As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.GenerateNumberParts : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.GenerateNumberParts" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether to generate number subwords. Default is true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateWordParts">
<MemberSignature Language="C#" Value="public bool? GenerateWordParts { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> GenerateWordParts" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.GenerateWordParts" />
<MemberSignature Language="VB.NET" Value="Public Property GenerateWordParts As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.GenerateWordParts : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.GenerateWordParts" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether to generate part words. If set, causes parts of words to be generated; for example "AzureSearch" becomes "Azure" "Search". Default is true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PreserveOriginal">
<MemberSignature Language="C#" Value="public bool? PreserveOriginal { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> PreserveOriginal" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.PreserveOriginal" />
<MemberSignature Language="VB.NET" Value="Public Property PreserveOriginal As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.PreserveOriginal : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.PreserveOriginal" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether original words will be preserved and added to the subword list. Default is false. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProtectedWords">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> ProtectedWords { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> ProtectedWords" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.ProtectedWords" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ProtectedWords As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.ProtectedWords : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.ProtectedWords" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary> A list of tokens to protect from being delimited. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SplitOnCaseChange">
<MemberSignature Language="C#" Value="public bool? SplitOnCaseChange { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> SplitOnCaseChange" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.SplitOnCaseChange" />
<MemberSignature Language="VB.NET" Value="Public Property SplitOnCaseChange As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.SplitOnCaseChange : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.SplitOnCaseChange" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether to split words on caseChange. For example, if this is set to true, "AzureSearch" becomes "Azure" "Search". Default is true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SplitOnNumerics">
<MemberSignature Language="C#" Value="public bool? SplitOnNumerics { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> SplitOnNumerics" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.SplitOnNumerics" />
<MemberSignature Language="VB.NET" Value="Public Property SplitOnNumerics As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.SplitOnNumerics : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.SplitOnNumerics" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether to split on numbers. For example, if this is set to true, "Azure1Search" becomes "Azure" "1" "Search". Default is true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StemEnglishPossessive">
<MemberSignature Language="C#" Value="public bool? StemEnglishPossessive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> StemEnglishPossessive" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.StemEnglishPossessive" />
<MemberSignature Language="VB.NET" Value="Public Property StemEnglishPossessive As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.StemEnglishPossessive : Nullable<bool> with get, set" Usage="Azure.Search.Documents.Indexes.Models.WordDelimiterTokenFilter.StemEnglishPossessive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether to remove trailing "'s" for each subword. Default is true. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>