Reference documentation and code samples for the Cloud Natural Language V1 Client class AnnotateTextRequest.
The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.
Generated from protobuf message google.cloud.language.v1.AnnotateTextRequest
Namespace
Google \ Cloud \ Language \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ document |
Google\Cloud\Language\V1\Document
Required. Input document. |
↳ features |
Google\Cloud\Language\V1\AnnotateTextRequest\Features
Required. The enabled features. |
↳ encoding_type |
int
The encoding type used by the API to calculate offsets. |
getDocument
Required. Input document.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Language\V1\Document|null |
|
hasDocument
clearDocument
setDocument
Required. Input document.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Language\V1\Document
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFeatures
Required. The enabled features.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Language\V1\AnnotateTextRequest\Features|null |
|
hasFeatures
clearFeatures
setFeatures
Required. The enabled features.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Language\V1\AnnotateTextRequest\Features
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncodingType
The encoding type used by the API to calculate offsets.
| Returns | |
|---|---|
| Type | Description |
int |
|
setEncodingType
The encoding type used by the API to calculate offsets.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
document |
Google\Cloud\Language\V1\Document
Required. Input document. |
features |
Google\Cloud\Language\V1\AnnotateTextRequest\Features
Required. The enabled features. |
encodingType |
int
The encoding type used by the API to calculate offsets. For allowed values, use constants defined on Google\Cloud\Language\V1\EncodingType |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Language\V1\AnnotateTextRequest |
|
static::buildFromDocumentFeatures
| Parameters | |
|---|---|
| Name | Description |
document |
Google\Cloud\Language\V1\Document
Required. Input document. |
features |
Google\Cloud\Language\V1\AnnotateTextRequest\Features
Required. The enabled features. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Language\V1\AnnotateTextRequest |
|