Skip to content

[Visual Search] Additional documentation, add discriminator types, up… #3637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hovsepm merged 1 commit into from
Aug 16, 2018
Merged

[Visual Search] Additional documentation, add discriminator types, up… #3637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 62 additions & 8 deletions specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,39 @@
"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 <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/azure/cognitive-services/bing-visual-search/supported-countries-markets). 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/azure/cognitive-services/bing-visual-search/supported-countries-markets), Bing uses a best fit market code based on an internal mapping that is subject to change.",
"required": false,
"type": "string"
},
{
"name": "safeSearch",
"x-ms-client-name": "SafeSearch",
"in": "query",
"description": "Filter the image results in actions with type 'VisualSearch' for adult content. The following are the possible filter values. Off: May return images with adult content. Moderate: Do not return images with adult content. 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: filter in the knowledge request, 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. 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"
},
{
"name": "knowledgeRequest",
"x-ms-client-name": "VisualSearchRequest",
Expand All @@ -129,7 +162,7 @@
"name": "image",
"x-ms-client-name": "Image",
"in": "formData",
"description": "The form data is an image binary. The Content-Disposition header's filename parameter must be set to \"image\". You must specify an image binary if you do not use knowledgeRequest form data to specify the image; you may not use both forms to specify an image. You may specify knowledgeRequest form data and image form data in the same request only if knowledgeRequest form data specifies the cropArea field only (it must not include an insights token or URL).",
"description": "The form data is an image binary. The Content-Disposition header's name parameter must be set to \"image\". You must specify an image binary if you do not use knowledgeRequest form data to specify the image; you may not use both forms to specify an image. You may specify knowledgeRequest form data and image form data in the same request only if knowledgeRequest form data specifies the cropArea field only (it must not include an insights token or URL).",
"required": false,
"type": "file"
}
Expand Down Expand Up @@ -158,6 +191,7 @@
},
"definitions": {
"ImageKnowledge": {
"description": "Defines a visual search API response.",
"allOf": [
{
"$ref": "#/definitions/Response"
Expand Down Expand Up @@ -202,6 +236,7 @@
}
},
"ImageTag": {
"description": "A visual search tag.",
"allOf": [
{
"$ref": "#/definitions/Thing"
Expand Down Expand Up @@ -349,6 +384,7 @@
}
},
"Action": {
"description": "Defines an action.",
"allOf": [
{
"$ref": "#/definitions/CreativeWork"
Expand Down Expand Up @@ -382,6 +418,7 @@
}
},
"ImageTagRegion": {
"description": "Defines an image region relevant to the ImageTag.",
"type": "object",
"required": [
"queryRectangle",
Expand All @@ -399,17 +436,30 @@
}
},
"ImageAction": {
"description": "Defines an image action.",
"allOf": [
{
"$ref": "#/definitions/Action"
}
],
"type": "object",
"discriminator": "_type",
"properties": {
"actionType": {
"description": "A string representing the type of action.",
"readOnly": true,
"type": "string"
},
"_type": {
"type": "string",
"description": "Specifies the sub-class of the action.",
"enum": [
"ImageEntityAction",
"ImageModuleAction",
"ImageRecipesAction",
"ImageRelatedSearchesAction",
"ImageShoppingSourcesAction"
]
}
}
},
Expand Down Expand Up @@ -895,27 +945,24 @@
}
},
"ImageEntityAction": {
"description": "Defines an entity action.",
"allOf": [
{
"$ref": "#/definitions/ImageAction"
}
],
"type": "object",
"properties": {
"data": {
"description": "Information about the entity.",
"$ref": "#/definitions/Thing",
"readOnly": true
}
}
"x-ms-discriminator-value": "ImageEntityAction"
},
"ImageModuleAction": {
"description": "Defines an image list action.",
"allOf": [
{
"$ref": "#/definitions/ImageAction"
}
],
"type": "object",
"x-ms-discriminator-value": "ImageModuleAction",
"properties": {
"data": {
"description": "A list of images.",
Expand All @@ -925,12 +972,14 @@
}
},
"ImageRecipesAction": {
"description": "Defines an recipe action.",
"allOf": [
{
"$ref": "#/definitions/ImageAction"
}
],
"type": "object",
"x-ms-discriminator-value": "ImageRecipesAction",
"properties": {
"data": {
"description": "A list of recipes related to the image.",
Expand All @@ -940,12 +989,14 @@
}
},
"ImageRelatedSearchesAction": {
"description": "Defines an related search action.",
"allOf": [
{
"$ref": "#/definitions/ImageAction"
}
],
"type": "object",
"x-ms-discriminator-value": "ImageRelatedSearchesAction",
"properties": {
"data": {
"description": "A list of queries related to the image.",
Expand All @@ -955,12 +1006,14 @@
}
},
"ImageShoppingSourcesAction": {
"description": "Defines a shopping sources action.",
"allOf": [
{
"$ref": "#/definitions/ImageAction"
}
],
"type": "object",
"x-ms-discriminator-value": "ImageShoppingSourcesAction",
"properties": {
"data": {
"description": "A list of merchants that offer items related to the image.",
Expand Down Expand Up @@ -1092,6 +1145,7 @@
}
},
"Point2D": {
"description": "Defines a 2D point with X and Y coordinates.",
"allOf": [
{
"$ref": "#/definitions/StructuredValue"
Expand Down
72 changes: 17 additions & 55 deletions ...services/data-plane/VisualSearch/preview/v1.0/examples/SuccessfulVisualSearchRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,61 +57,23 @@
},
"actions":[
{
"_type":"ImageModuleAction",
"actionType":"Trivia",
"data":{
"value":[
{
"name":"Nickname for space needle",
"text":"the original nickname of the space needle was \"the space cage.\". the original name of the restaurant was \"eye of the needle.\". from the time of its construction, the space needle has always had a light atop the structure. the most recent version is the legacy light, first illuminated on new year's eve 1999\/2000.",
"hostPageUrl":"http:\/\/spaceneedle.webs.com\/fun-facts"
},
{
"name":"Who commissioned the space needle",
"text":"the space needle was commissioned as part of the 1962 world's fair hosted in seattle. the theme of that year's fair was \"century 21,\" which helps to explain the space needle's futuristic design. edward carlson came up with the original designs, which had a top that resembled a floating balloon.",
"hostPageUrl":"http:\/\/traveltips.usatoday.com\/seattle-space-needle-12040.html"
},
{
"name":"Downtown seattle by the space needle",
"text":"built for the 1962 world’s fair, the space needle is located just north of the downtown area at seattle center. upon opening, it drew over 2 million visitors - nearly 20,000 per day during the world's fair!",
"hostPageUrl":"http:\/\/www.paramounthotelseattle.com\/explore-seattle\/space-needle.htm"
},
{
"name":"Why is the space needle important",
"text":"No. The Space Needle is too small to be seen from space. The only man made structure you can see from space is the Great Wall of China. I'm ten years old.",
"hostPageUrl":"http:\/\/www.answers.com\/Q\/Why_is_the_space_needle_important"
},
{
"name":"What does the space needle have inside of it",
"text":"making the world better, one answer at a time. inside the space needle is the observation deck which is the very top floor. the second floor of the space need which is directly under neath that is a restaurant, that has a moving floor that goes in circle, so while you eat you get the entire view of seattle.",
"hostPageUrl":"http:\/\/www.answers.com\/q\/what_is_inside_the_space_needle"
},
{
"name":"12 Flag Space Needle Raising",
"text":"The Seahawks' 12 MAN Flag was risen atop the Space Needle on the Friday before the game against the Washington Redskins.",
"hostPageUrl":"http:\/\/www.seahawks.com\/galleries\/2013\/01\/05\/12-flag-space-needle-raising"
},
{
"name":"How tall is the space needle with the antenna and spire",
"text":"once the tallest structure west of the mississippi river, it is 605 ft (184 m) high, 138 ft (42 m) wide, and weighs 9,550 tons.",
"hostPageUrl":"http:\/\/en.wikipedia.org\/wiki\/space_needle"
},
{
"name":"Where is the space needle in washington seattle",
"text":"the space needle is a landmark of the pacific northwest and an icon of downtown seattle. it was built in the seattle center for the 1962 world's fair. today, nearly 20,000 people ride its elevators every 24 hours.",
"hostPageUrl":"http:\/\/viator.com\/tours\/seattle\/seattle-space-needle-observation-deck-admission\/d704-5929gen"
},
{
"name":"When was the space needle built in gatlinburg",
"text":"the gatlinburg space needle, which originally opened in 1970, is probably the most iconic attraction in gatlinburg, tn. the space needle towers high over the parkway at a height of 407 feet and offers visitors the chance to view the smoky mountains from a 360 degree platform.",
"hostPageUrl":"http:\/\/smokymountains.com\/attractions\/gatlinburg-space-needle"
},
{
"name":"Did lightning hit the space needle",
"text":"during an afternoon storm, lightning hit the space needle, lighting up the observation tower. twenty-five lightning rods, including the spire itself, scatter the roof of the needle in an attempt to protect the building from lightning strikes, according to the space needle website.",
"hostPageUrl":"http:\/\/www.nydailynews.com\/news\/national\/space-needle-struck-lightning-seattle-storm-article-1.2984070"
}
]
"_type":"ImageAction",
"actionType":"ImageById",
"image":{
"webSearchUrl":"https:\/\/www.bing.com\/images\/search?view=detailv2&FORM=OIIRPO",
"name":"",
"contentUrl":"https:\/\/assets0.roadtrippers.com\/uploads\/poi_gallery_image\/image\/319703805\/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480\/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg",
"hostPageUrl":"https:\/\/assets0.roadtrippers.com\/uploads\/poi_gallery_image\/image\/319703805\/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480\/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg",
"contentSize":"47157 B",
"encodingFormat":"jpeg",
"hostPageDisplayUrl":"https:\/\/assets0.roadtrippers.com\/uploads\/poi_gallery_image\/image\/319703805\/-quality_60_-interlace_Plane_-resize_1024x480_U__-gravity_center_-extent_1024x480\/poi_gallery_image-image-9e436dcb-f4af-4965-9fd6-d526b1af1758.jpg",
"width":1024,
"height":480,
"thumbnail":{
"width":0,
"height":0
},
"accentColor":"31749A"
}
}
]
Expand Down