swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ImageTrendingSearch API schemes: - https tags: - name: ImageTrendingSearch paths: /images/trending: get: summary: 'Microsoft Azure The Image Trending Search Api Lets You Search On Bing And Get Back A List Of 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, See [trending Images] Https: Docs Microsoft Com En Us Azure Cognitive Services Bing Image Search Trending Images' operationId: microsoftAzureImagesTrending tags: - ImageTrendingSearch parameters: - $ref: '#/parameters/x-bingapis-sdk' - name: Accept in: header description: The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json. required: false type: string - name: Accept-Language x-ms-client-name: AcceptLanguage in: header description: 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. required: false type: string - name: User-Agent x-ms-client-name: UserAgent in: header description: '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' required: false type: string - name: X-MSEdge-ClientID x-ms-client-name: ClientId in: header description: '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.' required: false type: string - name: X-MSEdge-ClientIP x-ms-client-name: ClientIp in: header description: 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. required: false type: string - name: X-Search-Location x-ms-client-name: Location in: header description: '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 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.' required: false type: string - name: cc x-ms-client-name: CountryCode in: query description: 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. required: false type: string - name: mkt x-ms-client-name: Market in: query description: '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 -. 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.' required: false type: string - name: safeSearch x-ms-client-name: SafeSearch in: query description: '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.' required: false type: string enum: - 'Off' - Moderate - Strict x-ms-enum: name: SafeSearch modelAsString: true - name: setLang x-ms-client-name: SetLang in: query description: 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. required: false type: string responses: '200': description: Success. schema: $ref: '#/definitions/TrendingImages' default: description: An error has occurred. Check the response type and/or status code for more details. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Successful image trending: $ref: ./examples/SuccessfulImageTrendingRequest.json description: Needs a more full description created. definitions: Response: description: Defines a response. All schemas that could be returned at the root of a response should inherit from this allOf: - $ref: '#/definitions/Identifiable' type: object properties: readLink: description: The URL that returns this resource. readOnly: true type: string webSearchUrl: description: The URL To Bing's search result for this item. readOnly: true type: string CreativeWork: description: The most generic kind of creative work, including books, movies, photographs, software programs, etc. allOf: - $ref: '#/definitions/Thing' type: object properties: thumbnailUrl: description: The URL to a thumbnail of the item. readOnly: true type: string provider: description: The source of the creative work. readOnly: true type: array items: $ref: '#/definitions/Thing' datePublished: description: The date on which the CreativeWork was published. readOnly: true type: string text: description: Text content of this creative work readOnly: true type: string Rating: description: Defines a rating. allOf: - $ref: '#/definitions/PropertiesItem' type: object required: - ratingValue properties: ratingValue: description: The mean (average) rating. The possible values are 1.0 through 5.0. type: number format: float bestRating: description: The highest rated review. The possible values are 1.0 through 5.0. readOnly: true type: number format: float PropertiesItem: description: Defines an item. x-ms-discriminator-value: Properties/Item discriminator: _type type: object required: - _type properties: text: description: Text representation of an item. readOnly: true type: string _type: type: string TrendingImages: description: The top-level object that the response includes when a trending images request succeeds. allOf: - $ref: '#/definitions/Response' type: object required: - categories properties: categories: description: A list that identifies categories of images and a list of trending images in that category. type: array items: $ref: '#/definitions/TrendingImagesCategory' TrendingImagesTile: description: Defines an image tile. x-ms-discriminator-value: TrendingImages/Tile type: object required: - query - image properties: query: description: A query that returns a Bing search results page with more images of the subject. For example, if the category is Popular People Searches, then the thumbnail is of a popular person. The query would return a Bing search results page with more images of that person. $ref: '#/definitions/Query' image: description: The image's thumbnail. $ref: '#/definitions/ImageObject' ImagesImageMetadata: description: Defines a count of the number of websites where you can shop or perform other actions related to the image. x-ms-discriminator-value: Images/ImageMetadata type: object properties: shoppingSourcesCount: description: The number of websites that offer goods of the products seen in the image. readOnly: true type: integer format: int32 recipeSourcesCount: description: The number of websites that offer recipes of the food seen in the image. readOnly: true type: integer format: int32 aggregateOffer: description: 'A summary of the online offers of products found in the image. For example, if the image is of a dress, the offer might identify the lowest price and the number of offers found. Only visually similar products insights include this field. The offer includes the following fields: Name, AggregateRating, OfferCount, and LowPrice.' $ref: '#/definitions/AggregateOffer' readOnly: true ResponseBase: description: Response base discriminator: _type type: object required: - _type properties: _type: type: string Thing: description: Defines a thing. allOf: - $ref: '#/definitions/Response' type: object properties: name: description: The name of the thing represented by this object. readOnly: true type: string url: description: The URL to get more information about the thing represented by this object. readOnly: true type: string image: description: An image of the item. $ref: '#/definitions/ImageObject' readOnly: true description: description: A short description of the item. readOnly: true type: string alternateName: description: An alias for the item readOnly: true type: string bingId: description: An ID that uniquely identifies this item. readOnly: true type: string TrendingImagesCategory: description: Defines the category of trending images. x-ms-discriminator-value: TrendingImages/Category type: object required: - title - tiles properties: title: description: The name of the image category. For example, Popular People Searches. type: string tiles: description: A list of images that are trending in the category. Each tile contains an image and a URL that returns more images of the subject. For example, if the category is Popular People Searches, the image is of a popular person and the URL would return more images of that person. type: array items: $ref: '#/definitions/TrendingImagesTile' MediaObject: description: Defines a media object. allOf: - $ref: '#/definitions/CreativeWork' type: object properties: contentUrl: description: Original URL to retrieve the source (file) for the media object (e.g the source URL for the image). readOnly: true type: string hostPageUrl: description: URL of the page that hosts the media object. readOnly: true type: string contentSize: description: Size of the media object content (use format "value unit" e.g "1024 B"). readOnly: true type: string encodingFormat: description: Encoding format (e.g mp3, mp4, jpeg, etc). readOnly: true type: string hostPageDisplayUrl: description: Display URL of the page that hosts the media object. readOnly: true type: string width: description: The width of the source media object, in pixels. readOnly: true type: integer format: int32 height: description: The height of the source media object, in pixels. readOnly: true type: integer format: int32 Organization: description: Defines an organization. allOf: - $ref: '#/definitions/Thing' type: object properties: {} Offer: description: Defines a merchant's offer. allOf: - $ref: '#/definitions/Thing' type: object properties: seller: description: Seller for this offer $ref: '#/definitions/Organization' readOnly: true price: description: The item's price. readOnly: true type: number format: float priceCurrency: description: The monetary currency. For example, USD. readOnly: true type: string default: USD enum: - USD - CAD - GBP - EUR - COP - JPY - CNY - AUD - INR - AED - AFN - ALL - AMD - ANG - AOA - ARS - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYR - BZD - CDF - CHE - CHF - CHW - CLF - CLP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - FJD - FKP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - IQD - IRR - ISK - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLL - SOS - SRD - SSP - STD - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - UYU - UZS - VEF - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW x-ms-enum: name: Currency modelAsString: true availability: description: 'The item''s availability. The following are the possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, OnlineOnly, OutOfStock, PreOrder, SoldOut' readOnly: true type: string enum: - Discontinued - InStock - InStoreOnly - LimitedAvailability - OnlineOnly - OutOfStock - PreOrder - SoldOut x-ms-enum: name: ItemAvailability modelAsString: true aggregateRating: description: An aggregated rating that indicates how well the product has been rated by others. $ref: '#/definitions/AggregateRating' readOnly: true lastUpdated: description: The last date that the offer was updated. The date is in the form YYYY-MM-DD. readOnly: true type: string Error: description: Defines the error that occurred. type: object required: - code - message properties: code: description: The error code that identifies the category of error. type: string default: None enum: - None - ServerError - InvalidRequest - RateLimitExceeded - InvalidAuthorization - InsufficientAuthorization x-ms-enum: name: ErrorCode modelAsString: true subCode: description: The error code that further helps to identify the error. readOnly: true type: string enum: - UnexpectedError - ResourceError - NotImplemented - ParameterMissing - ParameterInvalidValue - HttpNotAllowed - Blocked - AuthorizationMissing - AuthorizationRedundancy - AuthorizationDisabled - AuthorizationExpired x-ms-enum: name: ErrorSubCode modelAsString: true message: description: A description of the error. type: string moreDetails: description: A description that provides additional information about the error. readOnly: true type: string parameter: description: The parameter in the request that caused the error. readOnly: true type: string value: description: The parameter's value in the request that was not valid. readOnly: true type: string ErrorResponse: description: The top-level response that represents a failed request. allOf: - $ref: '#/definitions/Response' type: object required: - errors properties: errors: description: A list of errors that describe the reasons why the request failed. type: array items: $ref: '#/definitions/Error' Identifiable: description: Defines the identity of a resource. allOf: - $ref: '#/definitions/ResponseBase' type: object properties: id: description: A String identifier. readOnly: true type: string AggregateRating: description: Defines the metrics that indicate how well an item was rated by others. allOf: - $ref: '#/definitions/Rating' type: object properties: reviewCount: description: The number of times the recipe has been rated or reviewed. readOnly: true type: integer format: int32 ImageObject: description: Defines an image allOf: - $ref: '#/definitions/MediaObject' type: object properties: thumbnail: description: The URL to a thumbnail of the image $ref: '#/definitions/ImageObject' readOnly: true imageInsightsToken: description: The token that you use in a subsequent call to the Image Search API to get additional information about the image. For information about using this token, see the insightsToken query parameter. readOnly: true type: string insightsMetadata: description: A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInsightsToken to get the list of websites. $ref: '#/definitions/ImagesImageMetadata' readOnly: true imageId: description: Unique Id for the image readOnly: true type: string accentColor: description: A three-byte hexadecimal number that represents the color that dominates the image. Use the color as the temporary background in your client until the image is loaded. readOnly: true type: string visualWords: description: Visual representation of the image. Used for getting more sizes readOnly: true type: string Query: description: Defines a search query. type: object required: - text properties: text: description: The query string. Use this string as the query term in a new search request. type: string displayText: description: The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting readOnly: true type: string webSearchUrl: description: The URL that takes the user to the Bing search results page for the query.Only related search results include this field. readOnly: true type: string searchLink: description: The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL. readOnly: true type: string thumbnail: description: The URL to a thumbnail of a related image. $ref: '#/definitions/ImageObject' readOnly: true AggregateOffer: description: Defines a list of offers from merchants that are related to the image. allOf: - $ref: '#/definitions/Offer' type: object properties: offers: description: A list of offers from merchants that have offerings related to the image. readOnly: true type: array items: $ref: '#/definitions/Offer' parameters: x-bingapis-sdk: name: X-BingApis-SDK description: Activate swagger compliance x-ms-parameter-location: method required: true type: string in: header x-ms-enum: name: XBingApisSDK modelAsString: true enum: - 'true' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'