Skip to content
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

Jump to bottom

[Visual Search API] Remove read-only property on input parameters #3018

Merged
merged 1 commit into from
May 4, 2018
Merged

[Visual Search API] Remove read-only property on input parameters #3018

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
15 changes: 4 additions & 11 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 @@ -1188,13 +1188,11 @@
"properties": {
"imageInfo": {
"description": "A JSON object that identities the image to get insights of.",
"$ref": "#/definitions/ImageInfo",
"readOnly": true
"$ref": "#/definitions/ImageInfo"
},
"knowledgeRequest": {
"description": "A JSON object containing information about the request, such as filters, or a description.",
"$ref": "#/definitions/KnowledgeRequest",
"readOnly": true
"$ref": "#/definitions/KnowledgeRequest"
}
}
},
Expand All @@ -1204,18 +1202,15 @@
"properties": {
"imageInsightsToken": {
"description": "An image insights token. To get the insights token, call one of the Image Search APIs (for example, /images/search). In the search results, the [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image) object's [imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken) field contains the token. The imageInsightsToken and url fields mutually exclusive; do not specify both. Do not specify an insights token if the request includes the image form data.",
"readOnly": true,
"type": "string"
},
"url": {
"description": "The URL of the input image. The imageInsightsToken and url fields are mutually exclusive; do not specify both. Do not specify the URL if the request includes the image form data.",
"readOnly": true,
"type": "string"
},
"cropArea": {
"description": "A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image. Use the crop area to identify the region of interest in the image. You can apply the crop area to the images specified using the imageInsightsToken or url fields, or an image binary specified in an image form data.",
"$ref": "#/definitions/CropArea",
"readOnly": true
"$ref": "#/definitions/CropArea"
}
}
},
Expand Down Expand Up @@ -1257,8 +1252,7 @@
"properties": {
"filters": {
"description": "A key-value object consisting of filters that may be specified to limit the results returned by the API.",
"$ref": "#/definitions/Filters",
"readOnly": true
"$ref": "#/definitions/Filters"
}
}
},
Expand All @@ -1268,7 +1262,6 @@
"properties": {
"site": {
"description": "The URL of the site to return similar images and similar products from. (e.g., \"www.bing.com\", \"bing.com\").",
"readOnly": true,
"type": "string"
}
}
Expand Down
2 changes: 1 addition & 1 deletion ...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
@@ -1,7 +1,7 @@
{
"parameters": {
"X-BingApis-SDK": "true",
"Content-Type": "application/json",
"Content-Type": "multipart/form-data",
"Ocp-Apim-Subscription-Key": "{API key}",
"image": "multipart-form-data",
"knowledgeRequest": "{\r\n \"imageInfo\": {\r\n \"imageInsightsToken\": \"{Image Insights Token}\",\r\n \"url\": \"{Image URL}\",\r\n \"cropArea\": {\r\n \"top\": \"0.1\",\r\n \"bottom\": \"0.9\",\r\n \"left\": \"0.1\",\r\n \"right\": \"0.9\"\r\n }\r\n }\r\n }"
Expand Down