-
Notifications
You must be signed in to change notification settings - Fork 256
/
EdgeNGramTokenFilterV2.xml
197 lines (197 loc) · 11.2 KB
/
EdgeNGramTokenFilterV2.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
<Type Name="EdgeNGramTokenFilterV2" FullName="Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2">
<TypeSignature Language="C#" Value="public class EdgeNGramTokenFilterV2 : Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EdgeNGramTokenFilterV2 extends Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2" />
<TypeSignature Language="VB.NET" Value="Public Class EdgeNGramTokenFilterV2
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type EdgeNGramTokenFilterV2 = 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.EdgeNGramTokenFilterV2")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.EdgeNGramTokenFilterV2")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Generates n-grams of the given size(s) starting from the front or the
back of an input 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/ngram/EdgeNGramTokenFilter.html" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EdgeNGramTokenFilterV2 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.#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 EdgeNGramTokenFilterV2 class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EdgeNGramTokenFilterV2 (string name, int? minGram = default, int? maxGram = default, Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide? side = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype System.Nullable`1<int32> minGram, valuetype System.Nullable`1<int32> maxGram, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide> side) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.#ctor(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional minGram As Nullable(Of Integer) = Nothing, Optional maxGram As Nullable(Of Integer) = Nothing, Optional side As Nullable(Of EdgeNGramTokenFilterSide) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2 : string * Nullable<int> * Nullable<int> * Nullable<Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide> -> Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2" Usage="new Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2 (name, minGram, maxGram, side)" />
<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="minGram" Type="System.Nullable<System.Int32>" />
<Parameter Name="maxGram" Type="System.Nullable<System.Int32>" />
<Parameter Name="side" Type="System.Nullable<Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide>" />
</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="minGram">The minimum n-gram length. Default is 1.
Maximum is 300. Must be less than the value of maxGram.</param>
<param name="maxGram">The maximum n-gram length. Default is 2.
Maximum is 300.</param>
<param name="side">Specifies which side of the input the n-gram
should be generated from. Default is "front". Possible values
include: 'front', 'back'</param>
<summary>
Initializes a new instance of the EdgeNGramTokenFilterV2 class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxGram">
<MemberSignature Language="C#" Value="public int? MaxGram { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxGram" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.MaxGram" />
<MemberSignature Language="VB.NET" Value="Public Property MaxGram As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxGram : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.MaxGram" />
<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="maxGram")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxGram")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum n-gram length. Default is 2. Maximum is
300.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinGram">
<MemberSignature Language="C#" Value="public int? MinGram { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MinGram" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.MinGram" />
<MemberSignature Language="VB.NET" Value="Public Property MinGram As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MinGram : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.MinGram" />
<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="minGram")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="minGram")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the minimum n-gram length. Default is 1. Maximum is
300. Must be less than the value of maxGram.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Side">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide? Side { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide> Side" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.Side" />
<MemberSignature Language="VB.NET" Value="Public Property Side As Nullable(Of EdgeNGramTokenFilterSide)" />
<MemberSignature Language="F#" Value="member this.Side : Nullable<Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide> with get, set" Usage="Microsoft.Azure.Search.Models.EdgeNGramTokenFilterV2.Side" />
<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="side")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="side")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.EdgeNGramTokenFilterSide></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets specifies which side of the input the n-gram should be
generated from. Default is "front". Possible values include:
'front', 'back'
</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.EdgeNGramTokenFilterV2.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="edgeNGramTokenFilterV2.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>