LinkedEntity Class

LinkedEntity contains a link to the well-known recognized entity in text. The link comes from a data source like Wikipedia or Bing. It additionally includes all of the matches of this entity found in the document.

New in version v3.1: The bing_entity_search_api_id property.

Inheritance

azure.ai.textanalytics._dict_mixin.DictMixin

LinkedEntity

Constructor

LinkedEntity(**kwargs: Any)

Methods

get
has_key
items
keys
update
values

get

get(key: str, default: Any | None = None) -> Any

Parameters

Name	Description
key Required
default	default value: None

has_key

has_key(k: str) -> bool

Parameters

Name	Description
k Required

items

items() -> Iterable[Tuple[str, Any]]

keys

keys() -> Iterable[str]

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> Iterable[Any]

Attributes

bing_entity_search_api_id

Bing Entity Search unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search SDK to fetch additional relevant information.

bing_entity_search_api_id: str | None = None

data_source

Data source used to extract entity linking, such as Wiki/Bing etc.

data_source: str

data_source_entity_id

Unique identifier of the recognized entity from the data source.

data_source_entity_id: str | None = None

language

Language used in the data source.

language: str

matches

List of instances this entity appears in the text.

matches: List[LinkedEntityMatch]

name

Entity Linking formal name.

name: str

url

URL to the entity's page from the data source.

url: str