Cloud Natural Language V2 Client - Class AnalyzeSentimentResponse (0.31.3)

Reference documentation and code samples for the Cloud Natural Language V2 Client class AnalyzeSentimentResponse.

The sentiment analysis response message.

Generated from protobuf message google.cloud.language.v2.AnalyzeSentimentResponse

Namespace

Google \ Cloud \ Language \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ document_sentiment Google\Cloud\Language\V2\Sentiment

The overall sentiment of the input document.

↳ language_code string

The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language. See Document.language field for more details.

↳ sentences array<Google\Cloud\Language\V2\Sentence>

The sentiment for all the sentences in the document.

↳ language_supported bool

Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis.

getDocumentSentiment

The overall sentiment of the input document.

Returns
TypeDescription
Google\Cloud\Language\V2\Sentiment|null

hasDocumentSentiment

clearDocumentSentiment

setDocumentSentiment

The overall sentiment of the input document.

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

getLanguageCode

The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.

See Document.language field for more details.

Returns
TypeDescription
string

setLanguageCode

The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.

See Document.language field for more details.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSentences

The sentiment for all the sentences in the document.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSentences

The sentiment for all the sentences in the document.

Parameter
NameDescription
var array<Google\Cloud\Language\V2\Sentence>
Returns
TypeDescription
$this

getLanguageSupported

Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis.

Returns
TypeDescription
bool

setLanguageSupported

Whether the language is officially supported. The API may still return a response when the language is not supported, but it is on a best effort basis.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this