# Cloud Natural Language V2 API - Class Google::Cloud::Language::V2::Entity (v1.5.0)

1.5.0 (latest) 1.4.0 1.3.0 1.2.1 1.1.0 1.0.1 0.7.0 0.6.0 0.5.1 0.4.0 0.3.2 0.2.0 0.1.0 Reference documentation and code samples for the Cloud Natural Language V2 API class Google::Cloud::Language::V2::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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #mentions

    def mentions() -> ::Array<::Google::Cloud::Language::V2::EntityMention>

**Returns**

- (::Array\<[::Google::Cloud::Language::V2::EntityMention](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-EntityMention)\>) --- The mentions of this entity in the input document. The API currently supports proper noun mentions.

### #mentions=

    def mentions=(value) -> ::Array<::Google::Cloud::Language::V2::EntityMention>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Language::V2::EntityMention](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-EntityMention)\>) --- The mentions of this entity in the input document. The API currently supports proper noun mentions.
**Returns**

- (::Array\<[::Google::Cloud::Language::V2::EntityMention](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-EntityMention)\>) --- The mentions of this entity in the input document. The API currently supports proper noun mentions.

### #metadata

    def metadata() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Metadata associated with the entity.

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

### #metadata=

    def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Metadata associated with the entity.


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

- (::Google::Protobuf::Map{::String =\> ::String}) --- Metadata associated with the entity.

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

### #name

    def name() -> ::String

**Returns**

- (::String) --- The representative name for the entity.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- The representative name for the entity.
**Returns**

- (::String) --- The representative name for the entity.

### #sentiment

    def sentiment() -> ::Google::Cloud::Language::V2::Sentiment

**Returns**

- ([::Google::Cloud::Language::V2::Sentiment](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-Sentiment)) --- 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.

### #sentiment=

    def sentiment=(value) -> ::Google::Cloud::Language::V2::Sentiment

**Parameter**

- **value** ([::Google::Cloud::Language::V2::Sentiment](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-Sentiment)) --- 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.
**Returns**

- ([::Google::Cloud::Language::V2::Sentiment](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-Sentiment)) --- 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.

### #type

    def type() -> ::Google::Cloud::Language::V2::Entity::Type

**Returns**

- ([::Google::Cloud::Language::V2::Entity::Type](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-Entity-Type)) --- The entity type.

### #type=

    def type=(value) -> ::Google::Cloud::Language::V2::Entity::Type

**Parameter**

- **value** ([::Google::Cloud::Language::V2::Entity::Type](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-Entity-Type)) --- The entity type.
**Returns**

- ([::Google::Cloud::Language::V2::Entity::Type](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-language-v2/latest/Google-Cloud-Language-V2-Entity-Type)) --- The entity type.