-
Notifications
You must be signed in to change notification settings - Fork 257
/
AnalyzeRequest.xml
315 lines (315 loc) · 19.7 KB
/
AnalyzeRequest.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
<Type Name="AnalyzeRequest" FullName="Microsoft.Azure.Search.Models.AnalyzeRequest">
<TypeSignature Language="C#" Value="public class AnalyzeRequest" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AnalyzeRequest extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.AnalyzeRequest" />
<TypeSignature Language="VB.NET" Value="Public Class AnalyzeRequest" />
<TypeSignature Language="F#" Value="type AnalyzeRequest = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Specifies some text and analysis components used to break that text
into tokens.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AnalyzeRequest ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AnalyzeRequest.#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 AnalyzeRequest class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AnalyzeRequest (string text, Microsoft.Azure.Search.Models.AnalyzerName? analyzer = default, Microsoft.Azure.Search.Models.TokenizerName? tokenizer = default, 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 text, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> analyzer, valuetype System.Nullable`1<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.AnalyzeRequest.#ctor(System.String,System.Nullable{Microsoft.Azure.Search.Models.AnalyzerName},System.Nullable{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 (text As String, Optional analyzer As Nullable(Of AnalyzerName) = Nothing, Optional tokenizer As Nullable(Of TokenizerName) = Nothing, Optional tokenFilters As IList(Of TokenFilterName) = Nothing, Optional charFilters As IList(Of CharFilterName) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.AnalyzeRequest : string * Nullable<Microsoft.Azure.Search.Models.AnalyzerName> * Nullable<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.AnalyzeRequest" Usage="new Microsoft.Azure.Search.Models.AnalyzeRequest (text, analyzer, tokenizer, tokenFilters, charFilters)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="analyzer" Type="System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName>" />
<Parameter Name="tokenizer" Type="System.Nullable<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="text">The text to break into tokens.</param>
<param name="analyzer">The name of the analyzer to use to break the
given text. If this parameter is not specified, you must specify a
tokenizer instead. The tokenizer and analyzer parameters are
mutually exclusive. Possible values include: 'ar.microsoft',
'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene',
'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene',
'zh-Hans.microsoft', 'zh-Hans.lucene', 'zh-Hant.microsoft',
'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene',
'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene',
'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft',
'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene',
'de.microsoft', 'de.lucene', 'el.microsoft', 'el.lucene',
'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene',
'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft',
'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene',
'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'ko.microsoft',
'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft',
'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft',
'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene',
'pt-BR.microsoft', 'pt-BR.lucene', 'pt-PT.microsoft',
'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene',
'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft',
'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft',
'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene',
'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene',
'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft',
'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene',
'keyword', 'pattern', 'simple', 'stop', 'whitespace'</param>
<param name="tokenizer">The name of the tokenizer to use to break
the given text. If this parameter is not specified, you must
specify an analyzer instead. The tokenizer and analyzer parameters
are mutually exclusive. 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">An optional list of token filters to use
when breaking the given text. This parameter can only be set when
using the tokenizer parameter.</param>
<param name="charFilters">An optional list of character filters to
use when breaking the given text. This parameter can only be set
when using the tokenizer parameter.</param>
<summary>
Initializes a new instance of the AnalyzeRequest class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Analyzer">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.AnalyzerName? Analyzer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> Analyzer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.AnalyzeRequest.Analyzer" />
<MemberSignature Language="VB.NET" Value="Public Property Analyzer As Nullable(Of AnalyzerName)" />
<MemberSignature Language="F#" Value="member this.Analyzer : Nullable<Microsoft.Azure.Search.Models.AnalyzerName> with get, set" Usage="Microsoft.Azure.Search.Models.AnalyzeRequest.Analyzer" />
<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="analyzer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="analyzer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the analyzer to use to break the given
text. If this parameter is not specified, you must specify a
tokenizer instead. The tokenizer and analyzer parameters are
mutually exclusive. Possible values include: 'ar.microsoft',
'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene',
'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene',
'zh-Hans.microsoft', 'zh-Hans.lucene', 'zh-Hant.microsoft',
'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene',
'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene',
'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft',
'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene',
'de.microsoft', 'de.lucene', 'el.microsoft', 'el.lucene',
'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene',
'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft',
'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene',
'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'ko.microsoft',
'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft',
'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft',
'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene',
'pt-BR.microsoft', 'pt-BR.lucene', 'pt-PT.microsoft',
'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene',
'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft',
'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft',
'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene',
'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene',
'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft',
'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene',
'keyword', 'pattern', 'simple', 'stop', 'whitespace'
</summary>
<value>To be added.</value>
<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.AnalyzeRequest.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.AnalyzeRequest.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 an optional list of character filters to use when
breaking the given text. This parameter can only be set when using
the tokenizer parameter.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Text" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.AnalyzeRequest.Text" />
<MemberSignature Language="VB.NET" Value="Public Property Text As String" />
<MemberSignature Language="F#" Value="member this.Text : string with get, set" Usage="Microsoft.Azure.Search.Models.AnalyzeRequest.Text" />
<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="text")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="text")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the text to break into tokens.
</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.AnalyzeRequest.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.AnalyzeRequest.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 an optional list of token filters to use when breaking
the given text. This parameter can only be set when using the
tokenizer parameter.
</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 System.Nullable`1<valuetype Microsoft.Azure.Search.Models.TokenizerName> Tokenizer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.AnalyzeRequest.Tokenizer" />
<MemberSignature Language="VB.NET" Value="Public Property Tokenizer As Nullable(Of TokenizerName)" />
<MemberSignature Language="F#" Value="member this.Tokenizer : Nullable<Microsoft.Azure.Search.Models.TokenizerName> with get, set" Usage="Microsoft.Azure.Search.Models.AnalyzeRequest.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>System.Nullable<Microsoft.Azure.Search.Models.TokenizerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the tokenizer to use to break the given
text. If this parameter is not specified, you must specify an
analyzer instead. The tokenizer and analyzer parameters are
mutually exclusive. 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 virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.AnalyzeRequest.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="analyzeRequest.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>