Bing Image Search API v7 referen
原文链接：https://docs.microsoft.com/zh-cn/rest/api/cognitiveservices/bing-images-api-v7-reference
he 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, seeSearching the Web for Images.
For information about the headers that requests should include, seeRequest Headers.
For information about the query parameters that requests should include, seeQuery Parameters.
For information about the JSON response objects that responses may include, seeResponse Objects.
For information about permitted use and display of results, seeBing Search API Use and Display requirements.
Endpoints
To request images, send a GET request to one of the following URLs:
EndpointDescription
https://api.cognitive.microsoft.com/bing/v7.0/images/searchReturns images that are relevant to the users search query.
https://api.cognitive.microsoft.com/bing/v7.0/images/detailsReturns insights about an image, such as webpages that include the image.
https://api.cognitive.microsoft.com/bing/v7.0/images/trendingReturns images that are trending based on search requests made by others. The images are broken out into different categories. For example, Popular People Searches.
For a list of markets that support trending images, seeTrending Images.
The request must use the HTTPS protocol.
Note
The maximum URL length is 2,048
characters. To ensure that your URL length does not exceed the limit,
the maximum length of your query parameters should be less than 1,500
characters. If the URL exceeds 2,048 characters, the server returns 404
Not found.
Headers
The following are the headers that a request and response may include.
HeaderDescription
AcceptOptional request header.
The default media type is application/json. To specify that the response useJSON-LD, set the Accept header to application/ld+json.
Accept-LanguageOptional request header.
A comma-delimited list of languages to use for user interface strings. The list is in decreasing order of preference. For more information, including expected format, seeRFC2616.
This header and thesetLangquery parameter are mutually exclusive—do not specify both.
If you set this header, you must also specify theccquery parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with theccparameter 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 theccquery parameter only if you specify multiple languages. Otherwise, use themktandsetLangquery 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.
BingAPIs-MarketResponse header.
The market used by the request. The form is -. For example, en-US.
If you specify a market that is not listed inMarket Codes, this value may differ from the market you specified in themktquery parameter. The same is true if you specify values forccandAccept-Languagethat can't be reconciled.
BingAPIs-TraceIdResponse header.
The ID of the log entry that contains the details of the request. When an error occurs, capture this ID. If you are not able to determine and resolve the issue, include this ID along with the other information that you provide the Support team.
Content-TypeOptional request header.
If you set themodulesquery 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.
Ocp-Apim-Subscription-KeyRequired request header.
The subscription key that you received when you signed up for this service inCognitive Services.
By default, Bing returns cached content, if available. To prevent cached content, set the Pragma header to no-cache (for example, Pragma: no-cache).
The response includes this header if you exceed the number of queries allowed per second (QPS) or per month (QPM). The header contains the number of seconds that you must wait before sending another request.
User-AgentOptional request header.
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, seeRFC 2616.
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
X-MSEdge-ClientIDOptional request and response header.
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.
The following are the basic usage rules that apply to this header.
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.
NOTE: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.
NOTE:If you include the X-MSEdge-ClientID, you must not include cookies in the request.
X-MSEdge-ClientIPOptional request header.
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.
NOTE: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.
X-Search-LocationOptional request header.
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 :. 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 thespkey 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 thealtkey.
NOTE:Although many of the keys are optional, the more information that you provide, the more accurate the location results are.
NOTE: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-Search-ClientIP header, but at a minimum, you should include this header.
Note
Remember that the Terms of Use
require compliance with all applicable laws, including regarding use of
these headers. For example, in certain jurisdictions, such as Europe,
there are requirements to obtain user consent before placing certain
tracking devices on user devices.
Query parameters
The following are the query parameters that a request may include. See the Required column for required parameters. You must URL encode the query parameter values. For information about query parameters that you use to filter the images that Bing returns, seeFilter Query Parameters.
NameValueTypeRequired
cabThe 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.
FloatNo
calThe left coordinate of the region to crop.
The coordinate is a fraction of the original image's width 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.
FloatNo
carThe right coordinate of the region to crop.
The coordinate is a fraction of the original image's width 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.
FloatNo
catThe top coordinate of the region to crop.
The coordinate is a fraction 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.
FloatNo
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.
Unsigned IntegerNo
ccA 2-character country code of the country where the results come from. For a list of possible values, seeMarket Codes.
If you set this parameter, you must also specify theAccept-Languageheader. Bing uses the first supported language it finds in the specified languages and combines it with the country code 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, Bing may use an aggregated or default market for the results.
Use this query parameter and theAccept-Languageheader only if you specify multiple languages. Otherwise, you should use themktandsetLangquery parameters.
This parameter and themktquery parameter are mutually exclusive—do not specify both.
StringNo
You use this parameter along with theoffsetparameter to page results. For example, if your user interface displays 20 images per page, setcountto 20 andoffsetto 0 to get the first page of results. For each subsequent page, incrementoffsetby 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.
UnsignedShortNo
idAn 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. TheImageobject'simageIdfield contains the ID that you set this parameter to.StringNo
imgUrlThe URL of an image that you want to get insights of. Use this parameter as an alternative to using theinsightsTokenparameter 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 theContent-Typeheader.
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.
StringNo
insightsTokenAn image token. TheImageobject'simageInsightsTokencontains 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 themodulesquery parameter.
Use this parameter only with the Insights API. Do not specify this parameter when calling the Images, Trending Images, or Web Search APIs.
StringNo
mktThe market where the results come from. Typically,mktis 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 -. For example, en-US. The string is case insensitive. For a list of possible market values, seeMarket 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 inMarket Codes, Bing uses a best fit market code based on an internal mapping that is subject to change.
This parameter and theccquery parameter are mutually exclusive—do not specify both.
StringNo
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 theimageCaptionfield.
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.
StringNo
offsetThe 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-count).
To page results, use this parameter along with thecountparameter. For example, if your user interface displays 20 images per page, setcountto 20 andoffsetto 0 to get the first page of results. For each subsequent page, incrementoffsetby 20 (for example, 0, 20, 40).
It is possible for multiple pages to include some overlap in results. To prevent duplicates, seenextOffset.
Use this parameter only with the Image API. Do not specify this parameter when calling the Trending Images API or the Web Search API.
Unsigned ShortNo
qThe user's search query term. The term cannot be empty.
The term may containBing Advanced Operators. For example, to limit images to a specific domain, use thesite:operator.
To help improve relevance of an insights query (seeinsightsToken), 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.
StringYes
safeSearchFilter 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.
NOTE:If the request comes from a market that Bing's adult policy requires thatsafeSearchis set to Strict, Bing ignores thesafeSearchvalue and uses Strict.
NOTE:If you use thesite:query operator, there is the chance that the response may contain adult content regardless of what thesafeSearchquery parameter is set to. Usesite:only if you are aware of the content on the site and your scenario supports the possibility of adult content.
StringNo
Although optional, you should always specify the language. Typically, you setsetLangto the same language specified bymktunless the user wants the user interface strings displayed in a different language.
This parameter and theAccept-Languageheader 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.
StringNo
Filter query parameters
The following are the optional filter query parameters that you can
use to filter the images that Bing returns. You must URL encode the
query parameters.
Use these parameters only with the Image Search API. Do not specify
these parameters when calling the Trending Images API or Web Search API.
NameValueType
aspectFilter images by the following aspect ratios:
Square—Return images with standard aspect ratio
Wide—Return images with wide screen aspect ratio
Tall—Return images with tall aspect ratio
All—Do not filter by aspect. Specifying this value is the same as not specifying theaspectparameter.
String
colorFilter 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
String
freshnessFilter 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
String
heightFilter images that have the specified height, in pixels.
You may use this filter with thesizefilter to return small images that have a height of 150 pixels.
UnsignedShort
imageContentFilter 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
String
imageTypeFilter 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.
String
licenseFilter images by the following license types:
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.
All—Do not filter by license type. Specifying this value is the same as not specifying thelicenseparameter.
For more information about these license types, seeFilter Images By License Type.
String
maxFileSizeFilter 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 andminFileSizeto filter images within a range of file sizes.
Integer
You may specify this filter andminHeightto filter images within a range of heights.
This filter and theheightfilter are mutually exclusive.
Integer
You may specify this filter andmaxWidthto filter images within a range of widths.
This filter and thewidthfilter are mutually exclusive.
Integer
minFileSizeFilter 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 andmaxFileSizeto filter images within a range of file sizes.
Integer
You may specify this filter andmaxHeightto filter images within a range of heights.
This filter and theheightfilter are mutually exclusive.
Integer
You may specify this filter andmaxWidthto filter images within a range of widths.
This filter and thewidthfilter are mutually exclusive.
Integer
sizeFilter images by the following sizes:
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.
All—Do not filter by size. Specifying this value is the same as not specifying thesizeparameter.
You may use this parameter along with theheightorwidthparameters. For example, you may useheightandsizeto request small images that are 150 pixels tall.
String
widthFilter images that have the specified width, in pixels.
You may use this filter with thesizefilter to return small images that have a width of 150 pixels.
UnsignedShort
