public sealed class Entity : IMessage<Entity>, IEquatable<Entity>, IDeepCloneable<Entity>, IBufferMessage, IMessage
Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.
Namespace
Google.Cloud.Language.V1Assembly
Google.Cloud.Language.V1.dll
Constructors
Entity()
public Entity()
Entity(Entity)
public Entity(Entity other)
Parameter | |
---|---|
Name | Description |
other | Entity |
Properties
Mentions
public RepeatedField<EntityMention> Mentions { get; }
The mentions of this entity in the input document. The API currently supports proper noun mentions.
Property Value | |
---|---|
Type | Description |
RepeatedField<EntityMention> |
Metadata
public MapField<string, string> Metadata { get; }
Metadata associated with the entity.
For most entity types, the metadata is a Wikipedia URL (wikipedia_url
)
and Knowledge Graph MID (mid
), if they are available. For the metadata
associated with other entity types, see the Type table below.
Property Value | |
---|---|
Type | Description |
MapField<String, String> |
Name
public string Name { get; set; }
The representative name for the entity.
Property Value | |
---|---|
Type | Description |
String |
Salience
public float Salience { get; set; }
The salience score associated with the entity in the [0, 1.0] range.
The salience score for an entity provides information about the importance or centrality of that entity to the entire document text. Scores closer to 0 are less salient, while scores closer to 1.0 are highly salient.
Property Value | |
---|---|
Type | Description |
System.Single |
Sentiment
public Sentiment Sentiment { get; set; }
For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
Property Value | |
---|---|
Type | Description |
Sentiment |
Type
public Entity.Types.Type Type { get; set; }
The entity type.
Property Value | |
---|---|
Type | Description |
Entity.Types.Type |