Cloud Natural Language Client - Class Annotation (0.28.5)

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\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\Google\Cloud\Language\LanguageClient::analyzeEntities() , Google\Cloud\Language\Google\Cloud\Language\LanguageClient::analyzeSentiment() , Google\Cloud\Language\Google\Cloud\Language\LanguageClient::analyzeEntitySentiment() , Google\Cloud\Language\Google\Cloud\Language\LanguageClient::analyzeSyntax() and Google\Cloud\Language\Google\Cloud\Language\LanguageClient::annotateText() .

Example:

 use Google\Cloud\Language\LanguageClient;

$language = new LanguageClient();

$annotation = $language->annotateText('Google Cloud Platform is a powerful tool.'); 

Create an annotation.

Returns the full response from the API.

Example:

 $info = $annotation->info(); 

Returns the sentiment of the document.

Example:

 $sentiment = $annotation->sentiment();

if ($sentiment['score'] > 0) {
    echo 'This is a positive message.';
} 

Returns an array of tokens filtered by the given tag.

Example:

 $tokens = $annotation->tokensByTag('NOUN');

foreach ($tokens as $token) {
    echo $token['lemma'];
} 

Returns an array of tokens filtered by the given label.

Example:

 $tokens = $annotation->tokensByLabel('P');

foreach ($tokens as $token) {
    echo $token['lemma'];
} 

Returns an array of entities filtered by the given type.

Example:

 $entities = $annotation->entitiesByType('PERSON');

foreach ($entities as $entity) {
    echo $entity['name'];
}