Cloud Natural Language V1 Client - Class EntityMention (0.31.3)

Reference documentation and code samples for the Cloud Natural Language V1 Client class EntityMention.

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

Generated from protobuf message google.cloud.language.v1.EntityMention

Namespace

Google \ Cloud \ Language \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ text Google\Cloud\Language\V1\TextSpan

The mention text.

↳ type int

The type of the entity mention.

↳ sentiment Google\Cloud\Language\V1\Sentiment

For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

getText

The mention text.

Returns
TypeDescription
Google\Cloud\Language\V1\TextSpan|null

hasText

clearText

setText

The mention text.

Parameter
NameDescription
var Google\Cloud\Language\V1\TextSpan
Returns
TypeDescription
$this

getType

The type of the entity mention.

Returns
TypeDescription
int

setType

The type of the entity mention.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSentiment

For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.

Returns
TypeDescription
Google\Cloud\Language\V1\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 sentiment expressed for this mention of the entity in the provided document.

Parameter
NameDescription
var Google\Cloud\Language\V1\Sentiment
Returns
TypeDescription
$this