-
Notifications
You must be signed in to change notification settings - Fork 256
/
ImagesOperationsExtensions.xml
1033 lines (1033 loc) · 83.2 KB
/
ImagesOperationsExtensions.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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="ImagesOperationsExtensions" FullName="Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions">
<TypeSignature Language="C#" Value="public static class ImagesOperationsExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ImagesOperationsExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module ImagesOperationsExtensions" />
<TypeSignature Language="F#" Value="type ImagesOperationsExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.ImageSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extension methods for ImagesOperations.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="DetailsAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageInsights> DetailsAsync (this Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations operations, string query, string acceptLanguage = default, string contentType = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, double? cropBottom = default, double? cropLeft = default, double? cropRight = default, double? cropTop = default, string cropType = default, string countryCode = default, string id = default, string imageUrl = default, string insightsToken = default, System.Collections.Generic.IList<string> modules = default, string market = default, string safeSearch = default, string setLang = 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.ImageSearch.Models.ImageInsights> DetailsAsync(class Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations operations, string query, string acceptLanguage, string contentType, string userAgent, string clientId, string clientIp, string location, valuetype System.Nullable`1<float64> cropBottom, valuetype System.Nullable`1<float64> cropLeft, valuetype System.Nullable`1<float64> cropRight, valuetype System.Nullable`1<float64> cropTop, string cropType, string countryCode, string id, string imageUrl, string insightsToken, class System.Collections.Generic.IList`1<string> modules, string market, string safeSearch, string setLang, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions.DetailsAsync(Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.String,System.String,System.String,System.String,System.String,System.Collections.Generic.IList{System.String},System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function DetailsAsync (operations As IImagesOperations, query As String, 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 cropBottom As Nullable(Of Double) = Nothing, Optional cropLeft As Nullable(Of Double) = Nothing, Optional cropRight As Nullable(Of Double) = Nothing, Optional cropTop As Nullable(Of Double) = Nothing, Optional cropType As String = Nothing, Optional countryCode As String = Nothing, Optional id As String = Nothing, Optional imageUrl As String = Nothing, Optional insightsToken As String = Nothing, Optional modules As IList(Of String) = Nothing, Optional market As String = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ImageInsights)" />
<MemberSignature Language="F#" Value="static member DetailsAsync : Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations * string * string * string * string * string * string * string * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * string * string * string * string * string * System.Collections.Generic.IList<string> * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageInsights>" Usage="Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions.DetailsAsync (operations, query, acceptLanguage, contentType, userAgent, clientId, clientIp, location, cropBottom, cropLeft, cropRight, cropTop, cropType, countryCode, id, imageUrl, insightsToken, modules, market, safeSearch, setLang, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.ImageSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageInsights></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations" RefType="this" />
<Parameter Name="query" Type="System.String" />
<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="cropBottom" Type="System.Nullable<System.Double>" />
<Parameter Name="cropLeft" Type="System.Nullable<System.Double>" />
<Parameter Name="cropRight" Type="System.Nullable<System.Double>" />
<Parameter Name="cropTop" Type="System.Nullable<System.Double>" />
<Parameter Name="cropType" Type="System.String" />
<Parameter Name="countryCode" Type="System.String" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="imageUrl" Type="System.String" />
<Parameter Name="insightsToken" Type="System.String" />
<Parameter Name="modules" Type="System.Collections.Generic.IList<System.String>" />
<Parameter Name="market" Type="System.String" />
<Parameter Name="safeSearch" Type="System.String" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="query">
The user's search query term. The term cannot be empty. The term may
contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example,
to limit images to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. To help
improve relevance of an insights query (see
[insightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken)),
you should always include the user's query term. Use this parameter only
with the Image Search API.Do not specify this parameter when calling the
Trending Images API.
</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="cropBottom">
The bottom coordinate of the region to crop. The coordinate is a fractional
value of the original image's height and is measured from the top, left
corner of the image. Specify the coordinate as a value from 0.0 through
1.0. Use this parameter only with the Insights API. Do not specify this
parameter when calling the Images, Trending Images, or Web Search APIs.
</param>
<param name="cropLeft">
The left coordinate of the region to crop. The coordinate is a fractional
value of the original image's height and is measured from the top, left
corner of the image. Specify the coordinate as a value from 0.0 through
1.0. Use this parameter only with the Insights API. Do not specify this
parameter when calling the Images, Trending Images, or Web Search APIs.
</param>
<param name="cropRight">
The right coordinate of the region to crop. The coordinate is a fractional
value of the original image's height and is measured from the top, left
corner of the image. Specify the coordinate as a value from 0.0 through
1.0. Use this parameter only with the Insights API. Do not specify this
parameter when calling the Images, Trending Images, or Web Search APIs.
</param>
<param name="cropTop">
The top coordinate of the region to crop. The coordinate is a fractional
value of the original image's height and is measured from the top, left
corner of the image. Specify the coordinate as a value from 0.0 through
1.0. Use this parameter only with the Insights API. Do not specify this
parameter when calling the Images, Trending Images, or Web Search APIs.
</param>
<param name="cropType">
The crop type to use when cropping the image based on the coordinates
specified in the cal, cat, car, and cab parameters. The following are the
possible values. 0: Rectangular (default). Use this parameter only with the
Insights API. Do not specify this parameter when calling the Images,
Trending Images, or Web Search APIs. Possible values include: 'Rectangular'
</param>
<param name="countryCode">
A 2-character country code of the country where the results come from. For
a list of possible values, see [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes).
If you set this parameter, you must also specify the
[Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#acceptlanguage)
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](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="id">
An ID that uniquely identifies an image. Use this parameter to ensure that
the specified image is the first image in the list of images that Bing
returns. The
[Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image)
object's imageId field contains the ID that you set this parameter to.
</param>
<param name="imageUrl">
The URL of an image that you want to get insights of. Use this parameter as
an alternative to using the insightsToken parameter to specify the image.
You may also specify the image by placing the binary of the image in the
body of a POST request. If you use the binary option, see the
[Content-Type](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#contenttype)
header. The maximum supported image size is 1 MB. Use this parameter only
with the Insights API. Do not specify this parameter when calling the
Images, Trending Images, or Web Search APIs.
</param>
<param name="insightsToken">
An image token. The
[Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image)
object's
[imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken)
contains the token. Specify this parameter to get additional information
about an image, such as a caption or shopping source. For a list of the
additional information about an image that you can get, see the
[modules](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#modulesrequested)
query parameter. Use this parameter only with the Insights API. Do not
specify this parameter when calling the Images, Trending Images, or Web
Search APIs.
</param>
<param name="modules">
A comma-delimited list of insights to request. The following are the
possible case-insensitive values. All: Return all insights, if available,
except RecognizedEntities. BRQ: Best representative query. The query term
that best describes the image. Caption: A caption that provides information
about the image. If the caption contains entities, the response may include
links to images of those entities. Collections: A list of related images.
Recipes: A list of recipes for cooking the food shown in the images.
PagesIncluding: A list of webpages that include the image.
RecognizedEntities: A list of entities (people) that were recognized in the
image. NOTE: You may not specify this module with any other module. If you
specify it with other modules, the response doesn't include recognized
entities. RelatedSearches: A list of related searches made by others.
ShoppingSources: A list of merchants where you can buy related offerings.
SimilarImages: A list of images that are visually similar to the original
image. SimilarProducts: A list of images that contain a product that is
similar to a product found in the original image. Tags: Provides
characteristics of the type of content found in the image. For example, if
the image is of a person, the tags might indicate the person's gender and
type of clothes they're wearing. If you specify a module and there is no
data for the module, the response object doesn't include the related field.
For example, if you specify Caption and it does not exist, the response
doesn't include the imageCaption field. To include related searches, the
request must include the original query string. Although the original query
string is not required for similar images or products, you should always
include it because it can help improve relevance and the results. Use this
parameter only with the Insights API. Do not specify this parameter when
calling the Images, Trending Images, or Web Search APIs.
</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/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes).
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/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes),
Bing uses a best fit market code based on an internal mapping that is
subject to change. This parameter and the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="safeSearch">
Filter images for adult content. The following are the possible filter
values. Off: May return images with adult content. If the request is
through the Image Search API, the response includes thumbnail images that
are clear (non-fuzzy). However, if the request is through the Web Search
API, the response includes thumbnail images that are pixelated (fuzzy).
Moderate: If the request is through the Image Search API, the response
doesn't include images with adult content. If the request is through the
Web Search API, the response may include images with adult content (the
thumbnail images are pixelated (fuzzy)). 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: 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](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#acceptlanguage)
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="cancellationToken">
The cancellation token.
</param>
<summary>
The Image Detail Search API lets you search on Bing and get back insights
about an image, such as webpages that include the image. This section
provides technical details about the query parameters and headers that you
use to request insights of images 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="SearchAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.Images> SearchAsync (this Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations operations, string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string aspect = default, string color = default, string countryCode = default, int? count = default, string freshness = default, int? height = default, string id = default, string imageContent = default, string imageType = default, string license = default, string market = default, long? maxFileSize = default, long? maxHeight = default, long? maxWidth = default, long? minFileSize = default, long? minHeight = default, long? minWidth = default, long? offset = default, string safeSearch = default, string size = default, string setLang = default, int? width = 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.ImageSearch.Models.Images> SearchAsync(class Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations operations, string query, string acceptLanguage, string userAgent, string clientId, string clientIp, string location, string aspect, string color, string countryCode, valuetype System.Nullable`1<int32> count, string freshness, valuetype System.Nullable`1<int32> height, string id, string imageContent, string imageType, string license, string market, valuetype System.Nullable`1<int64> maxFileSize, valuetype System.Nullable`1<int64> maxHeight, valuetype System.Nullable`1<int64> maxWidth, valuetype System.Nullable`1<int64> minFileSize, valuetype System.Nullable`1<int64> minHeight, valuetype System.Nullable`1<int64> minWidth, valuetype System.Nullable`1<int64> offset, string safeSearch, string size, string setLang, valuetype System.Nullable`1<int32> width, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions.SearchAsync(Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations,System.String,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.String,System.String,System.String,System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Int64},System.String,System.String,System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function SearchAsync (operations As IImagesOperations, 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 aspect As String = Nothing, Optional color As String = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As String = Nothing, Optional height As Nullable(Of Integer) = Nothing, Optional id As String = Nothing, Optional imageContent As String = Nothing, Optional imageType As String = Nothing, Optional license As String = Nothing, Optional market As String = Nothing, Optional maxFileSize As Nullable(Of Long) = Nothing, Optional maxHeight As Nullable(Of Long) = Nothing, Optional maxWidth As Nullable(Of Long) = Nothing, Optional minFileSize As Nullable(Of Long) = Nothing, Optional minHeight As Nullable(Of Long) = Nothing, Optional minWidth As Nullable(Of Long) = Nothing, Optional offset As Nullable(Of Long) = Nothing, Optional safeSearch As String = Nothing, Optional size As String = Nothing, Optional setLang As String = Nothing, Optional width As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Images)" />
<MemberSignature Language="F#" Value="static member SearchAsync : Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations * string * string * string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * string * string * string * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * string * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.Images>" Usage="Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions.SearchAsync (operations, query, acceptLanguage, userAgent, clientId, clientIp, location, aspect, color, countryCode, count, freshness, height, id, imageContent, imageType, license, market, maxFileSize, maxHeight, maxWidth, minFileSize, minHeight, minWidth, offset, safeSearch, size, setLang, width, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.ImageSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.Images></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations" RefType="this" />
<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="aspect" Type="System.String" />
<Parameter Name="color" Type="System.String" />
<Parameter Name="countryCode" Type="System.String" />
<Parameter Name="count" Type="System.Nullable<System.Int32>" />
<Parameter Name="freshness" Type="System.String" />
<Parameter Name="height" Type="System.Nullable<System.Int32>" />
<Parameter Name="id" Type="System.String" />
<Parameter Name="imageContent" Type="System.String" />
<Parameter Name="imageType" Type="System.String" />
<Parameter Name="license" Type="System.String" />
<Parameter Name="market" Type="System.String" />
<Parameter Name="maxFileSize" Type="System.Nullable<System.Int64>" />
<Parameter Name="maxHeight" Type="System.Nullable<System.Int64>" />
<Parameter Name="maxWidth" Type="System.Nullable<System.Int64>" />
<Parameter Name="minFileSize" Type="System.Nullable<System.Int64>" />
<Parameter Name="minHeight" Type="System.Nullable<System.Int64>" />
<Parameter Name="minWidth" Type="System.Nullable<System.Int64>" />
<Parameter Name="offset" Type="System.Nullable<System.Int64>" />
<Parameter Name="safeSearch" Type="System.String" />
<Parameter Name="size" Type="System.String" />
<Parameter Name="setLang" Type="System.String" />
<Parameter Name="width" Type="System.Nullable<System.Int32>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="operations">
The operations group for this extension method.
</param>
<param name="query">
The user's search query term. The term cannot be empty. The term may
contain [Bing Advanced
Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example,
to limit images to a specific domain, use the
[site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. To help
improve relevance of an insights query (see
[insightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken)),
you should always include the user's query term. Use this parameter only
with the Image Search API.Do not specify this parameter when calling the
Trending Images API.
</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="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="aspect">
Filter images by the following aspect ratios. All: Do not filter by
aspect.Specifying this value is the same as not specifying the aspect
parameter. Square: Return images with standard aspect ratio. Wide: Return
images with wide screen aspect ratio. Tall: Return images with tall aspect
ratio. Possible values include: 'All', 'Square', 'Wide', 'Tall'
</param>
<param name="color">
Filter images by the following color options. ColorOnly: Return color
images. Monochrome: Return black and white images. Return images with one
of the following dominant colors: Black, Blue, Brown, Gray, Green, Orange,
Pink, Purple, Red, Teal, White, Yellow. Possible values include:
'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green',
'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow'
</param>
<param name="countryCode">
A 2-character country code of the country where the results come from. For
a list of possible values, see [Market
Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes).
If you set this parameter, you must also specify the
[Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#acceptlanguage)
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](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#mkt)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="count">
The number of images to return in the response. The actual number delivered
may be less than requested. The default is 35. The maximum value is 150.
You use this parameter along with the offset parameter to page results.For
example, if your user interface displays 20 images per page, set count to
20 and offset to 0 to get the first page of results.For each subsequent
page, increment offset by 20 (for example, 0, 20, 40). Use this parameter
only with the Image Search API.Do not specify this parameter when calling
the Insights, Trending Images, or Web Search APIs.
</param>
<param name="freshness">
Filter images by the following discovery options. Day: Return images
discovered by Bing within the last 24 hours. Week: Return images discovered
by Bing within the last 7 days. Month: Return images discovered by Bing
within the last 30 days. Possible values include: 'Day', 'Week', 'Month'
</param>
<param name="height">
Filter images that have the specified height, in pixels. You may use this
filter with the size filter to return small images that have a height of
150 pixels.
</param>
<param name="id">
An ID that uniquely identifies an image. Use this parameter to ensure that
the specified image is the first image in the list of images that Bing
returns. The
[Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image)
object's imageId field contains the ID that you set this parameter to.
</param>
<param name="imageContent">
Filter images by the following content types. Face: Return images that show
only a person's face. Portrait: Return images that show only a person's
head and shoulders. Possible values include: 'Face', 'Portrait'
</param>
<param name="imageType">
Filter images by the following image types. AnimatedGif: Return only
animated GIFs. Clipart: Return only clip art images. Line: Return only line
drawings. Photo: Return only photographs(excluding line drawings, animated
Gifs, and clip art). Shopping: Return only images that contain items where
Bing knows of a merchant that is selling the items. This option is valid in
the en - US market only.Transparent: Return only images with a transparent
background. Possible values include: 'AnimatedGif', 'Clipart', 'Line',
'Photo', 'Shopping', 'Transparent'
</param>
<param name="license">
Filter images by the following license types. All: Do not filter by license
type.Specifying this value is the same as not specifying the license
parameter. Any: Return images that are under any license type. The response
doesn't include images that do not specify a license or the license is
unknown. Public: Return images where the creator has waived their exclusive
rights, to the fullest extent allowed by law. Share: Return images that may
be shared with others. Changing or editing the image might not be allowed.
Also, modifying, sharing, and using the image for commercial purposes might
not be allowed. Typically, this option returns the most images.
ShareCommercially: Return images that may be shared with others for
personal or commercial purposes. Changing or editing the image might not be
allowed. Modify: Return images that may be modified, shared, and used.
Changing or editing the image might not be allowed. Modifying, sharing, and
using the image for commercial purposes might not be allowed.
ModifyCommercially: Return images that may be modified, shared, and used
for personal or commercial purposes. Typically, this option returns the
fewest images. For more information about these license types, see [Filter
Images By License Type](http://go.microsoft.com/fwlink/?LinkId=309768).
Possible values include: 'All', 'Any', 'Public', 'Share',
'ShareCommercially', 'Modify', 'ModifyCommercially'
</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/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes).
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/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes),
Bing uses a best fit market code based on an internal mapping that is
subject to change. This parameter and the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="maxFileSize">
Filter images that are less than or equal to the specified file size. The
maximum file size that you may specify is 520,192 bytes. If you specify a
larger value, the API uses 520,192. It is possible that the response may
include images that are slightly larger than the specified maximum. You may
specify this filter and minFileSize to filter images within a range of file
sizes.
</param>
<param name="maxHeight">
Filter images that have a height that is less than or equal to the
specified height. Specify the height in pixels. You may specify this filter
and minHeight to filter images within a range of heights. This filter and
the height filter are mutually exclusive.
</param>
<param name="maxWidth">
Filter images that have a width that is less than or equal to the specified
width. Specify the width in pixels. You may specify this filter and
maxWidth to filter images within a range of widths. This filter and the
width filter are mutually exclusive.
</param>
<param name="minFileSize">
Filter images that are greater than or equal to the specified file size.
The maximum file size that you may specify is 520,192 bytes. If you specify
a larger value, the API uses 520,192. It is possible that the response may
include images that are slightly smaller than the specified minimum. You
may specify this filter and maxFileSize to filter images within a range of
file sizes.
</param>
<param name="minHeight">
Filter images that have a height that is greater than or equal to the
specified height. Specify the height in pixels. You may specify this filter
and maxHeight to filter images within a range of heights. This filter and
the height filter are mutually exclusive.
</param>
<param name="minWidth">
Filter images that have a width that is greater than or equal to the
specified width. Specify the width in pixels. You may specify this filter
and maxWidth to filter images within a range of widths. This filter and the
width filter are mutually exclusive.
</param>
<param name="offset">
The zero-based offset that indicates the number of images to skip before
returning images. The default is 0. The offset should be less than
([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#totalestimatedmatches)
- count). Use this parameter along with the count parameter to page
results. For example, if your user interface displays 20 images per page,
set count to 20 and offset to 0 to get the first page of results. For each
subsequent page, increment offset by 20 (for example, 0, 20, 40). It is
possible for multiple pages to include some overlap in results. To prevent
duplicates, see
[nextOffset](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#nextoffset).
Use this parameter only with the Image API. Do not specify this parameter
when calling the Trending Images API or the Web Search API.
</param>
<param name="safeSearch">
Filter images for adult content. The following are the possible filter
values. Off: May return images with adult content. If the request is
through the Image Search API, the response includes thumbnail images that
are clear (non-fuzzy). However, if the request is through the Web Search
API, the response includes thumbnail images that are pixelated (fuzzy).
Moderate: If the request is through the Image Search API, the response
doesn't include images with adult content. If the request is through the
Web Search API, the response may include images with adult content (the
thumbnail images are pixelated (fuzzy)). 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: 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="size">
Filter images by the following sizes. All: Do not filter by size.
Specifying this value is the same as not specifying the size parameter.
Small: Return images that are less than 200x200 pixels. Medium: Return
images that are greater than or equal to 200x200 pixels but less than
500x500 pixels. Large: Return images that are 500x500 pixels or larger.
Wallpaper: Return wallpaper images. You may use this parameter along with
the height or width parameters. For example, you may use height and size to
request small images that are 150 pixels tall. Possible values include:
'All', 'Small', 'Medium', 'Large', 'Wallpaper'
</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](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#acceptlanguage)
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="width">
Filter images that have the specified width, in pixels. You may use this
filter with the size filter to return small images that have a width of 150
pixels.
</param>
<param name="cancellationToken">
The cancellation token.
</param>
<summary>
The Image Search API lets you send a search query to Bing and get back a
list of relevant images. This section provides technical details about the
query parameters and headers that you use to request images 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="TrendingAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.TrendingImages> TrendingAsync (this Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations operations, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, string market = default, string safeSearch = default, string setLang = 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.ImageSearch.Models.TrendingImages> TrendingAsync(class Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations operations, string acceptLanguage, string userAgent, string clientId, string clientIp, string location, string countryCode, string market, string safeSearch, string setLang, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions.TrendingAsync(Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function TrendingAsync (operations As IImagesOperations, 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 market As String = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TrendingImages)" />
<MemberSignature Language="F#" Value="static member TrendingAsync : Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations * string * string * string * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.TrendingImages>" Usage="Microsoft.Azure.CognitiveServices.Search.ImageSearch.ImagesOperationsExtensions.TrendingAsync (operations, acceptLanguage, userAgent, clientId, clientIp, location, countryCode, market, safeSearch, setLang, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.CognitiveServices.Search.ImageSearch</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.TrendingImages></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="operations" Type="Microsoft.Azure.CognitiveServices.Search.ImageSearch.IImagesOperations" RefType="this" />
<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="market" Type="System.String" />
<Parameter Name="safeSearch" Type="System.String" />
<Parameter Name="setLang" Type="System.String" />
<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="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="countryCode">
A 2-character country code of the country where the results come from. This
API supports only the United States, Canada, Australia, and China markets.
If you specify this query parameter, it must be set to us, ca, au, or cn.
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="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/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes).
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/rest/api/cognitiveservices/bing-images-api-v7-reference#market-codes),
Bing uses a best fit market code based on an internal mapping that is
subject to change. This parameter and the
[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#cc)
query parameter are mutually exclusive—do not specify both.
</param>
<param name="safeSearch">
Filter images for adult content. The following are the possible filter
values. Off: May return images with adult content. If the request is
through the Image Search API, the response includes thumbnail images that
are clear (non-fuzzy). However, if the request is through the Web Search
API, the response includes thumbnail images that are pixelated (fuzzy).
Moderate: If the request is through the Image Search API, the response
doesn't include images with adult content. If the request is through the
Web Search API, the response may include images with adult content (the
thumbnail images are pixelated (fuzzy)). 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: 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