-
Notifications
You must be signed in to change notification settings - Fork 256
/
SearchParameters.xml
637 lines (637 loc) · 38.2 KB
/
SearchParameters.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
<Type Name="SearchParameters" FullName="Microsoft.Azure.Search.Models.SearchParameters">
<TypeSignature Language="C#" Value="public class SearchParameters" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SearchParameters extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.SearchParameters" />
<TypeSignature Language="VB.NET" Value="Public Class SearchParameters" />
<TypeSignature Language="F#" Value="type SearchParameters = 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, faceting, paging, and other search query behaviors.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchParameters ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SearchParameters.#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 SearchParameters class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchParameters (bool includeTotalResultCount = false, System.Collections.Generic.IList<string> facets = default, string filter = default, System.Collections.Generic.IList<string> highlightFields = default, string highlightPostTag = default, string highlightPreTag = default, double? minimumCoverage = default, System.Collections.Generic.IList<string> orderBy = default, Microsoft.Azure.Search.Models.QueryType queryType = Microsoft.Azure.Search.Models.QueryType.Simple, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.ScoringParameter> scoringParameters = default, string scoringProfile = default, System.Collections.Generic.IList<string> searchFields = default, Microsoft.Azure.Search.Models.SearchMode searchMode = Microsoft.Azure.Search.Models.SearchMode.Any, System.Collections.Generic.IList<string> select = default, int? skip = default, int? top = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool includeTotalResultCount, class System.Collections.Generic.IList`1<string> facets, string filter, class System.Collections.Generic.IList`1<string> highlightFields, string highlightPostTag, string highlightPreTag, valuetype System.Nullable`1<float64> minimumCoverage, class System.Collections.Generic.IList`1<string> orderBy, valuetype Microsoft.Azure.Search.Models.QueryType queryType, class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.ScoringParameter> scoringParameters, string scoringProfile, class System.Collections.Generic.IList`1<string> searchFields, valuetype Microsoft.Azure.Search.Models.SearchMode searchMode, class System.Collections.Generic.IList`1<string> select, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> top) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.SearchParameters.#ctor(System.Boolean,System.Collections.Generic.IList{System.String},System.String,System.Collections.Generic.IList{System.String},System.String,System.String,System.Nullable{System.Double},System.Collections.Generic.IList{System.String},Microsoft.Azure.Search.Models.QueryType,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.ScoringParameter},System.String,System.Collections.Generic.IList{System.String},Microsoft.Azure.Search.Models.SearchMode,System.Collections.Generic.IList{System.String},System.Nullable{System.Int32},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional includeTotalResultCount As Boolean = false, Optional facets As IList(Of String) = Nothing, Optional filter As String = Nothing, Optional highlightFields As IList(Of String) = Nothing, 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 queryType As QueryType = Microsoft.Azure.Search.Models.QueryType.Simple, Optional scoringParameters As IList(Of ScoringParameter) = Nothing, Optional scoringProfile As String = Nothing, Optional searchFields As IList(Of String) = Nothing, Optional searchMode As SearchMode = Microsoft.Azure.Search.Models.SearchMode.Any, Optional select As IList(Of String) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.SearchParameters : bool * System.Collections.Generic.IList<string> * string * System.Collections.Generic.IList<string> * string * string * Nullable<double> * System.Collections.Generic.IList<string> * Microsoft.Azure.Search.Models.QueryType * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.ScoringParameter> * string * System.Collections.Generic.IList<string> * Microsoft.Azure.Search.Models.SearchMode * System.Collections.Generic.IList<string> * Nullable<int> * Nullable<int> -> Microsoft.Azure.Search.Models.SearchParameters" Usage="new Microsoft.Azure.Search.Models.SearchParameters (includeTotalResultCount, facets, filter, highlightFields, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, queryType, scoringParameters, scoringProfile, searchFields, searchMode, select, skip, top)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="includeTotalResultCount" Type="System.Boolean" />
<Parameter Name="facets" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="highlightFields" Type="System.Collections.Generic.IList<System.String>" />
<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="queryType" Type="Microsoft.Azure.Search.Models.QueryType" />
<Parameter Name="scoringParameters" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.ScoringParameter>" />
<Parameter Name="scoringProfile" Type="System.String" />
<Parameter Name="searchFields" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="searchMode" Type="Microsoft.Azure.Search.Models.SearchMode" />
<Parameter Name="select" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="skip" Type="System.Nullable<System.Int32>" />
<Parameter Name="top" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="includeTotalResultCount">A value that specifies
whether to fetch the total count of results. Default is false.
Setting this value to true may have a performance impact. Note that
the count returned is an approximation.</param>
<param name="facets">The list of facet expressions to apply to the
search query. Each facet expression contains a field name,
optionally followed by a comma-separated list of name:value
pairs.</param>
<param name="filter">The OData $filter expression to apply to the
search query.</param>
<param name="highlightFields">The list of field names to use for
hit highlights. Only searchable fields can be used for hit
highlighting.</param>
<param name="highlightPostTag">A string tag that is appended to hit
highlights. Must be set with highlightPreTag. Default is
&lt;/em&gt;.</param>
<param name="highlightPreTag">A string tag that is prepended to hit
highlights. Must be set with highlightPostTag. Default is
&lt;em&gt;.</param>
<param name="minimumCoverage">A number between 0 and 100 indicating
the percentage of the index that must be covered by a search 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 100.</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, and 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="queryType">A value that specifies the syntax of the
search query. The default is 'simple'. Use 'full' if your query
uses the Lucene query syntax. Possible values include: 'simple',
'full'</param>
<param name="scoringParameters">The list of parameter values to be
used in scoring functions (for example, referencePointParameter)
using the format name-values. For example, if the scoring profile
defines a function with a parameter called 'mylocation' the
parameter string would be "mylocation--122.2,44.8" (without the
quotes).</param>
<param name="scoringProfile">The name of a scoring profile to
evaluate match scores for matching documents in order to sort the
results.</param>
<param name="searchFields">The list of field names to which to
scope the full-text search. When using fielded search
(fieldName:searchExpression) in a full Lucene query, the field
names of each fielded search expression take precedence over any
field names listed in this parameter.</param>
<param name="searchMode">A value that specifies whether any or all
of the search terms must be matched in order to count the document
as a match. Possible values include: 'any', 'all'</param>
<param name="select">The list of fields to retrieve. If
unspecified, all fields marked as retrievable in the schema are
included.</param>
<param name="skip">The number of search results to skip. This value
cannot be greater than 100,000. If you need to scan documents in
sequence, but cannot use $skip due to this limitation, consider
using $orderby on a totally-ordered key and $filter with a range
query instead.</param>
<param name="top">The number of search results to retrieve. This
can be used in conjunction with $skip to implement client-side
paging of search results. If results are truncated due to
server-side paging, the response will include a continuation token
that can be used to issue another Search request for the next page
of results.</param>
<summary>
Initializes a new instance of the SearchParameters class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Facets">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> Facets { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Facets" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.Facets" />
<MemberSignature Language="VB.NET" Value="Public Property Facets As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Facets : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.Facets" />
<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 facet expressions to apply to the search
query. Each facet expression contains a field name, optionally
followed by a comma-separated list of name:value pairs.
</summary>
<value>To be added.</value>
<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.SearchParameters.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.SearchParameters.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 the OData $filter expression to apply to the search
query.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HighlightFields">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> HighlightFields { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> HighlightFields" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.HighlightFields" />
<MemberSignature Language="VB.NET" Value="Public Property HighlightFields As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.HighlightFields : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.HighlightFields" />
<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 use for hit highlights.
Only searchable fields can be used for hit highlighting.
</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.SearchParameters.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.SearchParameters.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. Default is
&amp;lt;/em&amp;gt;.
</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.SearchParameters.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.SearchParameters.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. Default is
&amp;lt;em&amp;gt;.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IncludeTotalResultCount">
<MemberSignature Language="C#" Value="public bool IncludeTotalResultCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IncludeTotalResultCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.IncludeTotalResultCount" />
<MemberSignature Language="VB.NET" Value="Public Property IncludeTotalResultCount As Boolean" />
<MemberSignature Language="F#" Value="member this.IncludeTotalResultCount : bool with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.IncludeTotalResultCount" />
<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 that specifies whether to fetch the total
count of results. Default is false. Setting this value to true may
have a performance impact. Note that the count returned is an
approximation.
</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.SearchParameters.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.SearchParameters.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 search 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 100.
</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.SearchParameters.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.SearchParameters.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, and
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="QueryType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.QueryType QueryType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Search.Models.QueryType QueryType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.QueryType" />
<MemberSignature Language="VB.NET" Value="Public Property QueryType As QueryType" />
<MemberSignature Language="F#" Value="member this.QueryType : Microsoft.Azure.Search.Models.QueryType with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.QueryType" />
<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>Microsoft.Azure.Search.Models.QueryType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that specifies the syntax of the search query.
The default is 'simple'. Use 'full' if your query uses the Lucene
query syntax. Possible values include: 'simple', 'full'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ScoringParameters">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Search.Models.ScoringParameter> ScoringParameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.ScoringParameter> ScoringParameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.ScoringParameters" />
<MemberSignature Language="VB.NET" Value="Public Property ScoringParameters As IList(Of ScoringParameter)" />
<MemberSignature Language="F#" Value="member this.ScoringParameters : System.Collections.Generic.IList<Microsoft.Azure.Search.Models.ScoringParameter> with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.ScoringParameters" />
<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<Microsoft.Azure.Search.Models.ScoringParameter></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of parameter values to be used in scoring
functions (for example, referencePointParameter) using the format
name-values. For example, if the scoring profile defines a function
with a parameter called 'mylocation' the parameter string would be
"mylocation--122.2,44.8" (without the quotes).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ScoringProfile">
<MemberSignature Language="C#" Value="public string ScoringProfile { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ScoringProfile" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.ScoringProfile" />
<MemberSignature Language="VB.NET" Value="Public Property ScoringProfile As String" />
<MemberSignature Language="F#" Value="member this.ScoringProfile : string with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.ScoringProfile" />
<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 the name of a scoring profile to evaluate match scores
for matching documents in order to sort the results.
</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.SearchParameters.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.SearchParameters.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 which to scope the
full-text search. When using fielded search
(fieldName:searchExpression) in a full Lucene query, the field
names of each fielded search expression take precedence over any
field names listed in this parameter.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SearchMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.SearchMode SearchMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Search.Models.SearchMode SearchMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.SearchMode" />
<MemberSignature Language="VB.NET" Value="Public Property SearchMode As SearchMode" />
<MemberSignature Language="F#" Value="member this.SearchMode : Microsoft.Azure.Search.Models.SearchMode with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.SearchMode" />
<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>Microsoft.Azure.Search.Models.SearchMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value that specifies whether any or all of the
search terms must be matched in order to count the document as a
match. Possible values include: 'any', 'all'
</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.SearchParameters.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.SearchParameters.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, all
fields marked as retrievable in the schema are included.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Skip">
<MemberSignature Language="C#" Value="public int? Skip { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Skip" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.SearchParameters.Skip" />
<MemberSignature Language="VB.NET" Value="Public Property Skip As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Skip : Nullable<int> with get, set" Usage="Microsoft.Azure.Search.Models.SearchParameters.Skip" />
<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 search results to skip. This value
cannot be greater than 100,000. If you need to scan documents in
sequence, but cannot use $skip due to this limitation, consider
using $orderby on a totally-ordered key and $filter with a range
query instead.
</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.SearchParameters.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.SearchParameters.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 search results to retrieve. This can be
used in conjunction with $skip to implement client-side paging of
search results. If results are truncated due to server-side paging,
the response will include a continuation token that can be used to
issue another Search request for the next page of results.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>