From 80b51ceaae4c1c2254fe8db058885a142f96b6ee Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Tue, 1 Sep 2020 16:51:32 -0400 Subject: [PATCH] bing_id -> bing_entity_search_api_id --- .../azure-ai-textanalytics/CHANGELOG.md | 2 +- .../azure/ai/textanalytics/_models.py | 14 +++++++------- .../tests/test_recognize_linked_entities.py | 2 +- .../tests/test_recognize_linked_entities_async.py | 2 +- .../azure-ai-textanalytics/tests/test_repr.py | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md index fa522e9c5bf0..f5c287f2e35d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md +++ b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md @@ -12,7 +12,7 @@ pass in `v3.0` to the kwarg `api_version` when creating your TextAnalyticsClient - `offset` is the offset of the text from the start of the document - We now have added support for opinion mining. To use this feature, you need to make sure you are using the service's v3.1-preview.1 API. To get this support pass `show_opinion_mining` as True when calling the `analyze_sentiment` endpoint -- Add property `bing_id` to the `LinkedEntity` class. This property is only available for v3.1-preview.2 and up, and it is to be +- Add property `bing_entity_search_api_id` to the `LinkedEntity` class. This property is only available for v3.1-preview.2 and up, and it is to be used in conjunction with the Bing Entity Search API to fetch additional relevant information about the returned entity. ## 5.0.0 (2020-07-27) diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py index 2d3c99b02e36..f9aa26334e0e 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py @@ -630,11 +630,11 @@ class LinkedEntity(DictMixin): :ivar data_source: Data source used to extract entity linking, such as Wiki/Bing etc. :vartype data_source: str - :ivar str bing_id: Bing unique identifier of the recognized entity. Use in conjunction + :ivar str bing_entity_search_api_id: Bing unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search SDK to fetch additional relevant information. Only available for API version v3.1-preview.2 and up. .. versionadded:: v3.1-preview.2 - The *bing_id* property. + The *bing_entity_search_api_id* property. """ def __init__(self, **kwargs): @@ -644,11 +644,11 @@ def __init__(self, **kwargs): self.data_source_entity_id = kwargs.get("data_source_entity_id", None) self.url = kwargs.get("url", None) self.data_source = kwargs.get("data_source", None) - self.bing_id = kwargs.get("bing_id", None) + self.bing_entity_search_api_id = kwargs.get("bing_entity_search_api_id", None) @classmethod def _from_generated(cls, entity): - bing_id = entity.bing_id if hasattr(entity, "bing_id") else None + bing_entity_search_api_id = entity.bing_id if hasattr(entity, "bing_id") else None return cls( name=entity.name, matches=[LinkedEntityMatch._from_generated(e) for e in entity.matches], # pylint: disable=protected-access @@ -656,19 +656,19 @@ def _from_generated(cls, entity): data_source_entity_id=entity.id, url=entity.url, data_source=entity.data_source, - bing_id=bing_id, + bing_entity_search_api_id=bing_entity_search_api_id, ) def __repr__(self): return "LinkedEntity(name={}, matches={}, language={}, data_source_entity_id={}, url={}, " \ - "data_source={}, bing_id={})".format( + "data_source={}, bing_entity_search_api_id={})".format( self.name, repr(self.matches), self.language, self.data_source_entity_id, self.url, self.data_source, - self.bing_id, + self.bing_entity_search_api_id, )[:1024] diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities.py index 4d2b16d205fd..3701e1d58e71 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities.py @@ -599,4 +599,4 @@ def test_bing_id(self, client): result = client.recognize_linked_entities(["Microsoft was founded by Bill Gates and Paul Allen"]) for doc in result: for entity in doc.entities: - assert entity.bing_id # this checks if it's None and if it's empty + assert entity.bing_entity_search_api_id # this checks if it's None and if it's empty diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities_async.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities_async.py index 5581410b49bf..4a2488da0c80 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_recognize_linked_entities_async.py @@ -635,4 +635,4 @@ async def test_bing_id(self, client): result = await client.recognize_linked_entities(["Microsoft was founded by Bill Gates and Paul Allen"]) for doc in result: for entity in doc.entities: - assert entity.bing_id # this checks if it's None and if it's empty + assert entity.bing_entity_search_api_id # this checks if it's None and if it's empty diff --git a/sdk/textanalytics/azure-ai-textanalytics/tests/test_repr.py b/sdk/textanalytics/azure-ai-textanalytics/tests/test_repr.py index cbe1b895ff3a..602c910bdcd3 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/tests/test_repr.py +++ b/sdk/textanalytics/azure-ai-textanalytics/tests/test_repr.py @@ -117,12 +117,12 @@ def linked_entity(linked_entity_match): data_source_entity_id="Bill Gates", url="https://en.wikipedia.org/wiki/Bill_Gates", data_source="wikipedia", - bing_id="12345678" + bing_entity_search_api_id="12345678" ) model_repr = ( "LinkedEntity(name=Bill Gates, matches=[{}, {}], "\ "language=English, data_source_entity_id=Bill Gates, "\ - "url=https://en.wikipedia.org/wiki/Bill_Gates, data_source=wikipedia, bing_id=12345678)".format( + "url=https://en.wikipedia.org/wiki/Bill_Gates, data_source=wikipedia, bing_entity_search_api_id=12345678)".format( linked_entity_match[1], linked_entity_match[1] ) )