# Google Cloud Natural Language v1 API - Class Entity (3.8.0)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [3.8.0 (latest)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entity)
- [3.7.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.7.0/Google.Cloud.Language.V1.Entity)
- [3.6.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.6.0/Google.Cloud.Language.V1.Entity)
- [3.5.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.5.0/Google.Cloud.Language.V1.Entity)
- [3.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.4.0/Google.Cloud.Language.V1.Entity)
- [3.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.3.0/Google.Cloud.Language.V1.Entity)
- [3.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.2.0/Google.Cloud.Language.V1.Entity)
- [3.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.1.0/Google.Cloud.Language.V1.Entity)
- [3.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/3.0.0/Google.Cloud.Language.V1.Entity)
- [2.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/2.3.0/Google.Cloud.Language.V1.Entity)
- [2.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/2.2.0/Google.Cloud.Language.V1.Entity)

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

Reference documentation and code samples for the Google Cloud Natural Language v1 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 salience and mentions, with entities.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Entity

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Entity](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entity), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Entity](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entity), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Entity](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entity), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Language.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1)

## Assembly

Google.Cloud.Language.V1.dll

## Constructors

### Entity()

    public Entity()

### Entity(Entity)

    public Entity(Entity other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Name

    public string Name { get; set; }

The representative name for the entity.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/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** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Sentiment` |   |

### Type

    public Entity.Types.Type Type { get; set; }

The entity type.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entityhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entity.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Language.V1/latest/Google.Cloud.Language.V1.Entity.Types.Type` |   |