-
Notifications
You must be signed in to change notification settings - Fork 256
/
SynonymTokenFilter.xml
218 lines (218 loc) · 12.6 KB
/
SynonymTokenFilter.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
<Type Name="SynonymTokenFilter" FullName="Microsoft.Azure.Search.Models.SynonymTokenFilter">
<TypeSignature Language="C#" Value="public class SynonymTokenFilter : Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SynonymTokenFilter extends Microsoft.Azure.Search.Models.TokenFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.SynonymTokenFilter" />
<TypeSignature Language="VB.NET" Value="Public Class SynonymTokenFilter
Inherits TokenFilter" />
<TypeSignature Language="F#" Value="type SynonymTokenFilter = 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.SynonymTokenFilter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.SynonymTokenFilter")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Matches single or multi-word synonyms in a token stream. This token
filter is implemented using Apache Lucene.
<see href="http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SynonymTokenFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SynonymTokenFilter.#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 SynonymTokenFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SynonymTokenFilter (string name, System.Collections.Generic.IList<string> synonyms, bool? ignoreCase = default, bool? expand = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class System.Collections.Generic.IList`1<string> synonyms, valuetype System.Nullable`1<bool> ignoreCase, valuetype System.Nullable`1<bool> expand) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SynonymTokenFilter.#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, synonyms As IList(Of String), Optional ignoreCase As Nullable(Of Boolean) = Nothing, Optional expand As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.SynonymTokenFilter : string * System.Collections.Generic.IList<string> * Nullable<bool> * Nullable<bool> -> Microsoft.Azure.Search.Models.SynonymTokenFilter" Usage="new Microsoft.Azure.Search.Models.SynonymTokenFilter (name, synonyms, ignoreCase, expand)" />
<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="synonyms" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="ignoreCase" Type="System.Nullable<System.Boolean>" />
<Parameter Name="expand" 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="synonyms">A list of synonyms in following one of two
formats: 1. incredible, unbelievable, fabulous => amazing - all
terms on the left side of => symbol will be replaced with all
terms on its right side; 2. incredible, unbelievable, fabulous,
amazing - comma separated list of equivalent words. Set the expand
option to change how this list is interpreted.</param>
<param name="ignoreCase">A value indicating whether to case-fold
input for matching. Default is false.</param>
<param name="expand">A value indicating whether all words in the
list of synonyms (if => notation is not used) will map to one
another. If true, all words in the list of synonyms (if =>
notation is not used) will map to one another. The following list:
incredible, unbelievable, fabulous, amazing is equivalent to:
incredible, unbelievable, fabulous, amazing => incredible,
unbelievable, fabulous, amazing. If false, the following list:
incredible, unbelievable, fabulous, amazing will be equivalent to:
incredible, unbelievable, fabulous, amazing => incredible.
Default is true.</param>
<summary>
Initializes a new instance of the SynonymTokenFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Expand">
<MemberSignature Language="C#" Value="public bool? Expand { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> Expand" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SynonymTokenFilter.Expand" />
<MemberSignature Language="VB.NET" Value="Public Property Expand As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.Expand : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.SynonymTokenFilter.Expand" />
<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="expand")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="expand")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether all words in the list of
synonyms (if =&gt; notation is not used) will map to one
another. If true, all words in the list of synonyms (if =&gt;
notation is not used) will map to one another. The following list:
incredible, unbelievable, fabulous, amazing is equivalent to:
incredible, unbelievable, fabulous, amazing =&gt; incredible,
unbelievable, fabulous, amazing. If false, the following list:
incredible, unbelievable, fabulous, amazing will be equivalent to:
incredible, unbelievable, fabulous, amazing =&gt; incredible.
Default is true.
</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.SynonymTokenFilter.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.SynonymTokenFilter.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 to case-fold input for
matching. Default is false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Synonyms">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> Synonyms { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Synonyms" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SynonymTokenFilter.Synonyms" />
<MemberSignature Language="VB.NET" Value="Public Property Synonyms As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Synonyms : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.SynonymTokenFilter.Synonyms" />
<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="synonyms")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="synonyms")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of synonyms in following one of two formats: 1.
incredible, unbelievable, fabulous =&gt; amazing - all terms on
the left side of =&gt; symbol will be replaced with all terms
on its right side; 2. incredible, unbelievable, fabulous, amazing -
comma separated list of equivalent words. Set the expand option to
change how this list is interpreted.
</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.SynonymTokenFilter.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="synonymTokenFilter.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>