-
Notifications
You must be signed in to change notification settings - Fork 254
/
CommonGramTokenFilter.xml
115 lines (115 loc) · 7.44 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
<Type Name="CommonGramTokenFilter" FullName="Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter">
<TypeSignature Language="C#" Value="public class CommonGramTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CommonGramTokenFilter extends Azure.Search.Documents.Indexes.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class CommonGramTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type CommonGramTokenFilter = 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> 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. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommonGramTokenFilter (string name, System.Collections.Generic.IEnumerable<string> commonWords);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class System.Collections.Generic.IEnumerable`1<string> commonWords) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, commonWords As IEnumerable(Of String))" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter : string * seq<string> -> Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter" Usage="new Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter (name, commonWords)" />
<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" />
<Parameter Name="commonWords" Type="System.Collections.Generic.IEnumerable<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="commonWords"> The set of common words. </param>
<summary> Initializes a new instance of <see cref="T:Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter" />. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> or <paramref name="commonWords" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CommonWords">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> CommonWords { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> CommonWords" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter.CommonWords" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CommonWords As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.CommonWords : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter.CommonWords" />
<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> 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:Azure.Search.Documents.Indexes.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="Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter.IgnoreCase" />
<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 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:Azure.Search.Documents.Indexes.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="Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter.UseQueryMode" />
<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 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>
</Members>
</Type>