NlpSaftEntity

Description

Named entities in the document.

Attributes List

This module has the following attributes (case-insensitive ascending order):

Attributes

1. antecedent (type: integer(), default: nil)
   - Antecedent for entity. This is used to make coreference chains before the mentions in the document are grouped by entity.
2. entityType (type: String.t, default: nil)
   - Entity type (e.g. PER, ORG, LOC). WARNING: This field is deprecated. go/saft-replace-deprecated-entity-type
3. entityTypeProbability (type: list(float()), default: nil)
   - Probability distribution over entity types. These values correspond to Document.entity_label values: doc.entity[e].entity_type_probability[n] is the probability that the correct label for doc.entity[e] is doc.entity_label[n]. These probabilities sum to 1.0 (with possible rounding error). WARNING: This field is deprecated. go/saft-replace-deprecated-entity-type
4. gender (type: String.t, default: nil)
   - Gender for entity.
5. info (type: GoogleApi.ContentWarehouse.V1.Model.Proto2BridgeMessageSet, default: nil)
   - Application-specific information about this entity.
6. mention (type: list(GoogleApi.ContentWarehouse.V1.Model.NlpSaftMention), default: nil)
   - Mentions of the entity in the document.
7. name (type: String.t, default: nil)
   - Representative entity name.
8. profile (type: GoogleApi.ContentWarehouse.V1.Model.NlpSaftEntityProfile, default: nil)
   - Profile for entity.
9. referent (type: GoogleApi.ContentWarehouse.V1.Model.NlpSaftReferent, default: nil)
   - Referent information for discourse context entities that are not mentioned in the document. These can be merged with mentioned entities during analysis if they are deemed to be coreferent. Entities with referents should not have any mentions if they do not corefer with anything. For example, when adding context entities to an input document prior to SAFT analysis, those entities should have a referent and no mentions.
10. representativeMention (type: integer(), default: nil)
    - Representative mention, as an index into mention.
11. salience (type: float(), default: nil)
    - Score indicating the saliency (centrality) of this entity to the document.
12. type (type: list(GoogleApi.ContentWarehouse.V1.Model.NlpSaftEntityType), default: nil)
    - Entity types of the entity. These can include SAFT types (/saft/location, /saft/art, /saft/other/living_thing, etc), collections types (/collection/tv_personalities, /collection/statistical_regions, etc), and more. This refers to the type of the entity itself: in "She is on TV", "She" refers to a specific actor, with type "/collection/tv_personalities". Cf. Mention.Type, which is the type of the referring mention.

Type

Function

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.NlpSaftEntity

• ‹ NlpSaftDocumentTopic
• NlpSaftEntityProfile ›

Possibly related Links