azure.cognitiveservices.search.visualsearch.models module¶

exception azure.cognitiveservices.search.visualsearch.models.ErrorResponseException(deserialize, response, *args)[source]¶

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters

deserialize – A deserializer
response – Server response to be deserialized.

class azure.cognitiveservices.search.visualsearch.models.Point2D(*, x: float, y: float, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue

Defines a 2D point with X and Y coordinates.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.
x (float) – Required. The x-coordinate of the point.
y (float) – Required. The y-coordinate of the point.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral(*, top_left, top_right, bottom_right, bottom_left, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue

Defines a region of an image. The region is a convex quadrilateral defined by coordinates of its top left, top right, bottom left, and bottom right points. The coordinates are fractional values of the original image’s width and height in the range 0.0 through 1.0.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.
top_left (Point2D) – Required. The top left corner coordinate.
top_right (Point2D) – Required. The top right corner coordinate.
bottom_right (Point2D) – Required. The bottom right corner coordinate.
bottom_left (Point2D) – Required. The bottom left corner coordinate.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.visualsearch.models.ImageTagRegion(*, query_rectangle, display_rectangle, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines an image region relevant to the ImageTag.

All required parameters must be populated in order to send to Azure.

Parameters

query_rectangle (NormalizedQuadrilateral) – Required. A rectangle that outlines the area of interest for this tag.
display_rectangle (NormalizedQuadrilateral) – Required. A recommended rectangle to show to the user.

class azure.cognitiveservices.search.visualsearch.models.ImageAction(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.action_py3.Action

Defines an image action.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageEntityAction, ImageModuleAction, ImageRecipesAction, ImageRelatedSearchesAction, ImageShoppingSourcesAction

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.
action_type (str) – A string representing the type of action.

class azure.cognitiveservices.search.visualsearch.models.ImageTag(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing

A visual search tag.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
display_name (str) – Display name for this tag. For the default tag, the display name is empty.
bounding_box (ImageTagRegion) – The bounding box for this tag. For the default tag, there is no bounding box.
actions (list[ImageAction]) – Actions within this tag. The order of the items denotes the default ranking order of these actions, with the first action being the most likely user intent.

class azure.cognitiveservices.search.visualsearch.models.Organization(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing

Defines an organization.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.visualsearch.models.AggregateRating(*, rating_value: float, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating

Defines the metrics that indicate how well an item was rated by others.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

text (str) – Text representation of an item.
best_rating (float) – The highest rated review. The possible values are 1.0 through 5.0.
review_count (int) – The number of times the recipe has been rated or reviewed.

Parameters

_type (str) – Required. Constant filled by server.
rating_value (float) – Required. The mean (average) rating. The possible values are 1.0 through 5.0.

class azure.cognitiveservices.search.visualsearch.models.Offer(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing

Defines a merchant’s offer.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AggregateOffer

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
seller (Organization) – Seller for this offer.
price (float) – The item’s price.
price_currency (str or Currency) – The monetary currency. For example, USD. Possible values include: ‘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’. Default value: “USD” .
availability (str or ItemAvailability) – The item’s availability. The following are the possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: ‘Discontinued’, ‘InStock’, ‘InStoreOnly’, ‘LimitedAvailability’, ‘OnlineOnly’, ‘OutOfStock’, ‘PreOrder’, ‘SoldOut’
aggregate_rating (AggregateRating) – An aggregated rating that indicates how well the product has been rated by others.
last_updated (str) – The last date that the offer was updated. The date is in the form YYYY-MM-DD.

class azure.cognitiveservices.search.visualsearch.models.AggregateOffer(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer

Defines a list of offers from merchants that are related to the image.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
seller (Organization) – Seller for this offer.
price (float) – The item’s price.
price_currency (str or Currency) – The monetary currency. For example, USD. Possible values include: ‘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’. Default value: “USD” .
availability (str or ItemAvailability) – The item’s availability. The following are the possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: ‘Discontinued’, ‘InStock’, ‘InStoreOnly’, ‘LimitedAvailability’, ‘OnlineOnly’, ‘OutOfStock’, ‘PreOrder’, ‘SoldOut’
aggregate_rating (AggregateRating) – An aggregated rating that indicates how well the product has been rated by others.
last_updated (str) – The last date that the offer was updated. The date is in the form YYYY-MM-DD.
offers (list[Offer]) – A list of offers from merchants that have offerings related to the image.

class azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a count of the number of websites where you can shop or perform other actions related to the image.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

shopping_sources_count (int) – The number of websites that sell the products seen in the image.
recipe_sources_count (int) – The number of websites that offer recipes of the food seen in the image.
aggregate_offer (AggregateOffer) – 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.

class azure.cognitiveservices.search.visualsearch.models.ImageObject(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject

Defines an image.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
content_url (str) – Original URL to retrieve the source (file) for the media object (e.g., the source URL for the image).
host_page_url (str) – URL of the page that hosts the media object.
content_size (str) – Size of the media object content. Use format “value unit” (e.g., “1024 B”).
encoding_format (str) – Encoding format (e.g., png, gif, jpeg, etc).
host_page_display_url (str) – Display URL of the page that hosts the media object.
width (int) – The width of the media object, in pixels.
height (int) – The height of the media object, in pixels.
thumbnail (ImageObject) – The URL to a thumbnail of the image.
image_insights_token (str) – The token that you use in a subsequent call to Visual Search API to get additional information about the image. For information about using this token, see the imageInsightsToken field inside the knowledgeRequest request parameter.
insights_metadata (ImagesImageMetadata) – 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 in a subsequent Visual Search API call to get the list of shopping websites.
image_id (str) – Unique Id for the image.
accent_color (str) – 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.
visual_words (str) – For internal use only.

class azure.cognitiveservices.search.visualsearch.models.ImageKnowledge(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.response_py3.Response

Defines a visual search API response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
tags (list[ImageTag]) – A list of visual search tags.
image (ImageObject) – Image object containing metadata about the requested image.

class azure.cognitiveservices.search.visualsearch.models.Response(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable

Defines a response. All schemas that return at the root of the response must inherit from this object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageKnowledge, ErrorResponse, Thing

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.

class azure.cognitiveservices.search.visualsearch.models.Identifiable(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase

Defines the identity of a resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Response

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters: _type (str) – Required. Constant filled by server.
Variables: id (str) – A String identifier.

class azure.cognitiveservices.search.visualsearch.models.Error(*, message: str, code='None', **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines the error that occurred.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

code (str or ErrorCode) – Required. The error code that identifies the category of error. Possible values include: ‘None’, ‘ServerError’, ‘InvalidRequest’, ‘RateLimitExceeded’, ‘InvalidAuthorization’, ‘InsufficientAuthorization’. Default value: “None” .
message (str) – Required. A description of the error.

Variables

sub_code (str or ErrorSubCode) – The error code that further helps to identify the error. Possible values include: ‘UnexpectedError’, ‘ResourceError’, ‘NotImplemented’, ‘ParameterMissing’, ‘ParameterInvalidValue’, ‘HttpNotAllowed’, ‘Blocked’, ‘AuthorizationMissing’, ‘AuthorizationRedundancy’, ‘AuthorizationDisabled’, ‘AuthorizationExpired’
more_details (str) – A description that provides additional information about the error.
parameter (str) – The parameter in the request that caused the error.
value (str) – The parameter’s value in the request that was not valid.

class azure.cognitiveservices.search.visualsearch.models.ErrorResponse(*, errors, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.response_py3.Response

The top-level response that represents a failed request.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.
errors (list[Error]) – Required. A list of errors that describe the reasons why the request failed.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.

class azure.cognitiveservices.search.visualsearch.models.Thing(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.response_py3.Response

Defines a thing.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageTag, Organization, Offer, CreativeWork, Person, Intangible

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.visualsearch.models.Action(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork

Defines an action.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageAction

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.

class azure.cognitiveservices.search.visualsearch.models.MediaObject(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork

Defines a media object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageObject

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
content_url (str) – Original URL to retrieve the source (file) for the media object (e.g., the source URL for the image).
host_page_url (str) – URL of the page that hosts the media object.
content_size (str) – Size of the media object content. Use format “value unit” (e.g., “1024 B”).
encoding_format (str) – Encoding format (e.g., png, gif, jpeg, etc).
host_page_display_url (str) – Display URL of the page that hosts the media object.
width (int) – The width of the media object, in pixels.
height (int) – The height of the media object, in pixels.

class azure.cognitiveservices.search.visualsearch.models.ResponseBase(**kwargs)[source]¶

Bases: msrest.serialization.Model

Response base.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Identifiable

All required parameters must be populated in order to send to Azure.

Parameters: _type (str) – Required. Constant filled by server.

class azure.cognitiveservices.search.visualsearch.models.CreativeWork(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing

The most generic kind of creative work, including books, movies, photographs, software programs, etc.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Action, MediaObject, Recipe

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.

class azure.cognitiveservices.search.visualsearch.models.Person(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing

Defines a person.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
job_title (str) – The person’s job title.
twitter_profile (str) – The URL of the person’s twitter profile.

class azure.cognitiveservices.search.visualsearch.models.Intangible(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing

A utility class that serves as the umbrella for a number of ‘intangible’ things such as quantities, structured values, etc.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: StructuredValue

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.visualsearch.models.ImageEntityAction(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction

Defines an entity action.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.
action_type (str) – A string representing the type of action.

class azure.cognitiveservices.search.visualsearch.models.ImagesModule(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a list of images.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[ImageObject]) – A list of images.

class azure.cognitiveservices.search.visualsearch.models.ImageModuleAction(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction

Defines an image list action.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.
action_type (str) – A string representing the type of action.
data (ImagesModule) – A list of images.

class azure.cognitiveservices.search.visualsearch.models.Recipe(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork

Defines a cooking recipe.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
cook_time (str) – The amount of time the food takes to cook. For example, PT25M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations.
prep_time (str) – The amount of time required to prepare the ingredients. For example, PT15M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations.
total_time (str) – The total amount of time it takes to prepare and cook the recipe. For example, PT45M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations.

class azure.cognitiveservices.search.visualsearch.models.RecipesModule(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a list of recipes.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[Recipe]) – A list of recipes.

class azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction

Defines an recipe action.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.
action_type (str) – A string representing the type of action.
data (RecipesModule) – A list of recipes related to the image.

class azure.cognitiveservices.search.visualsearch.models.Query(*, text: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a search query.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

text (str) – Required. The query string. Use this string as the query term in a new search request.

Variables

display_text (str) – The display version of the query term.
web_search_url (str) – The URL that takes the user to the Bing search results page for the query.
search_link (str) – 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.
thumbnail (ImageObject) – The URL to a thumbnail of a related image.

class azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a list of related searches.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[Query]) – A list of related searches.

class azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction

Defines an related search action.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.
action_type (str) – A string representing the type of action.
data (RelatedSearchesModule) – A list of queries related to the image.

class azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction

Defines a shopping sources action.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.
thumbnail_url (str) – The URL to a thumbnail of the item.
provider (list[Thing]) – The source of the creative work.
date_published (str) – The date on which the CreativeWork was published.
text (str) – Text content of this creative work.
result (list[Thing]) – The result produced in the action.
display_name (str) – A display name for the action.
is_top_action (bool) – A Boolean representing whether this result is the top action.
service_url (str) – Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.
action_type (str) – A string representing the type of action.
data (AggregateOffer) – A list of merchants that offer items related to the image.

class azure.cognitiveservices.search.visualsearch.models.StructuredValue(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible

StructuredValue.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Point2D, NormalizedQuadrilateral

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

_type (str) – Required. Constant filled by server.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.
web_search_url (str) – The URL to Bing’s search result for this item.
name (str) – The name of the thing represented by this object.
url (str) – The URL to get more information about the thing represented by this object.
image (ImageObject) – An image of the item.
description (str) – A short description of the item.
alternate_name (str) – An alias for the item.
bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.visualsearch.models.PropertiesItem(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines an item.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Rating

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables: text (str) – Text representation of an item.
Parameters: _type (str) – Required. Constant filled by server.

class azure.cognitiveservices.search.visualsearch.models.Rating(*, rating_value: float, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem

Defines a rating.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AggregateRating

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

text (str) – Text representation of an item.
best_rating (float) – The highest rated review. The possible values are 1.0 through 5.0.

Parameters

_type (str) – Required. Constant filled by server.
rating_value (float) – Required. The mean (average) rating. The possible values are 1.0 through 5.0.

class azure.cognitiveservices.search.visualsearch.models.CropArea(*, top: float, bottom: float, left: float, right: float, **kwargs)[source]¶

Bases: msrest.serialization.Model

A JSON object consisting of coordinates specifying the four corners of a cropped rectangle within the input image.

All required parameters must be populated in order to send to Azure.

Parameters

top (float) – Required. The top coordinate of the region to be cropped. The coordinate is a fractional value of the original image’s height and is measured from the top edge of the image. Specify the coordinate as a value from 0.0 through 1.0.
bottom (float) – Required. The bottom coordinate of the region to be cropped. The coordinate is a fractional value of the original image’s height and is measured from the top edge of the image. Specify the coordinate as a value from 0.0 through 1.0.
left (float) – Required. The left coordinate of the region to be cropped. The coordinate is a fractional value of the original image’s width and is measured from the left edge of the image. Specify the coordinate as a value from 0.0 through 1.0.
right (float) – Required. The right coordinate of the region to be cropped. The coordinate is a fractional value of the original image’s width and is measured from the left edge of the image. Specify the coordinate as a value from 0.0 through 1.0.

class azure.cognitiveservices.search.visualsearch.models.ImageInfo(*, image_insights_token: str = None, url: str = None, crop_area=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A JSON object that identities the image to get insights of . It also includes the optional crop area that you use to identify the region of interest in the image.

Parameters

image_insights_token (str) – 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.
url (str) – 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.
crop_area (CropArea) – 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.

class azure.cognitiveservices.search.visualsearch.models.Filters(*, site: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A key-value object consisting of filters that may be specified to limit the results returned by the API. Current available filters: site.

Parameters: site (str) – The URL of the site to return similar images and similar products from. (e.g., “www.bing.com”, “bing.com”).

class azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest(*, filters=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A JSON object containing information about the request, such as filters for the resulting actions.

Parameters: filters (Filters) – A key-value object consisting of filters that may be specified to limit the results returned by the API.

class azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest(*, image_info=None, knowledge_request=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A JSON object that contains information about the image to get insights of. Specify this object only in a knowledgeRequest form data.

Parameters

image_info (ImageInfo) – A JSON object that identities the image to get insights of.
knowledge_request (KnowledgeRequest) – A JSON object containing information about the request, such as filters, or a description.

class azure.cognitiveservices.search.visualsearch.models.Currency[source]¶

Bases: str, enum.Enum

An enumeration.

aed = 'AED'¶

afn = 'AFN'¶

all = 'ALL'¶

amd = 'AMD'¶

ang = 'ANG'¶

aoa = 'AOA'¶

ars = 'ARS'¶

aud = 'AUD'¶

awg = 'AWG'¶

azn = 'AZN'¶

bam = 'BAM'¶

bbd = 'BBD'¶

bdt = 'BDT'¶

bgn = 'BGN'¶

bhd = 'BHD'¶

bif = 'BIF'¶

bmd = 'BMD'¶

bnd = 'BND'¶

bob = 'BOB'¶

bov = 'BOV'¶

brl = 'BRL'¶

bsd = 'BSD'¶

btn = 'BTN'¶

bwp = 'BWP'¶

byr = 'BYR'¶

bzd = 'BZD'¶

cad = 'CAD'¶

cdf = 'CDF'¶

che = 'CHE'¶

chf = 'CHF'¶

chw = 'CHW'¶

clf = 'CLF'¶

clp = 'CLP'¶

cny = 'CNY'¶

cop = 'COP'¶

cou = 'COU'¶

crc = 'CRC'¶

cuc = 'CUC'¶

cup = 'CUP'¶

cve = 'CVE'¶

czk = 'CZK'¶

djf = 'DJF'¶

dkk = 'DKK'¶

dop = 'DOP'¶

dzd = 'DZD'¶

egp = 'EGP'¶

ern = 'ERN'¶

etb = 'ETB'¶

eur = 'EUR'¶

fjd = 'FJD'¶

fkp = 'FKP'¶

gbp = 'GBP'¶

gel = 'GEL'¶

ghs = 'GHS'¶

gip = 'GIP'¶

gmd = 'GMD'¶

gnf = 'GNF'¶

gtq = 'GTQ'¶

gyd = 'GYD'¶

hkd = 'HKD'¶

hnl = 'HNL'¶

hrk = 'HRK'¶

htg = 'HTG'¶

huf = 'HUF'¶

idr = 'IDR'¶

ils = 'ILS'¶

inr = 'INR'¶

iqd = 'IQD'¶

irr = 'IRR'¶

isk = 'ISK'¶

jmd = 'JMD'¶

jod = 'JOD'¶

jpy = 'JPY'¶

kes = 'KES'¶

kgs = 'KGS'¶

khr = 'KHR'¶

kmf = 'KMF'¶

kpw = 'KPW'¶

krw = 'KRW'¶

kwd = 'KWD'¶

kyd = 'KYD'¶

kzt = 'KZT'¶

lak = 'LAK'¶

lbp = 'LBP'¶

lkr = 'LKR'¶

lrd = 'LRD'¶

lsl = 'LSL'¶

lyd = 'LYD'¶

mad = 'MAD'¶

mdl = 'MDL'¶

mga = 'MGA'¶

mkd = 'MKD'¶

mmk = 'MMK'¶

mnt = 'MNT'¶

mop = 'MOP'¶

mro_enum = 'MRO'¶

mur = 'MUR'¶

mvr = 'MVR'¶

mwk = 'MWK'¶

mxn = 'MXN'¶

mxv = 'MXV'¶

myr = 'MYR'¶

mzn = 'MZN'¶

nad = 'NAD'¶

ngn = 'NGN'¶

nio = 'NIO'¶

nok = 'NOK'¶

npr = 'NPR'¶

nzd = 'NZD'¶

omr = 'OMR'¶

pab = 'PAB'¶

pen = 'PEN'¶

pgk = 'PGK'¶

php = 'PHP'¶

pkr = 'PKR'¶

pln = 'PLN'¶

pyg = 'PYG'¶

qar = 'QAR'¶

ron = 'RON'¶

rsd = 'RSD'¶

rub = 'RUB'¶

rwf = 'RWF'¶

sar = 'SAR'¶

sbd = 'SBD'¶

scr = 'SCR'¶

sdg = 'SDG'¶

sek = 'SEK'¶

sgd = 'SGD'¶

shp = 'SHP'¶

sll = 'SLL'¶

sos = 'SOS'¶

srd = 'SRD'¶

ssp = 'SSP'¶

std = 'STD'¶

syp = 'SYP'¶

szl = 'SZL'¶

thb = 'THB'¶

tjs = 'TJS'¶

tmt = 'TMT'¶

tnd = 'TND'¶

top = 'TOP'¶

try_enum = 'TRY'¶

ttd = 'TTD'¶

twd = 'TWD'¶

tzs = 'TZS'¶

uah = 'UAH'¶

ugx = 'UGX'¶

usd = 'USD'¶

uyu = 'UYU'¶

uzs = 'UZS'¶

vef = 'VEF'¶

vnd = 'VND'¶

vuv = 'VUV'¶

wst = 'WST'¶

xaf = 'XAF'¶

xcd = 'XCD'¶

xof = 'XOF'¶

xpf = 'XPF'¶

yer = 'YER'¶

zar = 'ZAR'¶

zmw = 'ZMW'¶

class azure.cognitiveservices.search.visualsearch.models.ItemAvailability[source]¶

Bases: str, enum.Enum

An enumeration.

discontinued = 'Discontinued'¶

in_stock = 'InStock'¶

in_store_only = 'InStoreOnly'¶

limited_availability = 'LimitedAvailability'¶

online_only = 'OnlineOnly'¶

out_of_stock = 'OutOfStock'¶

pre_order = 'PreOrder'¶

sold_out = 'SoldOut'¶

class azure.cognitiveservices.search.visualsearch.models.ErrorCode[source]¶

Bases: str, enum.Enum

An enumeration.

insufficient_authorization = 'InsufficientAuthorization'¶

invalid_authorization = 'InvalidAuthorization'¶

invalid_request = 'InvalidRequest'¶

none = 'None'¶

rate_limit_exceeded = 'RateLimitExceeded'¶

server_error = 'ServerError'¶

class azure.cognitiveservices.search.visualsearch.models.ErrorSubCode[source]¶

Bases: str, enum.Enum

An enumeration.

authorization_disabled = 'AuthorizationDisabled'¶

authorization_expired = 'AuthorizationExpired'¶

authorization_missing = 'AuthorizationMissing'¶

authorization_redundancy = 'AuthorizationRedundancy'¶

blocked = 'Blocked'¶

http_not_allowed = 'HttpNotAllowed'¶

not_implemented = 'NotImplemented'¶

parameter_invalid_value = 'ParameterInvalidValue'¶

parameter_missing = 'ParameterMissing'¶

resource_error = 'ResourceError'¶

unexpected_error = 'UnexpectedError'¶

class azure.cognitiveservices.search.visualsearch.models.SafeSearch[source]¶

Bases: str, enum.Enum

An enumeration.

moderate = 'Moderate'¶

off = 'Off'¶

strict = 'Strict'¶