-
Notifications
You must be signed in to change notification settings - Fork 256
/
CommonGramTokenFilter.xml
197 lines (197 loc) · 11.3 KB
/
CommonGramTokenFilter.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="CommonGramTokenFilter" FullName="Microsoft.Azure.Search.Models.CommonGramTokenFilter">
<TypeSignature Language="C#" Value="public class CommonGramTokenFilter : Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CommonGramTokenFilter extends Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.CommonGramTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class CommonGramTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type CommonGramTokenFilter = 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.CommonGramTokenFilter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.CommonGramTokenFilter")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Construct bigrams for frequently occurring terms while indexing. Single
terms are still indexed too, with bigrams overlaid. This token filter
is implemented using Apache Lucene.
<see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommonGramTokenFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.CommonGramTokenFilter.#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 CommonGramTokenFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommonGramTokenFilter (string name, System.Collections.Generic.IList<string> commonWords, bool? ignoreCase = default, bool? useQueryMode = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class System.Collections.Generic.IList`1<string> commonWords, valuetype System.Nullable`1<bool> ignoreCase, valuetype System.Nullable`1<bool> useQueryMode) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.CommonGramTokenFilter.#ctor(System.String,System.Collections.Generic.IList{System.String},System.Nullable{System.Boolean},System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, commonWords As IList(Of String), Optional ignoreCase As Nullable(Of Boolean) = Nothing, Optional useQueryMode As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.CommonGramTokenFilter : string * System.Collections.Generic.IList<string> * Nullable<bool> * Nullable<bool> -> Microsoft.Azure.Search.Models.CommonGramTokenFilter" Usage="new Microsoft.Azure.Search.Models.CommonGramTokenFilter (name, commonWords, ignoreCase, useQueryMode)" />
<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="commonWords" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="ignoreCase" Type="System.Nullable<System.Boolean>" />
<Parameter Name="useQueryMode" 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="commonWords">The set of common words.</param>
<param name="ignoreCase">A value indicating whether common words
matching will be case insensitive. Default is false.</param>
<param name="useQueryMode">A value that indicates whether the token
filter is in query mode. When in query mode, the token filter
generates bigrams and then removes common words and single terms
followed by a common word. Default is false.</param>
<summary>
Initializes a new instance of the CommonGramTokenFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CommonWords">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> CommonWords { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> CommonWords" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.CommonGramTokenFilter.CommonWords" />
<MemberSignature Language="VB.NET" Value="Public Property CommonWords As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.CommonWords : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.CommonGramTokenFilter.CommonWords" />
<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="commonWords")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="commonWords")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the set of common words.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IgnoreCase">
<MemberSignature Language="C#" Value="public bool? IgnoreCase { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IgnoreCase" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.CommonGramTokenFilter.IgnoreCase" />
<MemberSignature Language="VB.NET" Value="Public Property IgnoreCase As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IgnoreCase : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.CommonGramTokenFilter.IgnoreCase" />
<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="ignoreCase")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="ignoreCase")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether common words matching will
be case insensitive. Default is false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseQueryMode">
<MemberSignature Language="C#" Value="public bool? UseQueryMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> UseQueryMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.CommonGramTokenFilter.UseQueryMode" />
<MemberSignature Language="VB.NET" Value="Public Property UseQueryMode As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.UseQueryMode : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.CommonGramTokenFilter.UseQueryMode" />
<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="queryMode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="queryMode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that indicates whether the token filter is in
query mode. When in query mode, the token filter generates bigrams
and then removes common words and single terms followed by a common
word. 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.CommonGramTokenFilter.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="commonGramTokenFilter.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>