Cloud Natural Language V1 Client - Class AnnotateTextResponse (0.31.3)

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

The text annotations response message.

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

Namespace

Google \ Cloud \ Language \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

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

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

↳ tokens array<Google\Cloud\Language\V1\Token>

Tokens, along with their syntactic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

↳ entities array<Google\Cloud\Language\V1\Entity>

Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities.

↳ document_sentiment Google\Cloud\Language\V1\Sentiment

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

↳ language 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.

↳ categories array<Google\Cloud\Language\V1\ClassificationCategory>

Categories identified in the input document.

↳ moderation_categories array<Google\Cloud\Language\V1\ClassificationCategory>

Harmful and sensitive categories identified in the input document.

getSentences

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSentences

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

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

getTokens

Tokens, along with their syntactic information, in the input document.

Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTokens

Tokens, along with their syntactic information, in the input document.

Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

Parameter
NameDescription
var array<Google\Cloud\Language\V1\Token>
Returns
TypeDescription
$this

getEntities

Entities, along with their semantic information, in the input document.

Populated if the user enables AnnotateTextRequest.Features.extract_entities.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEntities

Entities, along with their semantic information, in the input document.

Populated if the user enables AnnotateTextRequest.Features.extract_entities.

Parameter
NameDescription
var array<Google\Cloud\Language\V1\Entity>
Returns
TypeDescription
$this

getDocumentSentiment

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

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

hasDocumentSentiment

clearDocumentSentiment

setDocumentSentiment

The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.

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

getLanguage

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

setLanguage

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

getCategories

Categories identified in the input document.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setCategories

Categories identified in the input document.

Parameter
NameDescription
var array<Google\Cloud\Language\V1\ClassificationCategory>
Returns
TypeDescription
$this

getModerationCategories

Harmful and sensitive categories identified in the input document.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setModerationCategories

Harmful and sensitive categories identified in the input document.

Parameter
NameDescription
var array<Google\Cloud\Language\V1\ClassificationCategory>
Returns
TypeDescription
$this