LinkedEntityMatch Class
A match for the linked entity found in text. Provides the confidence score of the prediction and where the entity was found in the text.
New in version v3.1: The offset and length properties.
- Inheritance
-
azure.ai.textanalytics._dict_mixin.DictMixinLinkedEntityMatch
Constructor
LinkedEntityMatch(**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
confidence_score
If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.
confidence_score: float
length
The linked entity match text length. This value depends on the value of the string_index_type parameter set in the original request, which is UnicodeCodePoints by default.
length: int
offset
The linked entity match text offset from the start of the document. The value depends on the value of the string_index_type parameter set in the original request, which is UnicodeCodePoints by default.
offset: int
text
Entity text as appears in the request.
text: str