-
Notifications
You must be signed in to change notification settings - Fork 257
/
SuggestParameters.xml
409 lines (409 loc) · 23.6 KB
/
SuggestParameters.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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<Type Name="SuggestParameters" FullName="Microsoft.Azure.Search.Models.SuggestParameters">
<TypeSignature Language="C#" Value="public class SuggestParameters" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SuggestParameters extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.SuggestParameters" />
<TypeSignature Language="VB.NET" Value="Public Class SuggestParameters" />
<TypeSignature Language="F#" Value="type SuggestParameters = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SuggestParameters ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SuggestParameters.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the SuggestParameters class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SuggestParameters (string filter = default, bool useFuzzyMatching = false, string highlightPostTag = default, string highlightPreTag = default, double? minimumCoverage = default, System.Collections.Generic.IList<string> orderBy = default, System.Collections.Generic.IList<string> searchFields = default, System.Collections.Generic.IList<string> select = default, int? top = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filter, bool useFuzzyMatching, string highlightPostTag, string highlightPreTag, valuetype System.Nullable`1<float64> minimumCoverage, class System.Collections.Generic.IList`1<string> orderBy, class System.Collections.Generic.IList`1<string> searchFields, class System.Collections.Generic.IList`1<string> select, valuetype System.Nullable`1<int32> top) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SuggestParameters.#ctor(System.String,System.Boolean,System.String,System.String,System.Nullable{System.Double},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional filter As String = Nothing, Optional useFuzzyMatching As Boolean = false, Optional highlightPostTag As String = Nothing, Optional highlightPreTag As String = Nothing, Optional minimumCoverage As Nullable(Of Double) = Nothing, Optional orderBy As IList(Of String) = Nothing, Optional searchFields As IList(Of String) = Nothing, Optional select As IList(Of String) = Nothing, Optional top As Nullable(Of Integer) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.SuggestParameters : string * bool * string * string * Nullable<double> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * Nullable<int> -> Microsoft.Azure.Search.Models.SuggestParameters" Usage="new Microsoft.Azure.Search.Models.SuggestParameters (filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, searchFields, select, top)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="useFuzzyMatching" Type="System.Boolean" />
<Parameter Name="highlightPostTag" Type="System.String" />
<Parameter Name="highlightPreTag" Type="System.String" />
<Parameter Name="minimumCoverage" Type="System.Nullable<System.Double>" />
<Parameter Name="orderBy" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="searchFields" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="select" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="filter">An OData expression that filters the documents
considered for suggestions.</param>
<param name="useFuzzyMatching">A value indicating whether to use
fuzzy matching for the suggestions query. Default is false. When
set to true, the query will find terms even if there's a
substituted or missing character in the search text. While this
provides a better experience in some scenarios, it comes at a
performance cost as fuzzy suggestions queries are slower and
consume more resources.</param>
<param name="highlightPostTag">A string tag that is appended to hit
highlights. Must be set with highlightPreTag. If omitted, hit
highlighting of suggestions is disabled.</param>
<param name="highlightPreTag">A string tag that is prepended to hit
highlights. Must be set with highlightPostTag. If omitted, hit
highlighting of suggestions is disabled.</param>
<param name="minimumCoverage">A number between 0 and 100 indicating
the percentage of the index that must be covered by a suggestions
query in order for the query to be reported as a success. This
parameter can be useful for ensuring search availability even for
services with only one replica. The default is 80.</param>
<param name="orderBy">The list of OData $orderby expressions by
which to sort the results. Each expression can be either a field
name or a call to either the geo.distance() or the search.score()
functions. Each expression can be followed by asc to indicate
ascending, or desc to indicate descending. The default is ascending
order. Ties will be broken by the match scores of documents. If no
$orderby is specified, the default sort order is descending by
document match score. There can be at most 32 $orderby
clauses.</param>
<param name="searchFields">The list of field names to search for
the specified search text. Target fields must be included in the
specified suggester.</param>
<param name="select">The list of fields to retrieve. If
unspecified, only the key field will be included in the
results.</param>
<param name="top">The number of suggestions to retrieve. The value
must be a number between 1 and 100. The default is 5.</param>
<summary>
Initializes a new instance of the SuggestParameters class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnsureSelect">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.SuggestParameters EnsureSelect ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Search.Models.SuggestParameters EnsureSelect() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SuggestParameters.EnsureSelect" />
<MemberSignature Language="VB.NET" Value="Public Function EnsureSelect () As SuggestParameters" />
<MemberSignature Language="F#" Value="member this.EnsureSelect : unit -> Microsoft.Azure.Search.Models.SuggestParameters" Usage="suggestParameters.EnsureSelect " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.SuggestParameters</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns this instance if it has a non-null <c cref="P:Microsoft.Azure.Search.Models.SuggestParameters.Select">Select</c> property,
or a new instance with Select set to "*" otherwise.
</summary>
<returns>A <c cref="T:Microsoft.Azure.Search.Models.SuggestParameters">SuggestParameters</c> instance that has a
non-null <c cref="P:Microsoft.Azure.Search.Models.SuggestParameters.Select">Select</c> property</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Filter">
<MemberSignature Language="C#" Value="public string Filter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Filter" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.Filter" />
<MemberSignature Language="VB.NET" Value="Public Property Filter As String" />
<MemberSignature Language="F#" Value="member this.Filter : string with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.Filter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets an OData expression that filters the documents
considered for suggestions.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HighlightPostTag">
<MemberSignature Language="C#" Value="public string HighlightPostTag { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HighlightPostTag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.HighlightPostTag" />
<MemberSignature Language="VB.NET" Value="Public Property HighlightPostTag As String" />
<MemberSignature Language="F#" Value="member this.HighlightPostTag : string with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.HighlightPostTag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a string tag that is appended to hit highlights. Must
be set with highlightPreTag. If omitted, hit highlighting of
suggestions is disabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HighlightPreTag">
<MemberSignature Language="C#" Value="public string HighlightPreTag { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HighlightPreTag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.HighlightPreTag" />
<MemberSignature Language="VB.NET" Value="Public Property HighlightPreTag As String" />
<MemberSignature Language="F#" Value="member this.HighlightPreTag : string with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.HighlightPreTag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a string tag that is prepended to hit highlights. Must
be set with highlightPostTag. If omitted, hit highlighting of
suggestions is disabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MinimumCoverage">
<MemberSignature Language="C#" Value="public double? MinimumCoverage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<float64> MinimumCoverage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.MinimumCoverage" />
<MemberSignature Language="VB.NET" Value="Public Property MinimumCoverage As Nullable(Of Double)" />
<MemberSignature Language="F#" Value="member this.MinimumCoverage : Nullable<double> with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.MinimumCoverage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a number between 0 and 100 indicating the percentage
of the index that must be covered by a suggestions query in order
for the query to be reported as a success. This parameter can be
useful for ensuring search availability even for services with only
one replica. The default is 80.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OrderBy">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> OrderBy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> OrderBy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.OrderBy" />
<MemberSignature Language="VB.NET" Value="Public Property OrderBy As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.OrderBy : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.OrderBy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of OData $orderby expressions by which to
sort the results. Each expression can be either a field name or a
call to either the geo.distance() or the search.score() functions.
Each expression can be followed by asc to indicate ascending, or
desc to indicate descending. The default is ascending order. Ties
will be broken by the match scores of documents. If no $orderby is
specified, the default sort order is descending by document match
score. There can be at most 32 $orderby clauses.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SearchFields">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> SearchFields { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> SearchFields" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.SearchFields" />
<MemberSignature Language="VB.NET" Value="Public Property SearchFields As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.SearchFields : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.SearchFields" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of field names to search for the specified
search text. Target fields must be included in the specified
suggester.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Select">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> Select { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Select" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.Select" />
<MemberSignature Language="VB.NET" Value="Public Property Select As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Select : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.Select" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of fields to retrieve. If unspecified, only
the key field will be included in the results.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Top">
<MemberSignature Language="C#" Value="public int? Top { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Top" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.Top" />
<MemberSignature Language="VB.NET" Value="Public Property Top As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Top : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.Top" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the number of suggestions to retrieve. The value must
be a number between 1 and 100. The default is 5.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UseFuzzyMatching">
<MemberSignature Language="C#" Value="public bool UseFuzzyMatching { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseFuzzyMatching" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SuggestParameters.UseFuzzyMatching" />
<MemberSignature Language="VB.NET" Value="Public Property UseFuzzyMatching As Boolean" />
<MemberSignature Language="F#" Value="member this.UseFuzzyMatching : bool with get, set" Usage="Microsoft.Azure.Search.Models.SuggestParameters.UseFuzzyMatching" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether to use fuzzy matching for
the suggestions query. Default is false. When set to true, the
query will find terms even if there's a substituted or missing
character in the search text. While this provides a better
experience in some scenarios, it comes at a performance cost as
fuzzy suggestions queries are slower and consume more resources.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>