azure.cognitiveservices.search.imagesearch.models module¶

exception azure.cognitiveservices.search.imagesearch.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.imagesearch.models.AggregateOffer(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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.imagesearch.models.AggregateRating(*, rating_value: float, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.imagesearch.models.Answer(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Response

Defines an answer.

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

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.
web_search_url (str) – The URL To Bing’s search result for this item.

class azure.cognitiveservices.search.imagesearch.models.CollectionPage(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.WebPage

Defines a link to a webpage that contains a collection.

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

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.
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.imagesearch.models.CreativeWork(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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: MediaObject, Recipe, WebPage

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.
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.imagesearch.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.imagesearch.models.ErrorResponse(*, errors, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
web_search_url (str) – The URL To Bing’s search result for this item.

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

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.imagesearch.models.ImageGallery(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.CollectionPage

Defines a link to a webpage that contains a collection of related images.

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.
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
source (str) – The publisher or social network where the images were found. You must attribute the publisher as the source where the collection was found.
images_count (long) – The number of related images found in the collection.
followers_count (long) – The number of users on the social network that follow the creator.

class azure.cognitiveservices.search.imagesearch.models.ImageInsights(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Response

The top-level object that the response includes when an image insights request succeeds. For information about requesting image insights, see the [insightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#insightstoken) query parameter. The modules query parameter affects the fields that Bing includes in the response. If you set [modules](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#modulesrequested) to only Caption, then this object includes only the imageCaption field.

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.
web_search_url (str) – The URL To Bing’s search result for this item.
image_insights_token (str) – A token that you use in a subsequent call to the Image Search API to get more information about the image. For information about using this token, see the insightsToken query parameter. This token has the same usage as the token in the Image object.
best_representative_query (Query) – The query term that best represents the image. Clicking the link in the Query object, takes the user to a webpage with more pictures of the image.
image_caption (ImageInsightsImageCaption) – The caption to use for the image.
related_collections (RelatedCollectionsModule) – A list of links to webpages that contain related images.
pages_including (ImagesModule) – A list of webpages that contain the image. To access the webpage, use the URL in the image’s hostPageUrl field.
shopping_sources (AggregateOffer) – A list of merchants that offer items related to the image. For example, if the image is of an apple pie, the list contains merchants that are selling apple pies.
related_searches (RelatedSearchesModule) – A list of related queries made by others.
recipes (RecipesModule) – A list of recipes related to the image. For example, if the image is of an apple pie, the list contains recipes for making an apple pie.
visually_similar_images (ImagesModule) – A list of images that are visually similar to the original image. For example, if the specified image is of a sunset over a body of water, the list of similar images are of a sunset over a body of water. If the specified image is of a person, similar images might be of the same person or they might be of persons dressed similarly or in a similar setting. The criteria for similarity continues to evolve.
visually_similar_products (ImagesModule) – A list of images that contain products that are visually similar to products found in the original image. For example, if the specified image contains a dress, the list of similar images contain a dress. The image provides summary information about offers that Bing found online for the product.
recognized_entity_groups (RecognizedEntitiesModule) – A list of groups that contain images of entities that match the entity found in the specified image. For example, the response might include images from the general celebrity group if the entity was recognized in that group.
image_tags (ImageTagsModule) – A list of characteristics of the content found in the image. For example, if the image is of a person, the tags might indicate the person’s gender and the type of clothes they’re wearing.

class azure.cognitiveservices.search.imagesearch.models.ImageInsightsImageCaption(*, caption: str, data_source_url: str, related_searches, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines an image’s caption.

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

Parameters

caption (str) – Required. A caption about the image.
data_source_url (str) – Required. The URL to the website where the caption was found. You must attribute the caption to the source. For example, by displaying the domain name from the URL next to the caption and using the URL to link to the source website.
related_searches (list[Query]) – Required. A list of entities found in the caption. Use the contents of the Query object to find the entity in the caption and create a link. The link takes the user to images of the entity.

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

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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 mp3, mp4, jpeg, etc).
host_page_display_url (str) – Display URL of the page that hosts the media object.
width (int) – The width of the source media object, in pixels.
height (int) – The height of the source 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 the Image Search API to get additional information about the image. For information about using this token, see the insightsToken query 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 to get the list of 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) – Visual representation of the image. Used for getting more sizes

class azure.cognitiveservices.search.imagesearch.models.Images(*, value, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.SearchResultsAnswer

Defines an image answer.

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.
value (list[ImageObject]) – Required. A list of image objects that are relevant to the query. If there are no results, the List is empty.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource.
web_search_url (str) – The URL To Bing’s search result for this item.
total_estimated_matches (long) – The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.
next_offset (int) – Used as part of deduping. Tells client the next offset that client should use in the next pagination request
query_expansions (list[Query]) – A list of expanded queries that narrows the original query. For example, if the query was Microsoft Surface, the expanded queries might be: Microsoft Surface Pro 3, Microsoft Surface RT, Microsoft Surface Phone, and Microsoft Surface Hub.
pivot_suggestions (list[PivotSuggestions]) – A list of segments in the original query. For example, if the query was Red Flowers, Bing might segment the query into Red and Flowers. The Flowers pivot may contain query suggestions such as Red Peonies and Red Daisies, and the Red pivot may contain query suggestions such as Green Flowers and Yellow Flowers.
similar_terms (list[Query]) – A list of terms that are similar in meaning to the user’s query term.

class azure.cognitiveservices.search.imagesearch.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 offer goods of 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.imagesearch.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.imagesearch.models.ImageTagsModule(*, value, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines the characteristics of content found in an image.

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

Parameters: value (list[InsightsTag]) – Required. A list of tags that describe the characteristics of the content found in the image. For example, if the image is of a musical artist, the list might include Female, Dress, and Music to indicate the person is female music artist that’s wearing a dress.

class azure.cognitiveservices.search.imagesearch.models.InsightsTag(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a characteristic of the content found in the image.

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

Variables: name (str) – The name of the characteristic. For example, cat, kitty, calico cat.

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

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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.imagesearch.models.MediaObject(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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 mp3, mp4, jpeg, etc).
host_page_display_url (str) – Display URL of the page that hosts the media object.
width (int) – The width of the source media object, in pixels.
height (int) – The height of the source media object, in pixels.

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

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.StructuredValue

Defines a region of an image. The region is defined by the coordinates of the top, left corner and bottom, right corner of the region. 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.
left (float) – Required. The left coordinate.
top (float) – Required. The top coordinate
right (float) – Required. The right coordinate
bottom (float) – Required. The bottom coordinate

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource.
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.imagesearch.models.Offer(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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.imagesearch.models.Organization(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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.imagesearch.models.Person(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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.imagesearch.models.PivotSuggestions(*, pivot: str, suggestions, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines the pivot segment.

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

Parameters

pivot (str) – Required. The segment from the original query to pivot on.
suggestions (list[Query]) – Required. A list of suggested queries for the pivot.

class azure.cognitiveservices.search.imagesearch.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.imagesearch.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. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting
web_search_url (str) – The URL that takes the user to the Bing search results page for the query.Only related search results include this field.
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.imagesearch.models.Rating(*, rating_value: float, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.imagesearch.models.Recipe(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_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.
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.imagesearch.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.imagesearch.models.RecognizedEntitiesModule(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a list of previously recognized entities.

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

Variables: value (list[RecognizedEntityGroup]) – A list of recognized entities.

class azure.cognitiveservices.search.imagesearch.models.RecognizedEntity(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Response

Defines a recognized entity.

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.
web_search_url (str) – The URL To Bing’s search result for this item.
entity (Thing) – The entity that was recognized. The following are the possible entity objects: Person
match_confidence (float) – The confidence that Bing has that the entity in the image matches this entity. The confidence ranges from 0.0 through 1.0 with 1.0 being very confident.

class azure.cognitiveservices.search.imagesearch.models.RecognizedEntityGroup(*, recognized_entity_regions, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a group of previously recognized entities.

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

Parameters

recognized_entity_regions (list[RecognizedEntityRegion]) – Required. The regions of the image that contain entities.
name (str) – Required. The name of the group where images of the entity were also found. The following are possible groups. CelebRecognitionAnnotations: Similar to CelebrityAnnotations but provides a higher probability of an accurate match. CelebrityAnnotations: Contains celebrities such as actors, politicians, athletes, and historical figures.

class azure.cognitiveservices.search.imagesearch.models.RecognizedEntityRegion(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Response

Defines a region of the image where an entity was found and a list of entities that might match it.

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.
web_search_url (str) – The URL To Bing’s search result for this item.
region (NormalizedRectangle) – A region of the image that contains an entity. The values of the rectangle are relative to the width and height of the original image and are in the range 0.0 through 1.0. For example, if the image is 300x200 and the region’s top, left corner is at point (10, 20) and the bottom, right corner is at point (290, 150), then the normalized rectangle is: Left = 0.0333333333333333, Top = 0.1, Right = 0.9666666666666667, Bottom = 0.75. For people, the region represents the person’s face.
matching_entities (list[RecognizedEntity]) – A list of entities that Bing believes match the entity found in the region. The entities are in descending order of confidence (see the matchConfidence field of RecognizedEntity).

class azure.cognitiveservices.search.imagesearch.models.RelatedCollectionsModule(**kwargs)[source]¶

Bases: msrest.serialization.Model

Defines a list of webpages that contain related images.

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

Variables: value (list[ImageGallery]) – A list of webpages that contain related images.

class azure.cognitiveservices.search.imagesearch.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.imagesearch.models.Response(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Identifiable

Defines a response. All schemas that could be returned at the root of a response should inherit from this.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Answer, Thing, ErrorResponse, RecognizedEntity, RecognizedEntityRegion, ImageInsights, TrendingImages

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.
web_search_url (str) – The URL To Bing’s search result for this item.

class azure.cognitiveservices.search.imagesearch.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.imagesearch.models.SearchResultsAnswer(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Answer

Defines a search result answer.

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

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.
web_search_url (str) – The URL To Bing’s search result for this item.
total_estimated_matches (long) – The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.

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

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Intangible

StructuredValue.

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

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.
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.imagesearch.models.Thing(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Response

Defines a thing.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: 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.
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.imagesearch.models.TrendingImages(*, categories, **kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.Response

The top-level object that the response includes when a trending images request succeeds.

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.
categories (list[TrendingImagesCategory]) – Required. A list that identifies categories of images and a list of trending images in that category.

Variables

id (str) – A String identifier.
read_link (str) – The URL that returns this resource.
web_search_url (str) – The URL To Bing’s search result for this item.

class azure.cognitiveservices.search.imagesearch.models.TrendingImagesCategory(*, title: str, tiles, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines the category of trending images.

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

Parameters

title (str) – Required. The name of the image category. For example, Popular People Searches.
tiles (list[TrendingImagesTile]) – Required. A list of images that are trending in the category. Each tile contains an image and a URL that returns more images of the subject. For example, if the category is Popular People Searches, the image is of a popular person and the URL would return more images of that person.

class azure.cognitiveservices.search.imagesearch.models.TrendingImagesTile(*, query, image, **kwargs)[source]¶

Bases: msrest.serialization.Model

Defines an image tile.

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

Parameters

query (Query) – Required. A query that returns a Bing search results page with more images of the subject. For example, if the category is Popular People Searches, then the thumbnail is of a popular person. The query would return a Bing search results page with more images of that person.
image (ImageObject) – Required. The image’s thumbnail.

class azure.cognitiveservices.search.imagesearch.models.WebPage(**kwargs)[source]¶

Bases: azure.cognitiveservices.search.imagesearch.models._models_py3.CreativeWork

Defines a webpage that is relevant to the query.

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

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.
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.imagesearch.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.imagesearch.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.imagesearch.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.imagesearch.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.imagesearch.models.ImageAspect[source]¶

Bases: str, enum.Enum

An enumeration.

all = 'All'¶

square = 'Square'¶

tall = 'Tall'¶

wide = 'Wide'¶

class azure.cognitiveservices.search.imagesearch.models.ImageColor[source]¶

Bases: str, enum.Enum

An enumeration.

black = 'Black'¶

blue = 'Blue'¶

brown = 'Brown'¶

color_only = 'ColorOnly'¶

gray = 'Gray'¶

green = 'Green'¶

monochrome = 'Monochrome'¶

orange = 'Orange'¶

pink = 'Pink'¶

purple = 'Purple'¶

red = 'Red'¶

teal = 'Teal'¶

white = 'White'¶

yellow = 'Yellow'¶

class azure.cognitiveservices.search.imagesearch.models.Freshness[source]¶

Bases: str, enum.Enum

An enumeration.

day = 'Day'¶

month = 'Month'¶

week = 'Week'¶

class azure.cognitiveservices.search.imagesearch.models.ImageContent[source]¶

Bases: str, enum.Enum

An enumeration.

face = 'Face'¶

portrait = 'Portrait'¶

class azure.cognitiveservices.search.imagesearch.models.ImageType[source]¶

Bases: str, enum.Enum

An enumeration.

animated_gif = 'AnimatedGif'¶

clipart = 'Clipart'¶

line = 'Line'¶

photo = 'Photo'¶

shopping = 'Shopping'¶

transparent = 'Transparent'¶

class azure.cognitiveservices.search.imagesearch.models.ImageLicense[source]¶

Bases: str, enum.Enum

An enumeration.

all = 'All'¶

any = 'Any'¶

modify = 'Modify'¶

modify_commercially = 'ModifyCommercially'¶

public = 'Public'¶

share = 'Share'¶

share_commercially = 'ShareCommercially'¶

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

Bases: str, enum.Enum

An enumeration.

moderate = 'Moderate'¶

off = 'Off'¶

strict = 'Strict'¶

class azure.cognitiveservices.search.imagesearch.models.ImageSize[source]¶

Bases: str, enum.Enum

An enumeration.

all = 'All'¶

large = 'Large'¶

medium = 'Medium'¶

small = 'Small'¶

wallpaper = 'Wallpaper'¶

class azure.cognitiveservices.search.imagesearch.models.ImageCropType[source]¶

Bases: str, enum.Enum

An enumeration.

rectangular = 'Rectangular'¶

class azure.cognitiveservices.search.imagesearch.models.ImageInsightModule[source]¶

Bases: str, enum.Enum

An enumeration.

all = 'All'¶

brq = 'BRQ'¶

caption = 'Caption'¶

collections = 'Collections'¶

pages_including = 'PagesIncluding'¶

recipes = 'Recipes'¶

recognized_entities = 'RecognizedEntities'¶

related_searches = 'RelatedSearches'¶

shopping_sources = 'ShoppingSources'¶

similar_images = 'SimilarImages'¶

similar_products = 'SimilarProducts'¶

tags = 'Tags'¶