-
Notifications
You must be signed in to change notification settings - Fork 256
/
CustomAnalyzer.xml
218 lines (218 loc) · 13.4 KB
/
CustomAnalyzer.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="CustomAnalyzer" FullName="Microsoft.Azure.Search.Models.CustomAnalyzer">
<TypeSignature Language="C#" Value="public class CustomAnalyzer : Microsoft.Azure.Search.Models.Analyzer" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CustomAnalyzer extends Microsoft.Azure.Search.Models.Analyzer" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.CustomAnalyzer" />
<TypeSignature Language="VB.NET" Value="Public Class CustomAnalyzer
Inherits Analyzer" />
<TypeSignature Language="F#" Value="type CustomAnalyzer = class
 inherit Analyzer" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Search.Models.Analyzer</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.CustomAnalyzer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.CustomAnalyzer")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Allows you to take control over the process of converting text into
indexable/searchable tokens. It's a user-defined configuration
consisting of a single predefined tokenizer and one or more filters.
The tokenizer is responsible for breaking text into tokens, and the
filters for modifying tokens emitted by the tokenizer.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CustomAnalyzer ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.CustomAnalyzer.#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 CustomAnalyzer class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CustomAnalyzer (string name, Microsoft.Azure.Search.Models.TokenizerName tokenizer, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.TokenFilterName> tokenFilters = default, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.CharFilterName> charFilters = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype Microsoft.Azure.Search.Models.TokenizerName tokenizer, class System.Collections.Generic.IList`1<valuetype Microsoft.Azure.Search.Models.TokenFilterName> tokenFilters, class System.Collections.Generic.IList`1<valuetype Microsoft.Azure.Search.Models.CharFilterName> charFilters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.CustomAnalyzer.#ctor(System.String,Microsoft.Azure.Search.Models.TokenizerName,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.TokenFilterName},System.Collections.Generic.IList{Microsoft.Azure.Search.Models.CharFilterName})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, tokenizer As TokenizerName, Optional tokenFilters As IList(Of TokenFilterName) = Nothing, Optional charFilters As IList(Of CharFilterName) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.CustomAnalyzer : string * Microsoft.Azure.Search.Models.TokenizerName * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.TokenFilterName> * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.CharFilterName> -> Microsoft.Azure.Search.Models.CustomAnalyzer" Usage="new Microsoft.Azure.Search.Models.CustomAnalyzer (name, tokenizer, tokenFilters, charFilters)" />
<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="tokenizer" Type="Microsoft.Azure.Search.Models.TokenizerName" />
<Parameter Name="tokenFilters" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.TokenFilterName>" />
<Parameter Name="charFilters" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.CharFilterName>" />
</Parameters>
<Docs>
<param name="name">The name of the analyzer. 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="tokenizer">The name of the tokenizer to use to divide
continuous text into a sequence of tokens, such as breaking a
sentence into words. Possible values include: 'classic',
'edgeNGram', 'keyword_v2', 'letter', 'lowercase',
'microsoft_language_tokenizer',
'microsoft_language_stemming_tokenizer', 'nGram',
'path_hierarchy_v2', 'pattern', 'standard_v2', 'uax_url_email',
'whitespace'</param>
<param name="tokenFilters">A list of token filters used to filter
out or modify the tokens generated by a tokenizer. For example, you
can specify a lowercase filter that converts all characters to
lowercase. The filters are run in the order in which they are
listed.</param>
<param name="charFilters">A list of character filters used to
prepare input text before it is processed by the tokenizer. For
instance, they can replace certain characters or symbols. The
filters are run in the order in which they are listed.</param>
<summary>
Initializes a new instance of the CustomAnalyzer class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CharFilters">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Search.Models.CharFilterName> CharFilters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<valuetype Microsoft.Azure.Search.Models.CharFilterName> CharFilters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.CustomAnalyzer.CharFilters" />
<MemberSignature Language="VB.NET" Value="Public Property CharFilters As IList(Of CharFilterName)" />
<MemberSignature Language="F#" Value="member this.CharFilters : System.Collections.Generic.IList<Microsoft.Azure.Search.Models.CharFilterName> with get, set" Usage="Microsoft.Azure.Search.Models.CustomAnalyzer.CharFilters" />
<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="charFilters")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="charFilters")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Search.Models.CharFilterName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of character filters used to prepare input text
before it is processed by the tokenizer. For instance, they can
replace certain characters or symbols. The filters are run in the
order in which they are listed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenFilters">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Search.Models.TokenFilterName> TokenFilters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<valuetype Microsoft.Azure.Search.Models.TokenFilterName> TokenFilters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.CustomAnalyzer.TokenFilters" />
<MemberSignature Language="VB.NET" Value="Public Property TokenFilters As IList(Of TokenFilterName)" />
<MemberSignature Language="F#" Value="member this.TokenFilters : System.Collections.Generic.IList<Microsoft.Azure.Search.Models.TokenFilterName> with get, set" Usage="Microsoft.Azure.Search.Models.CustomAnalyzer.TokenFilters" />
<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="tokenFilters")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="tokenFilters")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Search.Models.TokenFilterName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of token filters used to filter out or modify
the tokens generated by a tokenizer. For example, you can specify a
lowercase filter that converts all characters to lowercase. The
filters are run in the order in which they are listed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Tokenizer">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.TokenizerName Tokenizer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Search.Models.TokenizerName Tokenizer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.CustomAnalyzer.Tokenizer" />
<MemberSignature Language="VB.NET" Value="Public Property Tokenizer As TokenizerName" />
<MemberSignature Language="F#" Value="member this.Tokenizer : Microsoft.Azure.Search.Models.TokenizerName with get, set" Usage="Microsoft.Azure.Search.Models.CustomAnalyzer.Tokenizer" />
<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="tokenizer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="tokenizer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.TokenizerName</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the tokenizer to use to divide continuous
text into a sequence of tokens, such as breaking a sentence into
words. Possible values include: 'classic', 'edgeNGram',
'keyword_v2', 'letter', 'lowercase',
'microsoft_language_tokenizer',
'microsoft_language_stemming_tokenizer', 'nGram',
'path_hierarchy_v2', 'pattern', 'standard_v2', 'uax_url_email',
'whitespace'
</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.CustomAnalyzer.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="customAnalyzer.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>