Show / Hide Table of Contents

Class Entity

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.

Inheritance
object
Entity
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudNaturalLanguage.v1.Data
Assembly: Google.Apis.CloudNaturalLanguage.v1.dll
Syntax
public class Entity : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Mentions

The mentions of this entity in the input document. The API currently supports proper noun mentions.

Declaration
[JsonProperty("mentions")]
public virtual IList<EntityMention> Mentions { get; set; }
Property Value
Type Description
IList<EntityMention>

Metadata

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.

Declaration
[JsonProperty("metadata")]
public virtual IDictionary<string, string> Metadata { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

The representative name for the entity.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Salience

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.

Declaration
[JsonProperty("salience")]
public virtual float? Salience { get; set; }
Property Value
Type Description
float?

Sentiment

For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.

Declaration
[JsonProperty("sentiment")]
public virtual Sentiment Sentiment { get; set; }
Property Value
Type Description
Sentiment

Type

The entity type.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX