-
Notifications
You must be signed in to change notification settings - Fork 255
/
SuggestOptions.xml
257 lines (257 loc) · 14.1 KB
/
SuggestOptions.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
<Type Name="SuggestOptions" FullName="Azure.Search.Documents.SuggestOptions">
<TypeSignature Language="C#" Value="public class SuggestOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SuggestOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.SuggestOptions" />
<TypeSignature Language="VB.NET" Value="Public Class SuggestOptions" />
<TypeSignature Language="F#" Value="type SuggestOptions = class" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.2.0.0</AssemblyVersion>
<AssemblyVersion>11.2.1.0</AssemblyVersion>
<AssemblyVersion>11.3.0.0</AssemblyVersion>
<AssemblyVersion>11.4.0.0</AssemblyVersion>
<AssemblyVersion>11.5.0.0</AssemblyVersion>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.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 SuggestOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.SuggestOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes new instance of <see cref="T:Azure.Search.Documents.SuggestOptions" /></summary>
<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:Azure.Search.Documents.SuggestOptions.Filter" />
<MemberSignature Language="VB.NET" Value="Public Property Filter As String" />
<MemberSignature Language="F#" Value="member this.Filter : string with get, set" Usage="Azure.Search.Documents.SuggestOptions.Filter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
An OData expression that filters the documents considered for
suggestions. You can use
<see cref="M:Azure.Search.Documents.SearchFilter.Create(System.FormattableString)" /> to help
construct the filter expression.
</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:Azure.Search.Documents.SuggestOptions.HighlightPostTag" />
<MemberSignature Language="VB.NET" Value="Public Property HighlightPostTag As String" />
<MemberSignature Language="F#" Value="member this.HighlightPostTag : string with get, set" Usage="Azure.Search.Documents.SuggestOptions.HighlightPostTag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> 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:Azure.Search.Documents.SuggestOptions.HighlightPreTag" />
<MemberSignature Language="VB.NET" Value="Public Property HighlightPreTag As String" />
<MemberSignature Language="F#" Value="member this.HighlightPreTag : string with get, set" Usage="Azure.Search.Documents.SuggestOptions.HighlightPreTag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary> 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:Azure.Search.Documents.SuggestOptions.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="Azure.Search.Documents.SuggestOptions.MinimumCoverage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Double></ReturnType>
</ReturnValue>
<Docs>
<summary> A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion 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; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> OrderBy" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.SuggestOptions.OrderBy" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OrderBy As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.OrderBy : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.SuggestOptions.OrderBy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
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; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> SearchFields" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.SuggestOptions.SearchFields" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SearchFields As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.SearchFields : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.SuggestOptions.SearchFields" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
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; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Select" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.SuggestOptions.Select" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Select As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Select : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.SuggestOptions.Select" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
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="Size">
<MemberSignature Language="C#" Value="public int? Size { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Size" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.SuggestOptions.Size" />
<MemberSignature Language="VB.NET" Value="Public Property Size As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Size : Nullable<int> with get, set" Usage="Azure.Search.Documents.SuggestOptions.Size" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of suggestions to retrieve. This must be a value 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 valuetype System.Nullable`1<bool> UseFuzzyMatching" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.SuggestOptions.UseFuzzyMatching" />
<MemberSignature Language="VB.NET" Value="Public Property UseFuzzyMatching As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.UseFuzzyMatching : Nullable<bool> with get, set" Usage="Azure.Search.Documents.SuggestOptions.UseFuzzyMatching" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary> A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions 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 suggestion searches are slower and consume more resources. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>