Default insights tag
Warning
On October 30, 2020, the Bing Search APIs moved from Azure AI services to Bing Search Services. This documentation is provided for reference only. For updated documentation, see the Bing search API documentation. For instructions on creating new Azure resources for Bing search, see Create a Bing Search resource through the Azure Marketplace.
The default insights tag is the one with the displayName field set to an empty string. The following example shows the possible list of default insights (actions). The list of actions the response includes depends on the image. And for each action, the list of properties may vary by image, so check if the property exists before trying to use it.
{
"_type" : "ImageKnowledge",
"tags" : [
{
"displayName" : "",
"actions" : [
{
"_type" : "ImageModuleAction",
"actionType" : "PagesIncluding",
"data" : {
"value" : [...]
}
},
{
"_type" : "ImageShoppingSourcesAction",
"actionType" : "ShoppingSources",
"data" : {
"offers" : [...]
}
},
{
"image" : {...},
"actionType" : "MoreSizes"
},
{
"_type" : "ImageModuleAction",
"actionType" : "VisualSearch",
"data" : {
"value" : [...]
}
},
{
"_type" : "ImageRecipesAction",
"actionType" : "Recipes",
"data" : {
"value" : [...]
}
},
{
"image" : {...},
"actionType" : "ImageById"
},
{
"_type" : "ImageModuleAction",
"actionType" : "ProductVisualSearch",
"data" : {
"value" : [...]
}
},
{
"_type" : "ImageRelatedSearchesAction",
"actionType" : "RelatedSearches",
"data" : {
"value" : [...]
}
},
{
"_type" : "ImageRelatedSearchesAction",
"actionType" : "DocumentLevelSuggestions",
"data" : {
"value" : [...]
}
}
]
},
{...},
{...},
{...},
{...}
],
"image" : {
"imageInsightsToken" : "bcid_AF8C9CA409421B..."
}
}
PagesIncluding insight
The PagesIncluding insight provides a list of webpages that include this image. It's actually a list of Image objects, and the hostPageUrl field contains the URL to the webpage that includes the image. For example usage, see PagesIncluding insight example.
{
"_type" : "ImageModuleAction",
"actionType" : "PagesIncluding",
"data" : {
"value" : [
{
"webSearchUrl" : "https://www.bing.com\/images\/search?",
"name" : "Today's smoking hot country",
"thumbnailUrl" : "https:\/\/tse2.mm.bing.net\/th?id=OIP...",
"datePublished" : "2017-09-20T12:00:00.0000000Z",
"contentUrl" : "http:\/\/contoso.com\/wordstuff",
"hostPageUrl" : "http:\/\/contoso.com\/2017\/09\/20\/car",
"contentSize" : "122540 B",
"encodingFormat" : "jpeg",
"hostPageDisplayUrl" : "contoso.com\/2017\/09\/20\/car",
"width" : 894,
"height" : 1200,
"thumbnail" : {
"width" : 474,
"height" : 636
},
"imageInsightsToken" : "ccid_CO5GEthj*mid_5323B1",
"insightsMetadata" : {
"pagesIncludingCount" : 12,
"availableSizesCount" : 7
},
"imageId" : "5323B1900FB9087B6B45D176D234E1F2F23CD3A5",
"accentColor" : "55585B"
}
]
}
}
ShoppingSources insight
The ShoppingSources insight provides a list of websites where the user can buy the item shown in the image. The list of offers includes the URL of the webpage where the user can buy the item, the price of the item, and rating or review details. For example usage, see ShoppingSources example.
{
"_type" : "ImageShoppingSourcesAction",
"actionType" : "ShoppingSources",
"data" : {
"offers" : [
{
"name" : "Apple Pie",
"url" : "https:\/\/contoso.com\/product_p\/l10.htm",
"description" : "A taste of the crust, apple, and pie filling...",
"seller" : {
"name" : "Contoso"
},
"price" : 3.99,
"priceCurrency" : "USD",
"aggregateRating" : {
"ratingValue" : 5
},
"lastUpdated" : "2018-04-16T00:00:00.0000000"
}
]
}
}
MoreSizes insight
The MoreSizes insight identifies the number of sizes (larger or smaller) of the image that Bing found on the Internet (see the availableSizesCount field):
{
"image" : {
"webSearchUrl" : "https:\/\/www.bing.com\/images\/search?view=detai...",
"name" : "Making Apple Pie",
"thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?id=OIP....",
"datePublished" : "2013-06-21T12:00:00.0000000Z",
"contentUrl" : "http:\/\/contoso.com\/content\/uploads\/2013\/06\/apple-pie.jpg",
"hostPageUrl" : "http:\/\/contoso.com\/2013\/06\/21\/making-apple-pie\/",
"contentSize" : "134847 B",
"encodingFormat" : "jpeg",
"hostPageDisplayUrl" : "contoso.com\/2013\/06\/21\/making-apple-pie",
"width" : 1050,
"height" : 765,
"thumbnail" : {
"width" : 474,
"height" : 345
},
"imageInsightsToken" : "ccid_tmaGQ2eU*mid_D12339146CF...",
"insightsMetadata" : {
"recipeSourcesCount" : 6,
"pagesIncludingCount" : 103,
"availableSizesCount" : 28
},
"imageId" : "D12339146CFEDF3D409CC7A66D2C98D0D71904D4",
"accentColor" : "3A0B01"
},
"actionType" : "MoreSizes"
},
VisualSearch insight
The VisualSearch insight provides a list of images that are visually similar to the original image (contains content that's similar to the content shown in the original image). For example usage, see VisualSearch insight example.
{
"_type" : "ImageModuleAction",
"actionType" : "VisualSearch",
"data" : {
"value" : [
{
"webSearchUrl" : "https:\/\/www.bing.com\/images\/search?view=...",
"name" : "An apple pie...",
"thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?id=OIP.z...",
"datePublished" : "2017-03-18T00:17:00.0000000Z",
"contentUrl" : "http:\/\/contoso.net\/images\/8\/8a\/an_apple_pie.png",
"hostPageUrl" : "http:\/\/contoso.com\/wiki\/an_apple_pie.png",
"contentSize" : "87930 B",
"encodingFormat" : "png",
"hostPageDisplayUrl" : "contoso.com\/wiki\/an_apple_pie.png",
"width" : 263,
"height" : 192,
"thumbnail" : {
"width" : 474,
"height" : 346
},
"imageInsightsToken" : "ccid_zhRxfGkI*mid_1DCBA7AA6D231...",
"insightsMetadata" : {
"recipeSourcesCount" : 6,
"pagesIncludingCount" : 103,
"availableSizesCount" : 28
},
"imageId" : "1DCBA7AA6D23147F9DD06D47DB3A38EB25389",
"accentColor" : "3E0D01"
}
]
}
}
Recipes insight
The Recipes insight provides a list of webpages that include a recipe for making the food shown in the image. For example usage, see Recipes insight example.
{
"_type" : "ImageRecipesAction",
"actionType" : "Recipes",
"data" : {
"value" : [
{
"name" : "Granny's Apple Pie",
"url" : "http:\/\/contoso.com\/recipes\/appetizer\/apple-pie.html",
"description" : "I love Granny's apple pie. Sooooo delicious...",
"thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?id=A63002cd9",
"creator" : {
"_type" : "Person",
"name" : "Charlene Whitney"
},
"aggregateRating" : {
"text" : "5",
"ratingValue" : 5,
"bestRating" : 5,
"reviewCount" : 1
},
"cookTime" : "PT45M",
"prepTime" : "PT1H",
"totalTime" : "PT1H45M"
}
]
}
}
ImageById insight
The ImageById insight provides an Image object of the image that you requested insights for:
{
"image" : {
"webSearchUrl" : "https:\/\/www.bing.com\/images\/search?view=deta...",
"name" : "Making Apple Pie",
"thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?id=OIP...",
"datePublished" : "2013-06-21T12:00:00.0000000Z",
"contentUrl" : "http:\/\/contoso.com\/content\/uploads\/2013\/06\/apple-pie.jpg",
"hostPageUrl" : "http:\/\/contoso.com\/2013\/06\/21\/making-apple-pie\/",
"contentSize" : "134847 B",
"encodingFormat" : "jpeg",
"hostPageDisplayUrl" : "contoso.com\/2013\/06\/21\/making-apple-pie",
"width" : 1050,
"height" : 765,
"thumbnail" : {
"width" : 474,
"height" : 345
},
"imageInsightsToken" : "ccid_tmaGQ2eU*mid_D12339146CFE...",
"insightsMetadata" : {
"recipeSourcesCount" : 6,
"pagesIncludingCount" : 103,
"availableSizesCount" : 28
},
"imageId" : "D12339146CFEDF3D409A66D2C98D0D71904D4",
"accentColor" : "3A0B01"
},
"actionType" : "ImageById"
},
ProductVisualSearch insight
The ProductVisualSearch insight provides a list of images of products that are visually similar to products shown in the original image. The insightsMetadata field may contain information about offers where you can buy the product and the price of the product.
{
"_type" : "ImageModuleAction",
"actionType" : "ProductVisualSearch",
"data" : {
"value" : [
{
"webSearchUrl" : "https:\/\/www.bing.com\/images\/search?view=detail...",
"name" : "Contoso 4-Piece Kitchen Package...",
"thumbnailUrl" : "https:\/\/tse3.mm.bing.net\/th?id=OIP.l9hzaabu-RJd...",
"datePublished" : "2017-07-16T04:28:00.0000000Z",
"contentUrl" : "https:\/\/www.contoso.com\/assets\/media\/images\/prod...",
"hostPageUrl" : "https:\/\/www.contoso.com\/4-piece-kitchen-package...",
"contentSize" : "13594 B",
"encodingFormat" : "jpeg",
"hostPageDisplayUrl" : "https:\/\/www.contoso.com\/4-piece-kitchen-package...",
"width" : 450,
"height" : 332,
"thumbnail" : {
"width" : 474,
"height" : 349
},
"imageInsightsToken" : "ccid_l9hzaabu*mid_70A8B616355D681DB9A5A...",
"insightsMetadata" : {
"shoppingSourcesCount" : 1,
"recipeSourcesCount" : 0,
"aggregateOffer" : {
"name":"4-Piece Kitchen Package with...",
"priceCurrency":"USD",
"lowPrice":2756,
"offers" : [
{
"name" : "4-Piece Kitchen Package with...",
"url" : "https:\/\/www.fabrikam.com\/1234.html?ref=bing",
"description" : "This 36 Frenchdoor refrigerator by...",
"seller" : {
"name" : "Fabrikam",
"image" : {
"url" : "https:\/\/tse1.mm.bing.net\/th?id=A818f811..."
}
},
"price" : 2756,
"priceCurrency" : "USD",
"availability" : "InStock",
"lastUpdated" : "2018-02-20T00:00:00.0000000"
}
],
"offerCount":1
},
"pagesIncludingCount" : 4,
"availableSizesCount" : 2
},
"imageId" : "70A8B616355D681DA5980A8D0514BCC995A3",
"accentColor" : "60646B"
}
]
}
}
RelatedSearches insight
The RelatedSearches insight provides a list of related searches made by others (based on other users' search terms). For example usage, see RelatedSearches insight example.
{
"_type" : "ImageRelatedSearchesAction",
"actionType" : "RelatedSearches",
"data" : {
"value" : [
{
"text" : "Homemade Apple Pies Recipes",
"displayText" : "Homemade Apple Pies Recipes",
"webSearchUrl" : "https:\/\/www.bing.com\/images\/search?q=Homemade...",
"thumbnail" : {
"url" : "https:\/\/tse1.mm.bing.net\/th?q=Homemade+Apple+Pies"
}
}
]
}
}
DocumentLevelSuggestions insight
The DocumentLevelSuggestions insight provides a list of suggested search terms based on the contents of the image:
{
"_type" : "ImageRelatedSearchesAction",
"actionType" : "DocumentLevelSuggestions",
"data" : {
"value" : [
{
"text" : "American Apple Pie",
"displayText" : "American Apple Pie",
"webSearchUrl" : "https:\/\/www.bing.com\/images\/search?q=American",
"thumbnail" : {
"url" : "https:\/\/tse3.mm.bing.net\/th?q=American+Apple+Pie."
}
}
]
}
}
Next steps
Check out Examples of Bing insights usage to see how Bing might display the visual insights.
To get started quickly with your first request, see the quickstarts: