Reference documentation and code samples for the Cloud Natural Language V2 Client 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.
Generated from protobuf message google.cloud.language.v2.Entity
Namespace
Google \ Cloud \ Language \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The representative name for the entity. |
↳ type |
int
The entity type. |
↳ metadata |
array|Google\Protobuf\Internal\MapField
Metadata associated with the entity. For the metadata associated with other entity types, see the Type table below. |
↳ mentions |
array<EntityMention>
The mentions of this entity in the input document. The API currently supports proper noun mentions. |
↳ sentiment |
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. |
getName
The representative name for the entity.
Returns | |
---|---|
Type | Description |
string |
setName
The representative name for the entity.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getType
The entity type.
Returns | |
---|---|
Type | Description |
int |
setType
The entity type.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getMetadata
Metadata associated with the entity.
For the metadata associated with other entity types, see the Type table below.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setMetadata
Metadata associated with the entity.
For the metadata associated with other entity types, see the Type table below.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getMentions
The mentions of this entity in the input document. The API currently supports proper noun mentions.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setMentions
The mentions of this entity in the input document. The API currently supports proper noun mentions.
Parameter | |
---|---|
Name | Description |
var |
array<EntityMention>
|
Returns | |
---|---|
Type | Description |
$this |
getSentiment
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.
Returns | |
---|---|
Type | Description |
Sentiment|null |
hasSentiment
clearSentiment
setSentiment
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.
Parameter | |
---|---|
Name | Description |
var |
Sentiment
|
Returns | |
---|---|
Type | Description |
$this |