Cloud Natural Language v2 API - Class Entity (1.0.0-beta05)

public sealed class Entity : IMessage<Entity>, IEquatable<Entity>, IDeepCloneable<Entity>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Natural Language v2 API 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 probability and mentions, with entities.

Inheritance

object > Entity

Implements

IMessage Entity, IEquatable Entity, IDeepCloneable Entity, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Language.V2

Assembly

Google.Cloud.Language.V2.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
`RepeatedFieldEntityMention`

Metadata

public MapField<string, string> Metadata { get; }

Metadata associated with the entity.

For the metadata associated with other entity types, see the Type table below.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

The representative name for the entity.

Property Value
Type	Description
`string`

Sentiment

public Sentiment Sentiment { get; set; }

For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v2.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
`EntityTypesType`