Cloud Natural Language V1beta2 Client - Class Entity (0.29.0)

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

Generated from protobuf message google.cloud.language.v1beta2.Entity

Methods

__construct

Constructor.

Parameters
NameDescription
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 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.

↳ salience float

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.

↳ mentions array<Google\Cloud\Language\V1beta2\EntityMention>

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

↳ sentiment Google\Cloud\Language\V1beta2\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
TypeDescription
string

setName

The representative name for the entity.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The entity type.

Returns
TypeDescription
int

setType

The entity type.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMetadata

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.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setMetadata

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.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getSalience

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.

Returns
TypeDescription
float

setSalience

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.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getMentions

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setMentions

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

Parameter
NameDescription
var array<Google\Cloud\Language\V1beta2\EntityMention>
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\Language\V1beta2\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
NameDescription
var Google\Cloud\Language\V1beta2\Sentiment
Returns
TypeDescription
$this