-
Notifications
You must be signed in to change notification settings - Fork 260
/
ImagesExtensions.xml
488 lines (488 loc) · 38.8 KB
/
ImagesExtensions.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
<Type Name="ImagesExtensions" FullName="Microsoft.Azure.CognitiveServices.Search.VisualSearch.ImagesExtensions">
<TypeSignature Language="C#" Value="public static class ImagesExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ImagesExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.VisualSearch.ImagesExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module ImagesExtensions" />
<TypeSignature Language="F#" Value="type ImagesExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VisualSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extension methods for Images.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="VisualSearchMethodAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge> VisualSearchMethodAsync (this Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages operations, string acceptLanguage = default, string contentType = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string market = default, string safeSearch = default, string setLang = default, Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.VisualSearchRequest knowledgeRequest = default, System.IO.Stream image = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge> VisualSearchMethodAsync(class Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages operations, string acceptLanguage, string contentType, string userAgent, string clientId, string clientIp, string location, string market, string safeSearch, string setLang, class Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.VisualSearchRequest knowledgeRequest, class System.IO.Stream image, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.VisualSearch.ImagesExtensions.VisualSearchMethodAsync(Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.VisualSearchRequest,System.IO.Stream,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function VisualSearchMethodAsync (operations As IImages, Optional acceptLanguage As String = Nothing, Optional contentType As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional market As String = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional knowledgeRequest As VisualSearchRequest = Nothing, Optional image As Stream = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ImageKnowledge)" />
<MemberSignature Language="F#" Value="static member VisualSearchMethodAsync : Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages * string * string * string * string * string * string * string * string * string * Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.VisualSearchRequest * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge>" Usage="Microsoft.Azure.CognitiveServices.Search.VisualSearch.ImagesExtensions.VisualSearchMethodAsync (operations, acceptLanguage, contentType, userAgent, clientId, clientIp, location, market, safeSearch, setLang, knowledgeRequest, image, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VisualSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages" RefType="this" />
<Parameter Name="acceptLanguage" Type="System.String" />
<Parameter Name="contentType" 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="market" Type="System.String" />
<Parameter Name="safeSearch" Type="System.String" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="knowledgeRequest" Type="Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.VisualSearchRequest" />
<Parameter Name="image" Type="System.IO.Stream" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</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](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang)
query parameter are mutually exclusive; do not specify both. If you set
this header, you must also specify the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc)
query parameter. To determine the market to return results for, Bing uses
the first supported language it finds from the list and combines it with
the cc parameter value. If the list does not include a supported language,
Bing finds the closest language and market that supports the request or it
uses an aggregated or default market for the results. To determine the
market that Bing used, see the BingAPIs-Market header. Use this header and
the cc query parameter only if you specify multiple languages. Otherwise,
use the
[mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt)
and
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#setlang)
query parameters. 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. Any links to Bing.com properties in the response objects
apply the specified language.
</param>
<param name="contentType">
Optional request header. If you set the
[modules](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#modulesrequested)
query parameter to RecognizedEntities, you may specify the binary of an
image in the body of a POST request. If you specify the image in the body
of a POST request, you must specify this header and set its value to
multipart/form-data. The maximum image size is 1 MB.
</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
encouraged to always specify this header. The user-agent should be the same
string that any commonly used browser sends. For information about user
agents, see [RFC
2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
following are examples of user-agent strings. Windows Phone: Mozilla/5.0
(compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5;
en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like
Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone;
CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
(Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
(KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
</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="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. For a list of
possible market values, see [Market
Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets).
NOTE: 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](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets),
Bing uses a best fit market code based on an internal mapping that is
subject to change.
</param>
<param name="safeSearch">
Filter the image results in actions with type 'VisualSearch' for adult
content. The following are the possible filter values. Off: May return
images with adult content. Moderate: Do not return images with adult
content. Strict: Do not return images with adult content. 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: filter in the knowledge
request, 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. 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="knowledgeRequest">
A JSON object containing information about the image. The image and
imageInsightsToken fields are mutually exclusive – the body of the request
must include only one of them.
</param>
<param name="image">
The uploaded image file. The size of the image is limited to 1 MB and the
file name must be "image". The image and imageInsightsToken fields are
mutually exclusive – the body of the request must include only one of them.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
The Image Visual Search API lets you send an image to Bing and get back a
list of relevant tags. Each tag contains potential actions a user might be
interested in. This section provides technical details about the request
format and headers that you use to request actions and the JSON response
objects that contain them. For examples that show how to make requests, see
[Searching the Web for
Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="VisualSearchMethodAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge> VisualSearchMethodAsync (this Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages operations, string acceptLanguage = default, string contentType = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string market = default, string safeSearch = default, string setLang = default, string knowledgeRequest = default, System.IO.Stream image = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge> VisualSearchMethodAsync(class Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages operations, string acceptLanguage, string contentType, string userAgent, string clientId, string clientIp, string location, string market, string safeSearch, string setLang, string knowledgeRequest, class System.IO.Stream image, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.VisualSearch.ImagesExtensions.VisualSearchMethodAsync(Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.IO.Stream,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function VisualSearchMethodAsync (operations As IImages, Optional acceptLanguage As String = Nothing, Optional contentType As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional market As String = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional knowledgeRequest As String = Nothing, Optional image As Stream = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ImageKnowledge)" />
<MemberSignature Language="F#" Value="static member VisualSearchMethodAsync : Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages * string * string * string * string * string * string * string * string * string * string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge>" Usage="Microsoft.Azure.CognitiveServices.Search.VisualSearch.ImagesExtensions.VisualSearchMethodAsync (operations, acceptLanguage, contentType, userAgent, clientId, clientIp, location, market, safeSearch, setLang, knowledgeRequest, image, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.VisualSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VisualSearch.Models.ImageKnowledge></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Search.VisualSearch.IImages" RefType="this" />
<Parameter Name="acceptLanguage" Type="System.String" />
<Parameter Name="contentType" 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="market" Type="System.String" />
<Parameter Name="safeSearch" Type="System.String" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="knowledgeRequest" Type="System.String" />
<Parameter Name="image" Type="System.IO.Stream" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</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](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang)
query parameter are mutually exclusive; do not specify both. If you set
this header, you must also specify the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#cc)
query parameter. To determine the market to return results for, Bing uses
the first supported language it finds from the list and combines it with
the cc parameter value. If the list does not include a supported language,
Bing finds the closest language and market that supports the request or it
uses an aggregated or default market for the results. To determine the
market that Bing used, see the BingAPIs-Market header. Use this header and
the cc query parameter only if you specify multiple languages. Otherwise,
use the
[mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#mkt)
and
[setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang)
query parameters. 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. Any links to Bing.com properties in the response objects
apply the specified language.
</param>
<param name="contentType">
Must be set to multipart/form-data and include a boundary parameter (for
example, multipart/form-data; boundary=<boundary string>). For more
details, see [Content form types](
https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types).
</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
encouraged to always specify this header. The user-agent should be the same
string that any commonly used browser sends. For information about user
agents, see [RFC
2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
following are examples of user-agent strings. Windows Phone: Mozilla/5.0
(compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5;
en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like
Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone;
CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
(Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
(KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.
</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. ATTENTION: You must
ensure that this Client ID is not linkable to any authenticatable user
account information. 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="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. For a list of
possible market values, see [Market
Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets).
NOTE: 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](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets),
Bing uses a best fit market code based on an internal mapping that is
subject to change.
</param>
<param name="safeSearch">
Filter the image results in actions with type 'VisualSearch' for adult
content. The following are the possible filter values. Off: May return
images with adult content. Moderate: Do not return images with adult
content. Strict: Do not return images with adult content. 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: filter in the knowledge
request, 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. 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="knowledgeRequest">
The form data is a JSON object that identifies the image using an insights
token or URL to the image. The object may also include an optional crop
area that identifies an area of interest in the image. The insights token
and URL are mutually exclusive – do not specify both. You may specify
knowledgeRequest form data and image form data in the same request only if
knowledgeRequest form data specifies the cropArea field only (it must not
include an insights token or URL).
</param>
<param name="image">
The form data is an image binary. The Content-Disposition header's name
parameter must be set to "image". You must specify an image binary if you
do not use knowledgeRequest form data to specify the image; you may not use
both forms to specify an image. You may specify knowledgeRequest form data
and image form data in the same request only if knowledgeRequest form data
specifies the cropArea field only (it must not include an insights token
or URL).
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
Visual Search API lets you discover insights about an image such as
visually similar images, shopping sources, and related searches. The API
can also perform text recognition, identify entities (people, places,
things), return other topical content for the user to explore, and more.
For more information, see [Visual Search
Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>