# Cloud Natural Language V1 Client - Class AnnotateTextResponse (1.2.1)

1.2.1 (latest) 1.2.0 1.1.4 1.0.1 0.34.3 0.33.0 0.32.7 0.31.3 0.30.2 0.29.0 0.28.5 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** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ sentences` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Sentence>` Sentences in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_syntax](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractSyntax__). |
| `↳ tokens` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Token>` Tokens, along with their syntactic information, in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_syntax](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractSyntax__). |
| `↳ entities` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Entity>` Entities, along with their semantic information, in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_entities](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractEntities__). |
| `↳ document_sentiment` | `https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Sentiment` The overall sentiment for the document. Populated if the user enables [AnnotateTextRequest.Features.extract_document_sentiment](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractDocumentSentiment__). |
| `↳ 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](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Document#_Google_Cloud_Language_V1_Document__getLanguage__) field for more details. |
| `↳ categories` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.ClassificationCategory>` Categories identified in the input document. |
| `↳ moderation_categories` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/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](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractSyntax__).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Sentence>` |   |

### setSentences

Sentences in the input document. Populated if the user enables
[AnnotateTextRequest.Features.extract_syntax](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractSyntax__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Sentence>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTokens

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

Populated if the user enables
[AnnotateTextRequest.Features.extract_syntax](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractSyntax__).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Token>` |   |

### setTokens

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

Populated if the user enables
[AnnotateTextRequest.Features.extract_syntax](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractSyntax__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Token>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEntities

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

Populated if the user enables
[AnnotateTextRequest.Features.extract_entities](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractEntities__).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Entity>` |   |

### setEntities

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

Populated if the user enables
[AnnotateTextRequest.Features.extract_entities](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractEntities__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Entity>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDocumentSentiment

The overall sentiment for the document. Populated if the user enables
[AnnotateTextRequest.Features.extract_document_sentiment](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractDocumentSentiment__).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Sentiment|null` |   |

### hasDocumentSentiment

### clearDocumentSentiment

### setDocumentSentiment

The overall sentiment for the document. Populated if the user enables
[AnnotateTextRequest.Features.extract_document_sentiment](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.AnnotateTextRequest.Features#_Google_Cloud_Language_V1_AnnotateTextRequest_Features__getExtractDocumentSentiment__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Sentiment` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Document#_Google_Cloud_Language_V1_Document__getLanguage__) field
for more details.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `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](https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.Document#_Google_Cloud_Language_V1_Document__getLanguage__) field
for more details.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCategories

Categories identified in the input document.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.ClassificationCategory>` |   |

### setCategories

Categories identified in the input document.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.ClassificationCategory>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getModerationCategories

Harmful and sensitive categories identified in the input document.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.ClassificationCategory>` |   |

### setModerationCategories

Harmful and sensitive categories identified in the input document.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-language/latest/V1.ClassificationCategory>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |