Response
The following JSON data is required to render your result as a public search results that users will see when using visual search:
Fields | ||
---|---|---|
previewText | String | Preview text that appear in the public search result as a short description of the what your skill does |
imageUri | URI | URI of image that will appear in the public search results |
clickthroughUri | URI | URI that users navigates users to a new page when they click on your search result |
JSON Sample - InfoCardWithActions
{
"results": [
{
"tags": [
{
"actions": [
{
"actionType": "Custom",
"customData": {
"template": "InfoCardWithActions",
"title": "swan",
"subTitle": "Animal",
"imageUri": "https://upload.wikimedia.org/wikipedia/commons/1/14/Animal_diversity.png",
"clickthroughUri": "https://www.bing.com/images/search?q=swan",
"description": "We found 8 annotation(s) for the query image. They are: swan, mute swan, white swans, trumpeter swan, swans birds, tundra swan, mutes, birds.",
"actions": [
{
"actionLogoUri": "https://upload.wikimedia.org/wikipedia/commons/d/de/Wikipedia_Logo_1.0.png",
"actionText": "Search Wikipedia",
"actionClickThroughUri": "https://en.wikipedia.org/wiki/swan"
},
{
"actionLogoUri": "https://c.s-microsoft.com/en-us/CMSImages/BingLogo.png?version=23e74020-f1ba-f831-f846-04a1ba5959ed",
"actionText": "Search Bing",
"actionClickThroughUri": "https://www.bing.com/images/search?q=swan"
}
]
},
"providerName": "Bing Visual Skills SDK - Animal"
}
]
}
]
}
]
}
JSON Sample - ProductsList
{
"results": [
{
"tags": [
{
"actions": [
{
"actionType": "Custom",
"customData": {
"template": "ProductsList",
"items": [
{
"imageUri": "https://www.bing.com/th?u=https%3A%2F%2Fimages-eu.ssl-images-amazon.com%2Fimages%2FI%2F41Pxk2eEfeL._SL200_.jpg&ehk=HgU9WkI2cASEwOdOYmizYg&pid=ScandidSkill",
"clickthroughUri": "http://scandid.in/redirect?ref=REFTEMP&productid=product_az_3lksp54i5j9rn&store=amazon&title=shineconfidence-sunflower-hair-accessories-hair-clip-for-women-flower-hair-clutcher-hair-pins-for-women-and-girls-2-pcs-yellow-black&email=dummy@scandid.in&pid=edge&price=249.0&u=https%3A%2F%2Fwww.amazon.in%2Fdp%2FB07NC75XFC%3Ftag%3Dshoppingwish-21%26ascsubtag%3DTEMPXYZ786&sc=1",
"name": "ShineConfidence Sunflower Hair Accessories Hair Clip For Women Flower Hair Clutcher Hair Pins For Women And Girls, 2 Pcs (Yellow + Black)",
"price": "₹499.00",
"pricePromotion": "₹249.00",
"pricePromotionText": "50% off",
"seller": "amazon",
"availability": "InStock",
"productRating": 0.0
},
{
"imageUri": "https://www.bing.com/th?u=https%3A%2F%2Fimages-eu.ssl-images-amazon.com%2Fimages%2FI%2F61iu4LaTEOL._SL200_.jpg&ehk=Q2v5SqlwiAJW40KaW5wxlg&pid=ScandidSkill",
"clickthroughUri": "http://scandid.in/redirect?ref=REFTEMP&productid=product_az_cq360c38a1a35&store=amazon&title=banggood-electroprime-polyester-sunflower-shower-curtain-hook-set-bath-accessories-hanging-panel&email=dummy@scandid.in&pid=edge&price=4303.0&u=https%3A%2F%2Fwww.amazon.in%2Fdp%2FB07BJ592HT%3Ftag%3Dshoppingwish-21%26ascsubtag%3DTEMPXYZ786&sc=1",
"name": "Banggood ELECTROPRIME® Polyester Sunflower Shower Curtain Hook Set Bath Accessories Hanging Panel",
"brand": "Banggood",
"price": "₹4,303.00",
"pricePromotion": "₹0.00",
"seller": "amazon",
"availability": "InStock",
"productRating": 0.0
}
]
},
"providerName": "ScandidSkill"
}
]
}
]
}
]
}
JSON Sample - Adaptive cards
{
"results": [
{
"tags": [
{
"actions": [
{
"actionType": "Custom",
"customData": {
"template": "AdaptiveCards",
"cardjson": "{\"type\":\"AdaptiveCard\",\"body\":[{\"type\":\"TextBlock\",\"size\":\"Medium\",\"weight\":\"Bolder\",\"text\":\"Publish Adaptive Card schema\"},{\"type\":\"ColumnSet\",\"columns\":[{\"type\":\"Column\",\"items\":[{\"type\":\"Image\",\"style\":\"Person\",\"url\":\"https:\/\/pbs.twimg.com\/profile_images\/3647943215\/d7f12830b3c17a5a9e4afcc370e3a37e_400x400.jpeg\",\"size\":\"Small\"}],\"width\":\"auto\"},{\"type\":\"Column\",\"items\":[{\"type\":\"TextBlock\",\"weight\":\"Bolder\",\"text\":\"Matt Hidinger\",\"wrap\":true},{\"type\":\"TextBlock\",\"spacing\":\"None\",\"text\":\"Created{{DATE(2017-02-14T06:08:39Z,SHORT)}}\",\"isSubtle\":true,\"wrap\":true}],\"width\":\"stretch\"}]},{\"type\":\"TextBlock\",\"text\":\"Now that we have defined the main rules and features of the format, we need to produce a schema and publish it to GitHub. The schema will be the starting point of our reference documentation.\",\"wrap\":true},{\"type\":\"FactSet\",\"facts\":[{\"title\":\"Board:\",\"value\":\"AdaptiveCard\"},{\"title\":\"List:\",\"value\":\"Backlog\"},{\"title\":\"Assignedto:\",\"value\":\"Matt Hidinger\"},{\"title\":\"Duedate:\",\"value\":\"Notset\"}]}],\"actions\":[{\"type\":\"Action.ShowCard\",\"title\":\"Set due date\",\"card\":{\"type\":\"AdaptiveCard\",\"body\":[{\"type\":\"Input.Date\",\"id\":\"dueDate\"},{\"type\":\"Input.Text\",\"id\":\"comment\",\"placeholder\":\"Addacomment\",\"isMultiline\":true}],\"actions\":[{\"type\":\"Action.OpenUrl\",\"title\":\"OK\",\"url\":\"https:\/\/adaptivecards.io\"}],\"$schema\":\"http:\/\/adaptivecards.io\/schemas\/adaptive-card.json\"}},{\"type\":\"Action.OpenUrl\",\"title\":\"View\",\"url\":\"https:\/\/adaptivecards.io\"}],\"$schema\":\"http:\/\/adaptivecards.io\/schemas\/adaptive-card.json\",\"version\":\"1.0\"}"
},
"providerName": "Bing Visual Skills SDK - Entities"
}
]
}
]
}
]
}