Reference documentation and code samples for the Cloud Natural Language V2 Client class AnnotateTextResponse.
The text annotations response message.
Generated from protobuf message google.cloud.language.v2.AnnotateTextResponse
Namespace
Google \ Cloud \ Language \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ sentences |
array<Google\Cloud\Language\V2\Sentence>
Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment. |
↳ entities |
array<Google\Cloud\Language\V2\Entity>
Entities, along with their semantic information, in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment. |
↳ document_sentiment |
Google\Cloud\Language\V2\Sentiment
The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment. |
↳ 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. |
↳ categories |
array<Google\Cloud\Language\V2\ClassificationCategory>
Categories identified in the input document. |
↳ moderation_categories |
array<Google\Cloud\Language\V2\ClassificationCategory>
Harmful and sensitive categories identified in the input document. |
↳ language_supported |
bool
Whether the language is officially supported by all requested features. The API may still return a response when the language is not supported, but it is on a best effort basis. |
getSentences
Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSentences
Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Language\V2\Sentence>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntities
Entities, along with their semantic information, in the input document.
Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEntities
Entities, along with their semantic information, in the input document.
Populated if the user enables AnnotateTextRequest.Features.extract_entities or AnnotateTextRequest.Features.extract_entity_sentiment.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Language\V2\Entity>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocumentSentiment
The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Language\V2\Sentiment|null | |
hasDocumentSentiment
clearDocumentSentiment
setDocumentSentiment
The overall sentiment for the document. Populated if the user enables AnnotateTextRequest.Features.extract_document_sentiment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Language\V2\Sentiment
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategories
Categories identified in the input document.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setCategories
Categories identified in the input document.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Language\V2\ClassificationCategory>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getModerationCategories
Harmful and sensitive categories identified in the input document.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setModerationCategories
Harmful and sensitive categories identified in the input document.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Language\V2\ClassificationCategory>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLanguageSupported
Whether the language is officially supported by all requested features.
The API may still return a response when the language is not supported, but it is on a best effort basis.
| Returns | |
|---|---|
| Type | Description |
bool | |
setLanguageSupported
Whether the language is officially supported by all requested features.
The API may still return a response when the language is not supported, but it is on a best effort basis.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |