Reference documentation and code samples for the Cloud Natural Language Client class Annotation.
Annotations represent the result of a request against the Google Cloud Natural Language API .
This class is created internally by Google\Cloud\Language\LanguageClient and is used to represent various document analyzation results. It should not be instantiated externally.
Annotations are returned by Google\Cloud\Language\LanguageClient::analyzeEntities() , Google\Cloud\Language\LanguageClient::analyzeSentiment() , Google\Cloud\Language\LanguageClient::analyzeEntitySentiment() , Google\Cloud\Language\LanguageClient::analyzeSyntax() and Google\Cloud\Language\LanguageClient::annotateText() .
Example:
use Google\Cloud\Language\LanguageClient;
$language = new LanguageClient();
$annotation = $language->annotateText('Google Cloud Platform is a powerful tool.');
Namespace
Google \ Cloud \ LanguageMethods
__construct
Create an annotation.
info
array
[optional] The annotation's metadata.
info
See also:
array
sentiment
See also:
array|null
tokensByTag
See also:
tag
mixed
array|null
tokensByLabel
See also:
label
mixed
array|null
entitiesByType
See also:
type
mixed
array|null
sentences
{ Returns an array of sentences found in the document.
Example:
```php
foreach ($annotation->sentences() as $sentence) {
echo $sentence['text']['content'];
}
```
@see https://cloud.google.com/natural-language/docs/reference/rest/v1/Sentence Sentence type documentation
@return array|null
}
void
tokens
{ Returns an array of tokens found in the document.
Example:
```php
foreach ($annotation->tokens() as $token) {
echo $token['text']['content'];
}
```
@see https://cloud.google.com/natural-language/docs/reference/rest/v1/Token Token type documentation
@return array|null
}
void
entities
{ Returns an array of entities found in the document.
Example:
```php
foreach ($annotation->entities() as $entity) {
echo $entity['type'];
}
```
@see https://cloud.google.com/natural-language/docs/reference/rest/v1/Entity Entity type documentation
@return array|null
}
void
categories
{ Returns an array of categories representing the input document.
Example:
```php
foreach ($annotation->categories() as $category) {
echo $category['name'];
}
```
@codingStandardsIgnoreStart
@see https://cloud.google.com/natural-language/docs/reference/rest/v1beta2/ClassificationCategory Classification category documentation
@codingStandardsIgnoreEnd
@return array|null
}
void
language
{ Returns the language of the document.
Example:
```php
echo $annotation->language();
```
@return string|null
}
void
