-
Notifications
You must be signed in to change notification settings - Fork 261
/
QueryContext.xml
280 lines (280 loc) · 16.4 KB
/
QueryContext.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
<Type Name="QueryContext" FullName="Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext">
<TypeSignature Language="C#" Value="public class QueryContext" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit QueryContext extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext" />
<TypeSignature Language="VB.NET" Value="Public Class QueryContext" />
<TypeSignature Language="F#" Value="type QueryContext = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Defines the query context that Bing used for the request.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public QueryContext ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the QueryContext class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public QueryContext (string originalQuery, string alteredQuery = default, string alterationOverrideQuery = default, bool? adultIntent = default, bool? askUserForLocation = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string originalQuery, string alteredQuery, string alterationOverrideQuery, valuetype System.Nullable`1<bool> adultIntent, valuetype System.Nullable`1<bool> askUserForLocation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.#ctor(System.String,System.String,System.String,System.Nullable{System.Boolean},System.Nullable{System.Boolean})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (originalQuery As String, Optional alteredQuery As String = Nothing, Optional alterationOverrideQuery As String = Nothing, Optional adultIntent As Nullable(Of Boolean) = Nothing, Optional askUserForLocation As Nullable(Of Boolean) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext : string * string * string * Nullable<bool> * Nullable<bool> -> Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext" Usage="new Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext (originalQuery, alteredQuery, alterationOverrideQuery, adultIntent, askUserForLocation)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="originalQuery" Type="System.String" />
<Parameter Name="alteredQuery" Type="System.String" />
<Parameter Name="alterationOverrideQuery" Type="System.String" />
<Parameter Name="adultIntent" Type="System.Nullable<System.Boolean>" />
<Parameter Name="askUserForLocation" Type="System.Nullable<System.Boolean>" />
</Parameters>
<Docs>
<param name="originalQuery">The query string as specified in the
request.</param>
<param name="alteredQuery">The query string used by Bing to perform
the query. Bing uses the altered query string if the original query
string contained spelling mistakes. For example, if the query
string is "saling downwind", the altered query string will be
"sailing downwind". This field is included only if the original
query string contains a spelling mistake.</param>
<param name="alterationOverrideQuery">The query string to use to
force Bing to use the original string. For example, if the query
string is "saling downwind", the override query string will be
"+saling downwind". Remember to encode the query string which
results in "%2Bsaling+downwind". This field is included only if the
original query string contains a spelling mistake.</param>
<param name="adultIntent">A Boolean value that indicates whether
the specified query has adult intent. The value is true if the
query has adult intent; otherwise, false.</param>
<param name="askUserForLocation">A Boolean value that indicates
whether Bing requires the user's location to provide accurate
results. If you specified the user's location by using the
X-MSEdge-ClientIP and X-Search-Location headers, you can ignore
this field. For location aware queries, such as "today's weather"
or "restaurants near me" that need the user's location to provide
accurate results, this field is set to true. For location aware
queries that include the location (for example, "Seattle weather"),
this field is set to false. This field is also set to false for
queries that are not location aware, such as "best
sellers".</param>
<summary>
Initializes a new instance of the QueryContext class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AdultIntent">
<MemberSignature Language="C#" Value="public bool? AdultIntent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> AdultIntent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AdultIntent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AdultIntent As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.AdultIntent : Nullable<bool>" Usage="Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AdultIntent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="adultIntent")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="adultIntent")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a Boolean value that indicates whether the specified query has
adult intent. The value is true if the query has adult intent;
otherwise, false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AlterationOverrideQuery">
<MemberSignature Language="C#" Value="public string AlterationOverrideQuery { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AlterationOverrideQuery" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AlterationOverrideQuery" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AlterationOverrideQuery As String" />
<MemberSignature Language="F#" Value="member this.AlterationOverrideQuery : string" Usage="Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AlterationOverrideQuery" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="alterationOverrideQuery")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="alterationOverrideQuery")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the query string to use to force Bing to use the original
string. For example, if the query string is "saling downwind", the
override query string will be "+saling downwind". Remember to
encode the query string which results in "%2Bsaling+downwind". This
field is included only if the original query string contains a
spelling mistake.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AlteredQuery">
<MemberSignature Language="C#" Value="public string AlteredQuery { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AlteredQuery" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AlteredQuery" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AlteredQuery As String" />
<MemberSignature Language="F#" Value="member this.AlteredQuery : string" Usage="Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AlteredQuery" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="alteredQuery")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="alteredQuery")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the query string used by Bing to perform the query. Bing uses
the altered query string if the original query string contained
spelling mistakes. For example, if the query string is "saling
downwind", the altered query string will be "sailing downwind".
This field is included only if the original query string contains a
spelling mistake.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AskUserForLocation">
<MemberSignature Language="C#" Value="public bool? AskUserForLocation { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> AskUserForLocation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AskUserForLocation" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AskUserForLocation As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.AskUserForLocation : Nullable<bool>" Usage="Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.AskUserForLocation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="askUserForLocation")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="askUserForLocation")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a Boolean value that indicates whether Bing requires the
user's location to provide accurate results. If you specified the
user's location by using the X-MSEdge-ClientIP and
X-Search-Location headers, you can ignore this field. For location
aware queries, such as "today's weather" or "restaurants near me"
that need the user's location to provide accurate results, this
field is set to true. For location aware queries that include the
location (for example, "Seattle weather"), this field is set to
false. This field is also set to false for queries that are not
location aware, such as "best sellers".
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OriginalQuery">
<MemberSignature Language="C#" Value="public string OriginalQuery { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string OriginalQuery" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.OriginalQuery" />
<MemberSignature Language="VB.NET" Value="Public Property OriginalQuery As String" />
<MemberSignature Language="F#" Value="member this.OriginalQuery : string with get, set" Usage="Microsoft.Azure.CognitiveServices.Search.EntitySearch.Models.QueryContext.OriginalQuery" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="originalQuery")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="originalQuery")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the query string as specified in the request.
</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.CognitiveServices.Search.EntitySearch.Models.QueryContext.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="queryContext.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.EntitySearch</AssemblyName>
<AssemblyVersion>2.0.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>