-
Notifications
You must be signed in to change notification settings - Fork 264
/
CustomInstance.xml
350 lines (350 loc) · 27.7 KB
/
CustomInstance.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
<Type Name="CustomInstance" FullName="Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance">
<TypeSignature Language="C#" Value="public class CustomInstance : Microsoft.Azure.CognitiveServices.Search.CustomSearch.ICustomInstance, Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CustomInstance extends System.Object implements class Microsoft.Azure.CognitiveServices.Search.CustomSearch.ICustomInstance, class Microsoft.Rest.IServiceOperations`1<class Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance" />
<TypeSignature Language="VB.NET" Value="Public Class CustomInstance
Implements ICustomInstance, IServiceOperations(Of CustomSearchClient)" />
<TypeSignature Language="F#" Value="type CustomInstance = class
 interface IServiceOperations<CustomSearchClient>
 interface ICustomInstance" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.CognitiveServices.Search.CustomSearch.ICustomInstance</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Rest.IServiceOperations<Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
CustomInstance operations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CustomInstance (Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient client);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance.#ctor(Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (client As CustomSearchClient)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance : Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient -> Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance" Usage="new Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance client" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="client" Type="Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient" />
</Parameters>
<Docs>
<param name="client">
Reference to the service client.
</param>
<summary>
Initializes a new instance of the CustomInstance class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
</Docs>
</Member>
<Member MemberName="Client">
<MemberSignature Language="C#" Value="public Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient Client { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient Client" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance.Client" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Client As CustomSearchClient" />
<MemberSignature Language="F#" Value="member this.Client : Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient" Usage="Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance.Client" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomSearchClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a reference to the CustomSearchClient
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SearchWithHttpMessagesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>> SearchWithHttpMessagesAsync (string customConfig, string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, int? count = default, string market = "en-us", int? offset = default, string safeSearch = default, string setLang = default, bool? textDecorations = default, string textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Rest.HttpOperationResponse`1<class Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>> SearchWithHttpMessagesAsync(string customConfig, string query, string acceptLanguage, string userAgent, string clientId, string clientIp, string location, string countryCode, valuetype System.Nullable`1<int32> count, string market, valuetype System.Nullable`1<int32> offset, string safeSearch, string setLang, valuetype System.Nullable`1<bool> textDecorations, string textFormat, class System.Collections.Generic.Dictionary`2<string, class System.Collections.Generic.List`1<string>> customHeaders, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.CustomSearch.CustomInstance.SearchWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Boolean},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SearchWithHttpMessagesAsync (customConfig As String, query As String, Optional acceptLanguage As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional market As String = "en-us", Optional offset As Nullable(Of Integer) = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of SearchResponse))" />
<MemberSignature Language="F#" Value="abstract member SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>>
override this.SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>>" Usage="customInstance.SearchWithHttpMessagesAsync (customConfig, query, acceptLanguage, userAgent, clientId, clientIp, location, countryCode, count, market, offset, safeSearch, setLang, textDecorations, textFormat, customHeaders, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.CognitiveServices.Search.CustomSearch.ICustomInstance.SearchWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.String,System.Nullable{System.Boolean},System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.CustomSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.SearchResponse>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="customConfig" Type="System.String" />
<Parameter Name="query" Type="System.String" />
<Parameter Name="acceptLanguage" Type="System.String" />
<Parameter Name="userAgent" Type="System.String" />
<Parameter Name="clientId" Type="System.String" />
<Parameter Name="clientIp" Type="System.String" />
<Parameter Name="location" Type="System.String" />
<Parameter Name="countryCode" Type="System.String" />
<Parameter Name="count" Type="System.Nullable<System.Int32>" />
<Parameter Name="market" Type="System.String" />
<Parameter Name="offset" Type="System.Nullable<System.Int32>" />
<Parameter Name="safeSearch" Type="System.String" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="textDecorations" Type="System.Nullable<System.Boolean>" />
<Parameter Name="textFormat" Type="System.String" />
<Parameter Name="customHeaders" Type="System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="customConfig">
The identifier for the custom search configuration
</param>
<param name="query">
The user's search query term. The term may not be empty. The term may
contain Bing Advanced Operators. For example, to limit results to a
specific domain, use the site: operator.
</param>
<param name="acceptLanguage">
A comma-delimited list of one or more languages to use for user interface
strings. The list is in decreasing order of preference. For additional
information, including expected format, see
[RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
header and the setLang query parameter are mutually exclusive; do not
specify both. If you set this header, you must also specify the cc query
parameter. Bing will use the first supported language it finds from the
list, and combine that language with the cc parameter value to determine
the market to return results for. If the list does not include a supported
language, Bing will find the closest language and market that supports the
request, and may use an aggregated or default market for the results
instead of a specified one. You should use this header and the cc query
parameter only if you specify multiple languages; otherwise, you should use
the mkt and setLang query parameters. A user interface string is a string
that's used as a label in a user interface. There are very few user
interface strings in the JSON response objects. Any links in the response
objects to Bing.com properties will apply the specified language.
</param>
<param name="userAgent">
The user agent originating the request. Bing uses the user agent to provide
mobile users with an optimized experience. Although optional, you are
strongly encouraged to always specify this header. The user-agent should be
the same string that any commonly used browser would send. For information
about user agents, see [RFC
2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
</param>
<param name="clientId">
Bing uses this header to provide users with consistent behavior across Bing
API calls. Bing often flights new features and improvements, and it uses
the client ID as a key for assigning traffic on different flights. If you
do not use the same client ID for a user across multiple requests, then
Bing may assign the user to multiple conflicting flights. Being assigned to
multiple conflicting flights can lead to an inconsistent user experience.
For example, if the second request has a different flight assignment than
the first, the experience may be unexpected. Also, Bing can use the client
ID to tailor web results to that client ID’s search history, providing a
richer experience for the user. Bing also uses this header to help improve
result rankings by analyzing the activity generated by a client ID. The
relevance improvements help with better quality of results delivered by
Bing APIs and in turn enables higher click-through rates for the API
consumer. IMPORTANT: Although optional, you should consider this header
required. Persisting the client ID across multiple requests for the same
end user and device combination enables 1) the API consumer to receive a
consistent user experience, and 2) higher click-through rates via better
quality of results from the Bing APIs. Each user that uses your application
on the device must have a unique, Bing generated client ID. If you do not
include this header in the request, Bing generates an ID and returns it in
the X-MSEdge-ClientID response header. The only time that you should NOT
include this header in a request is the first time the user uses your app
on that device. Use the client ID for each Bing API request that your app
makes for this user on the device. Persist the client ID. To persist the ID
in a browser app, use a persistent HTTP cookie to ensure the ID is used
across all sessions. Do not use a session cookie. For other apps such as
mobile apps, use the device's persistent storage to persist the ID. The
next time the user uses your app on that device, get the client ID that you
persisted. Bing responses may or may not include this header. If the
response includes this header, capture the client ID and use it for all
subsequent Bing requests for the user on that device. If you include the
X-MSEdge-ClientID, you must not include cookies in the request.
</param>
<param name="clientIp">
The IPv4 or IPv6 address of the client device. The IP address is used to
discover the user's location. Bing uses the location information to
determine safe search behavior. Although optional, you are encouraged to
always specify this header and the X-Search-Location header. Do not
obfuscate the address (for example, by changing the last octet to 0).
Obfuscating the address results in the location not being anywhere near the
device's actual location, which may result in Bing serving erroneous
results.
</param>
<param name="location">
A semicolon-delimited list of key/value pairs that describe the client's
geographical location. Bing uses the location information to determine safe
search behavior and to return relevant local content. Specify the key/value
pair as <key>:<value>. The following are the keys that you use
to specify the user's location. lat (required): The latitude of the
client's location, in degrees. The latitude must be greater than or equal
to -90.0 and less than or equal to +90.0. Negative values indicate southern
latitudes and positive values indicate northern latitudes. long (required):
The longitude of the client's location, in degrees. The longitude must be
greater than or equal to -180.0 and less than or equal to +180.0. Negative
values indicate western longitudes and positive values indicate eastern
longitudes. re (required): The radius, in meters, which specifies the
horizontal accuracy of the coordinates. Pass the value returned by the
device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
for cell tower triangulation, and 18,000m for reverse IP lookup. ts
(optional): The UTC UNIX timestamp of when the client was at the location.
(The UNIX timestamp is the number of seconds since January 1, 1970.) head
(optional): The client's relative heading or direction of travel. Specify
the direction of travel as degrees from 0 through 360, counting clockwise
relative to true north. Specify this key only if the sp key is nonzero. sp
(optional): The horizontal velocity (speed), in meters per second, that the
client device is traveling. alt (optional): The altitude of the client
device, in meters. are (optional): The radius, in meters, that specifies
the vertical accuracy of the coordinates. Specify this key only if you
specify the alt key. Although many of the keys are optional, the more
information that you provide, the more accurate the location results are.
Although optional, you are encouraged to always specify the user's
geographical location. Providing the location is especially important if
the client's IP address does not accurately reflect the user's physical
location (for example, if the client uses VPN). For optimal results, you
should include this header and the X-MSEdge-ClientIP header, but at a
minimum, you should include this header.
</param>
<param name="countryCode">
A 2-character country code of the country where the results come from. This
API supports only the United States market. If you specify this query
parameter, it must be set to us. If you set this parameter, you must also
specify the Accept-Language header. Bing uses the first supported language
it finds from the languages list, and combine that language with the
country code that you specify to determine the market to return results
for. If the languages list does not include a supported language, Bing
finds the closest language and market that supports the request, or it may
use an aggregated or default market for the results instead of a specified
one. You should use this query parameter and the Accept-Language query
parameter only if you specify multiple languages; otherwise, you should use
the mkt and setLang query parameters. This parameter and the mkt query
parameter are mutually exclusive—do not specify both.
</param>
<param name="count">
The number of search results to return in the response. The default is 10
and the maximum value is 50. The actual number delivered may be less than
requested.Use this parameter along with the offset parameter to page
results.For example, if your user interface displays 10 search results per
page, set count to 10 and offset to 0 to get the first page of results. For
each subsequent page, increment offset by 10 (for example, 0, 10, 20). It
is possible for multiple pages to include some overlap in results.
</param>
<param name="market">
The market where the results come from. Typically, mkt is the country where
the user is making the request from. However, it could be a different
country if the user is not located in a country where Bing delivers
results. The market must be in the form <language code>-<country
code>. For example, en-US. The string is case insensitive. If known, you
are encouraged to always specify the market. Specifying the market helps
Bing route the request and return an appropriate and optimal response. If
you specify a market that is not listed in Market Codes, Bing uses a best
fit market code based on an internal mapping that is subject to change.
This parameter and the cc query parameter are mutually exclusive—do not
specify both.
</param>
<param name="offset">
The zero-based offset that indicates the number of search results to skip
before returning results. The default is 0. The offset should be less than
(totalEstimatedMatches - count). Use this parameter along with the count
parameter to page results. For example, if your user interface displays 10
search results per page, set count to 10 and offset to 0 to get the first
page of results. For each subsequent page, increment offset by 10 (for
example, 0, 10, 20). it is possible for multiple pages to include some
overlap in results.
</param>
<param name="safeSearch">
A filter used to filter adult content. Off: Return webpages with adult
text, images, or videos. Moderate: Return webpages with adult text, but not
adult images or videos. Strict: Do not return webpages with adult text,
images, or videos. The default is Moderate. If the request comes from a
market that Bing's adult policy requires that safeSearch is set to Strict,
Bing ignores the safeSearch value and uses Strict. If you use the site:
query operator, there is the chance that the response may contain adult
content regardless of what the safeSearch query parameter is set to. Use
site: only if you are aware of the content on the site and your scenario
supports the possibility of adult content. Possible values include: 'Off',
'Moderate', 'Strict'
</param>
<param name="setLang">
The language to use for user interface strings. Specify the language using
the ISO 639-1 2-letter language code. For example, the language code for
English is EN. The default is EN (English). Although optional, you should
always specify the language. Typically, you set setLang to the same
language specified by mkt unless the user wants the user interface strings
displayed in a different language. This parameter and the Accept-Language
header are mutually exclusive; do not specify both. A user interface string
is a string that's used as a label in a user interface. There are few user
interface strings in the JSON response objects. Also, any links to Bing.com
properties in the response objects apply the specified language.
</param>
<param name="textDecorations">
A Boolean value that determines whether display strings should contain
decoration markers such as hit highlighting characters. If true, the
strings may include markers. The default is false. To specify whether to
use Unicode characters or HTML tags as the markers, see the textFormat
query parameter.
</param>
<param name="textFormat">
The type of markers to use for text decorations (see the textDecorations
query parameter). Possible values are Raw—Use Unicode characters to mark
content that needs special formatting. The Unicode characters are in the
range E000 through E019. For example, Bing uses E000 and E001 to mark the
beginning and end of query terms for hit highlighting. HTML—Use HTML tags
to mark content that needs special formatting. For example, use <b>
tags to highlight query terms in display strings. The default is Raw. For
display strings that contain escapable HTML characters such as <, >,
and &, if textFormat is set to HTML, Bing escapes the characters as
appropriate (for example, < is escaped to &lt;). Possible values
include: 'Raw', 'Html'
</param>
<param name="customHeaders">
Headers that will be added to request.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
The Custom Search API lets you send a search query to Bing and get back web
pages found in your custom view of the web.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Azure.CognitiveServices.Search.CustomSearch.Models.ErrorResponseException">
Thrown when the operation returned an invalid status code
</exception>
<exception cref="T:Microsoft.Rest.SerializationException">
Thrown when unable to deserialize the response
</exception>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown when a required parameter is null
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when a required parameter is null
</exception>
<return>
A response object containing the response body and response headers.
</return>
</Docs>
</Member>
</Members>
</Type>