azure.cognitiveservices.search.entitysearch.models module

exception azure.cognitiveservices.search.entitysearch.models.ErrorResponseException(deserialize, response, *args)

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.entitysearch.models.Airport(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.CivicStructure

Airport.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• iata_code (str) –

• icao_code (str) –

class azure.cognitiveservices.search.entitysearch.models.Answer(**kwargs)

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

class azure.cognitiveservices.search.entitysearch.models.CivicStructure(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.Place

CivicStructure.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

class azure.cognitiveservices.search.entitysearch.models.ContractualRulesAttribution(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.ContractualRulesContractualRule

ContractualRulesAttribution.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContractualRulesLicenseAttribution, ContractualRulesLinkAttribution, ContractualRulesMediaAttribution, ContractualRulesTextAttribution

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

• target_property_name (str) – The name of the field that the rule applies to.

• must_be_close_to_content (bool) – A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller’s discretion.

Parameters

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

class azure.cognitiveservices.search.entitysearch.models.ContractualRulesContractualRule(**kwargs)

Bases: msrest.serialization.Model

ContractualRulesContractualRule.

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

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

target_property_name (str) – The name of the field that the rule applies to.

Parameters

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

class azure.cognitiveservices.search.entitysearch.models.ContractualRulesLicenseAttribution(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.ContractualRulesAttribution

Defines a contractual rule for license attribution.

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

• target_property_name (str) – The name of the field that the rule applies to.

• must_be_close_to_content (bool) – A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller’s discretion.

• license (License) – The license under which the content may be used.

• license_notice (str) – The license to display next to the targeted field.

Parameters

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

class azure.cognitiveservices.search.entitysearch.models.ContractualRulesLinkAttribution(*, text: str, url: str, **kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.ContractualRulesAttribution

Defines a contractual rule for link attribution.

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

• target_property_name (str) – The name of the field that the rule applies to.

• must_be_close_to_content (bool) – A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller’s discretion.

• optional_for_list_display (bool) – Indicates whether this provider’s attribution is optional.

Parameters

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

• text (str) – Required. The attribution text.

• url (str) – Required. The URL to the provider’s website. Use text and URL to create the hyperlink.

class azure.cognitiveservices.search.entitysearch.models.ContractualRulesMediaAttribution(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.ContractualRulesAttribution

Defines a contractual rule for media attribution.

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

• target_property_name (str) – The name of the field that the rule applies to.

• must_be_close_to_content (bool) – A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller’s discretion.

• url (str) – The URL that you use to create of hyperlink of the media content. For example, if the target is an image, you would use the URL to make the image clickable.

Parameters

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

class azure.cognitiveservices.search.entitysearch.models.ContractualRulesTextAttribution(*, text: str, **kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.ContractualRulesAttribution

Defines a contractual rule for text attribution.

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

• target_property_name (str) – The name of the field that the rule applies to.

• must_be_close_to_content (bool) – A Boolean value that determines whether the contents of the rule must be placed in close proximity to the field that the rule applies to. If true, the contents must be placed in close proximity. If false, or this field does not exist, the contents may be placed at the caller’s discretion.

• optional_for_list_display (bool) – Indicates whether this provider’s attribution is optional.

Parameters

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

• text (str) – Required. The attribution text. Text attribution applies to the entity as a whole and should be displayed immediately following the entity presentation. If there are multiple text or link attribution rules that do not specify a target, you should concatenate them and display them using a “Data from:” label.

class azure.cognitiveservices.search.entitysearch.models.CreativeWork(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.Thing

CreativeWork.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• 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.

• text (str) –

class azure.cognitiveservices.search.entitysearch.models.EntertainmentBusiness(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.LocalBusiness

EntertainmentBusiness.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

class azure.cognitiveservices.search.entitysearch.models.Entities(*, value, **kwargs)

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

Defines an entity 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[Thing]) – Required. A list of entities.

Variables

• id (str) – A String identifier.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

• query_context (QueryContext) –

• query_scenario (str or EntityQueryScenario) – The supported query scenario. This field is set to DominantEntity or DisambiguationItem. The field is set to DominantEntity if Bing determines that only a single entity satisfies the request. For example, a book, movie, person, or attraction. If multiple entities could satisfy the request, the field is set to DisambiguationItem. For example, if the request uses the generic title of a movie franchise, the entity’s type would likely be DisambiguationItem. But, if the request specifies a specific title from the franchise, the entity’s type would likely be DominantEntity. Possible values include: ‘DominantEntity’, ‘DominantEntityWithDisambiguation’, ‘Disambiguation’, ‘List’, ‘ListWithPivot’. Default value: “DominantEntity” .

class azure.cognitiveservices.search.entitysearch.models.EntitiesEntityPresentationInfo(*, entity_scenario='DominantEntity', **kwargs)

Bases: msrest.serialization.Model

Defines additional information about an entity such as type hints.

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

entity_scenario (str or EntityScenario) – Required. The supported scenario. Possible values include: ‘DominantEntity’, ‘DisambiguationItem’, ‘ListItem’. Default value: “DominantEntity” .

Variables

• entity_type_hints (list[str or EntityType]) – A list of hints that indicate the entity’s type. The list could contain a single hint such as Movie or a list of hints such as Place, LocalBusiness, Restaurant. Each successive hint in the array narrows the entity’s type.

• entity_type_display_hint (str) – A display version of the entity hint. For example, if entityTypeHints is Artist, this field may be set to American Singer.

class azure.cognitiveservices.search.entitysearch.models.Error(*, message: str, code='None', **kwargs)

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.entitysearch.models.ErrorResponse(*, errors, **kwargs)

Bases: azure.cognitiveservices.search.entitysearch.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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

class azure.cognitiveservices.search.entitysearch.models.FoodEstablishment(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.LocalBusiness

FoodEstablishment.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

class azure.cognitiveservices.search.entitysearch.models.Hotel(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.LodgingBusiness

Hotel.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

• hotel_class (str) –

• amenities (list[str]) –

class azure.cognitiveservices.search.entitysearch.models.Identifiable(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.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.entitysearch.models.ImageObject(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• 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.

• text (str) –

• 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.

• 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

class azure.cognitiveservices.search.entitysearch.models.Intangible(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.Thing

Intangible.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.entitysearch.models.License(**kwargs)

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

Defines the license under which the text or photo may be used.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• 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.

• text (str) –

class azure.cognitiveservices.search.entitysearch.models.LocalBusiness(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.Place

LocalBusiness.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EntertainmentBusiness, FoodEstablishment, LodgingBusiness

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

class azure.cognitiveservices.search.entitysearch.models.LodgingBusiness(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.LocalBusiness

LodgingBusiness.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

class azure.cognitiveservices.search.entitysearch.models.MediaObject(**kwargs)

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

MediaObject.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• 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.

• text (str) –

• 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.

• 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.entitysearch.models.MovieTheater(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.EntertainmentBusiness

MovieTheater.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

• screen_count (int) –

class azure.cognitiveservices.search.entitysearch.models.Organization(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.entitysearch.models.Place(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.Thing

Defines information about a local entity, such as a restaurant or hotel.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CivicStructure, LocalBusiness, TouristAttraction

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

class azure.cognitiveservices.search.entitysearch.models.Places(*, value, **kwargs)

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

Defines a local entity 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[Thing]) – Required. A list of local entities, such as restaurants or hotels.

Variables

• id (str) – A String identifier.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

• query_context (QueryContext) –

class azure.cognitiveservices.search.entitysearch.models.PostalAddress(**kwargs)

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

Defines a postal address.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• street_address (str) –

• address_locality (str) – The city where the street address is located. For example, Seattle.

• address_subregion (str) –

• address_region (str) – The state or province code where the street address is located. This could be the two-letter code. For example, WA, or the full name , Washington.

• postal_code (str) – The zip code or postal code where the street address is located. For example, 98052.

• post_office_box_number (str) –

• address_country (str) – The country/region where the street address is located. This could be the two-letter ISO code. For example, US, or the full name, United States.

• country_iso (str) – The two letter ISO code of this country. For example, US.

• neighborhood (str) – The neighborhood where the street address is located. For example, Westlake.

• address_region_abbreviation (str) – Region Abbreviation. For example, WA.

• text (str) – The complete address. For example, 2100 Westlake Ave N, Bellevue, WA 98052.

class azure.cognitiveservices.search.entitysearch.models.QueryContext(*, original_query: str, **kwargs)

Bases: msrest.serialization.Model

Defines the query context that Bing used for the 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

original_query (str) – Required. The query string as specified in the request.

Variables

• altered_query (str) – The query string used by Bing to perform the query. Bing uses the altered query string if the original query string contained spelling mistakes. For example, if the query string is “saling downwind”, the altered query string will be “sailing downwind”. This field is included only if the original query string contains a spelling mistake.

• alteration_override_query (str) – The query string to use to force Bing to use the original string. For example, if the query string is “saling downwind”, the override query string will be “+saling downwind”. Remember to encode the query string which results in “%2Bsaling+downwind”. This field is included only if the original query string contains a spelling mistake.

• adult_intent (bool) – A Boolean value that indicates whether the specified query has adult intent. The value is true if the query has adult intent; otherwise, false.

• ask_user_for_location (bool) – A Boolean value that indicates whether Bing requires the user’s location to provide accurate results. If you specified the user’s location by using the X-MSEdge-ClientIP and X-Search-Location headers, you can ignore this field. For location aware queries, such as “today’s weather” or “restaurants near me” that need the user’s location to provide accurate results, this field is set to true. For location aware queries that include the location (for example, “Seattle weather”), this field is set to false. This field is also set to false for queries that are not location aware, such as “best sellers”.

class azure.cognitiveservices.search.entitysearch.models.Response(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.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: Thing, SearchResponse, Answer, ErrorResponse

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

class azure.cognitiveservices.search.entitysearch.models.ResponseBase(**kwargs)

Bases: msrest.serialization.Model

ResponseBase.

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.entitysearch.models.Restaurant(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.FoodEstablishment

Restaurant.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

• price_range (str) – $$.

• panoramas (list[ImageObject]) –

• is_permanently_closed (bool) –

• tag_line (str) –

• accepts_reservations (bool) –

• reservation_url (str) –

• serves_cuisine (list[str]) –

• menu_url (str) –

class azure.cognitiveservices.search.entitysearch.models.SearchResponse(**kwargs)

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

Defines the top-level object that the response includes when the 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.

Variables

• id (str) – A String identifier.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

• query_context (QueryContext) – An object that contains the query string that Bing used for the request. This object contains the query string as entered by the user. It may also contain an altered query string that Bing used for the query if the query string contained a spelling mistake.

• entities (Entities) – A list of entities that are relevant to the search query.

• places (Places) – A list of local entities such as restaurants or hotels that are relevant to the query.

class azure.cognitiveservices.search.entitysearch.models.SearchResultsAnswer(**kwargs)

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

SearchResultsAnswer.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• web_search_url (str) – The URL To Bing’s search result for this item.

• query_context (QueryContext) –

class azure.cognitiveservices.search.entitysearch.models.StructuredValue(**kwargs)

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

StructuredValue.

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

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.entitysearch.models.Thing(**kwargs)

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

Thing.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Place, Organization, CreativeWork, 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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

class azure.cognitiveservices.search.entitysearch.models.TouristAttraction(**kwargs)

Bases: azure.cognitiveservices.search.entitysearch.models._models_py3.Place

TouristAttraction.

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.

• contractual_rules (list[ContractualRulesContractualRule]) – A list of rules that you must adhere to if you display the item.

• 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) –

• description (str) – A short description of the item.

• entity_presentation_info (EntitiesEntityPresentationInfo) – Additional information about the entity such as hints that you can use to determine the entity’s type. To determine the entity’s type, use the entityScenario and entityTypeHint fields.

• bing_id (str) – An ID that uniquely identifies this item.

• address (PostalAddress) – The postal address of where the entity is located

• telephone (str) – The entity’s telephone number

class azure.cognitiveservices.search.entitysearch.models.EntityQueryScenario

Bases: str, enum.Enum

An enumeration.

disambiguation = 'Disambiguation'

dominant_entity = 'DominantEntity'

dominant_entity_with_disambiguation = 'DominantEntityWithDisambiguation'

list = 'List'

list_with_pivot = 'ListWithPivot'

class azure.cognitiveservices.search.entitysearch.models.EntityScenario

Bases: str, enum.Enum

An enumeration.

disambiguation_item = 'DisambiguationItem'

dominant_entity = 'DominantEntity'

list_item = 'ListItem'

class azure.cognitiveservices.search.entitysearch.models.EntityType

Bases: str, enum.Enum

An enumeration.

actor = 'Actor'

animal = 'Animal'

artist = 'Artist'

attorney = 'Attorney'

attraction = 'Attraction'

book = 'Book'

car = 'Car'

city = 'City'

college_or_university = 'CollegeOrUniversity'

composition = 'Composition'

continent = 'Continent'

country = 'Country'

drug = 'Drug'

event = 'Event'

food = 'Food'

generic = 'Generic'

hotel = 'Hotel'

house = 'House'

local_business = 'LocalBusiness'

locality = 'Locality'

media = 'Media'

minor_region = 'MinorRegion'

movie = 'Movie'

music_album = 'MusicAlbum'

music_group = 'MusicGroup'

music_recording = 'MusicRecording'

neighborhood = 'Neighborhood'

organization = 'Organization'

other = 'Other'

person = 'Person'

place = 'Place'

point_of_interest = 'PointOfInterest'

postal_code = 'PostalCode'

product = 'Product'

radio_station = 'RadioStation'

region = 'Region'

restaurant = 'Restaurant'

school = 'School'

speciality = 'Speciality'

sports_team = 'SportsTeam'

state = 'State'

street_address = 'StreetAddress'

sub_region = 'SubRegion'

television_season = 'TelevisionSeason'

television_show = 'TelevisionShow'

theater_play = 'TheaterPlay'

tourist_attraction = 'TouristAttraction'

travel = 'Travel'

video_game = 'VideoGame'

class azure.cognitiveservices.search.entitysearch.models.ErrorCode

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.entitysearch.models.ErrorSubCode

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.entitysearch.models.AnswerType

Bases: str, enum.Enum

An enumeration.

entities = 'Entities'

places = 'Places'

class azure.cognitiveservices.search.entitysearch.models.ResponseFormat

Bases: str, enum.Enum

An enumeration.

json = 'Json'

json_ld = 'JsonLd'

class azure.cognitiveservices.search.entitysearch.models.SafeSearch

Bases: str, enum.Enum

An enumeration.

moderate = 'Moderate'

off = 'Off'

strict = 'Strict'