-
Notifications
You must be signed in to change notification settings - Fork 256
/
EdgeNGramTokenFilter.xml
117 lines (117 loc) · 6.84 KB
/
EdgeNGramTokenFilter.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
<Type Name="EdgeNGramTokenFilter" FullName="Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter">
<TypeSignature Language="C#" Value="public class EdgeNGramTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EdgeNGramTokenFilter extends Azure.Search.Documents.Indexes.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class EdgeNGramTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type EdgeNGramTokenFilter = 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> 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. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EdgeNGramTokenFilter (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.EdgeNGramTokenFilter.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter : string -> Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter" Usage="new Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter 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 EdgeNGramTokenFilter. </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:Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter.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="Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter.MaxGram" />
<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.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum n-gram length. Default is 2.
</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:Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter.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="Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter.MinGram" />
<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.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The minimum n-gram length. Default is 1. 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 Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilterSide? Side { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilterSide> Side" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter.Side" />
<MemberSignature Language="VB.NET" Value="Public Property Side As Nullable(Of EdgeNGramTokenFilterSide)" />
<MemberSignature Language="F#" Value="member this.Side : Nullable<Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilterSide> with get, set" Usage="Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilter.Side" />
<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<Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilterSide></ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies which side of the input the n-gram should be generated from. Default is <see cref="F:Azure.Search.Documents.Indexes.Models.EdgeNGramTokenFilterSide.Front" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>