-
Notifications
You must be signed in to change notification settings - Fork 255
/
ShingleTokenFilter.xml
297 lines (297 loc) · 17 KB
/
ShingleTokenFilter.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
<Type Name="ShingleTokenFilter" FullName="Microsoft.Azure.Search.Models.ShingleTokenFilter">
<TypeSignature Language="C#" Value="public class ShingleTokenFilter : Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ShingleTokenFilter extends Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.ShingleTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class ShingleTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type ShingleTokenFilter = 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.ShingleTokenFilter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.ShingleTokenFilter")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Creates combinations of tokens as a single token. This token filter is
implemented using Apache Lucene.
<see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ShingleTokenFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.ShingleTokenFilter.#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 ShingleTokenFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ShingleTokenFilter (string name, int? maxShingleSize = default, int? minShingleSize = default, bool? outputUnigrams = default, bool? outputUnigramsIfNoShingles = default, string tokenSeparator = default, string filterToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype System.Nullable`1<int32> maxShingleSize, valuetype System.Nullable`1<int32> minShingleSize, valuetype System.Nullable`1<bool> outputUnigrams, valuetype System.Nullable`1<bool> outputUnigramsIfNoShingles, string tokenSeparator, string filterToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.ShingleTokenFilter.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional maxShingleSize As Nullable(Of Integer) = Nothing, Optional minShingleSize As Nullable(Of Integer) = Nothing, Optional outputUnigrams As Nullable(Of Boolean) = Nothing, Optional outputUnigramsIfNoShingles As Nullable(Of Boolean) = Nothing, Optional tokenSeparator As String = Nothing, Optional filterToken As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.ShingleTokenFilter : string * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * string * string -> Microsoft.Azure.Search.Models.ShingleTokenFilter" Usage="new Microsoft.Azure.Search.Models.ShingleTokenFilter (name, maxShingleSize, minShingleSize, outputUnigrams, outputUnigramsIfNoShingles, tokenSeparator, filterToken)" />
<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="maxShingleSize" Type="System.Nullable<System.Int32>" />
<Parameter Name="minShingleSize" Type="System.Nullable<System.Int32>" />
<Parameter Name="outputUnigrams" Type="System.Nullable<System.Boolean>" />
<Parameter Name="outputUnigramsIfNoShingles" Type="System.Nullable<System.Boolean>" />
<Parameter Name="tokenSeparator" Type="System.String" />
<Parameter Name="filterToken" 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>
<param name="maxShingleSize">The maximum shingle size. Default and
minimum value is 2.</param>
<param name="minShingleSize">The minimum shingle size. Default and
minimum value is 2. Must be less than the value of
maxShingleSize.</param>
<param name="outputUnigrams">A value indicating whether the output
stream will contain the input tokens (unigrams) as well as
shingles. Default is true.</param>
<param name="outputUnigramsIfNoShingles">A value indicating whether
to output unigrams for those times when no shingles are available.
This property takes precedence when outputUnigrams is set to false.
Default is false.</param>
<param name="tokenSeparator">The string to use when joining
adjacent tokens to form a shingle. Default is a single space ("
").</param>
<param name="filterToken">The string to insert for each position at
which there is no token. Default is an underscore ("_").</param>
<summary>
Initializes a new instance of the ShingleTokenFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FilterToken">
<MemberSignature Language="C#" Value="public string FilterToken { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FilterToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.FilterToken" />
<MemberSignature Language="VB.NET" Value="Public Property FilterToken As String" />
<MemberSignature Language="F#" Value="member this.FilterToken : string with get, set" Usage="Microsoft.Azure.Search.Models.ShingleTokenFilter.FilterToken" />
<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="filterToken")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="filterToken")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the string to insert for each position at which there
is no token. Default is an underscore ("_").
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxShingleSize">
<MemberSignature Language="C#" Value="public int? MaxShingleSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxShingleSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.MaxShingleSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxShingleSize As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxShingleSize : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.ShingleTokenFilter.MaxShingleSize" />
<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="maxShingleSize")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxShingleSize")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum shingle size. Default and minimum value is
2.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinShingleSize">
<MemberSignature Language="C#" Value="public int? MinShingleSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MinShingleSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.MinShingleSize" />
<MemberSignature Language="VB.NET" Value="Public Property MinShingleSize As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MinShingleSize : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.ShingleTokenFilter.MinShingleSize" />
<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="minShingleSize")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="minShingleSize")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the minimum shingle size. Default and minimum value is
2. Must be less than the value of maxShingleSize.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OutputUnigrams">
<MemberSignature Language="C#" Value="public bool? OutputUnigrams { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> OutputUnigrams" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.OutputUnigrams" />
<MemberSignature Language="VB.NET" Value="Public Property OutputUnigrams As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.OutputUnigrams : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.ShingleTokenFilter.OutputUnigrams" />
<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="outputUnigrams")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="outputUnigrams")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether the output stream will
contain the input tokens (unigrams) as well as shingles. Default is
true.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OutputUnigramsIfNoShingles">
<MemberSignature Language="C#" Value="public bool? OutputUnigramsIfNoShingles { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> OutputUnigramsIfNoShingles" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.OutputUnigramsIfNoShingles" />
<MemberSignature Language="VB.NET" Value="Public Property OutputUnigramsIfNoShingles As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.OutputUnigramsIfNoShingles : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.ShingleTokenFilter.OutputUnigramsIfNoShingles" />
<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="outputUnigramsIfNoShingles")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="outputUnigramsIfNoShingles")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether to output unigrams for
those times when no shingles are available. This property takes
precedence when outputUnigrams is set to false. Default is false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenSeparator">
<MemberSignature Language="C#" Value="public string TokenSeparator { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TokenSeparator" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.ShingleTokenFilter.TokenSeparator" />
<MemberSignature Language="VB.NET" Value="Public Property TokenSeparator As String" />
<MemberSignature Language="F#" Value="member this.TokenSeparator : string with get, set" Usage="Microsoft.Azure.Search.Models.ShingleTokenFilter.TokenSeparator" />
<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="tokenSeparator")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="tokenSeparator")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the string to use when joining adjacent tokens to form
a shingle. Default is a single space (" ").
</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.ShingleTokenFilter.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="shingleTokenFilter.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>
</Members>
</Type>