Skip to content

Add documentation: language analyze_entity_sentiment #3999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukesneeringer merged 1 commit into from
Sep 19, 2017
Merged

Add documentation: language analyze_entity_sentiment #3999

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions docs/language/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ The Google Natural Language API has three supported methods

- `analyzeEntities`_
- `analyzeSentiment`_
- `analyzeEntitySentiment`_
- `annotateText`_

and each method uses a :class:`~.language_v1.types.Document` for representing
Expand Down Expand Up @@ -113,6 +114,7 @@ to content stored in `Google Cloud Storage`_.

.. _analyzeEntities: https://cloud.google.com/natural-language/docs/reference/rest/v1/documents/analyzeEntities
.. _analyzeSentiment: https://cloud.google.com/natural-language/docs/reference/rest/v1/documents/analyzeSentiment
.. _analyzeEntitySentiment: https://cloud.google.com/natural-language/docs/reference/rest/v1/documents/analyzeEntitySentiment
.. _annotateText: https://cloud.google.com/natural-language/docs/reference/rest/v1/documents/annotateText
.. _Google Cloud Storage: https://cloud.google.com/storage/

Expand Down Expand Up @@ -197,6 +199,45 @@ analyzes the sentiment of the provided text. This method returns a
want ``UTF32``.


************************
Analyze Entity Sentiment
************************

The :meth:`~.language_v1.LanguageServiceClient.analyze_entity_sentiment`
method is effectively the amalgamation of
:meth:`~.language_v1.LanguageServiceClient.analyze_entities` and
:meth:`~.language_v1.LanguageServiceClient.analyze_sentiment`.
This method returns a
:class:`~.language_v1.types.AnalyzeEntitySentimentResponse`.

.. code-block:: python

>>> document = language.types.Document(
... content='Mona said that jogging is very fun.',
... type='PLAIN_TEXT',
... )
>>> response = client.analyze_sentiment(
... document=document,
... encoding_type='UTF32',
... )
>>> entities = response.entities
>>> entities[0].name
'Mona'
>>> entities[1].name
'jogging'
>>> entities[1].sentiment.magnitude
0.8
>>> entities[1].sentiment.score
0.8

.. note::

It is recommended to send an ``encoding_type`` argument to Natural
Language methods, so they provide useful offsets for the data they return.
While the correct value varies by environment, in Python you *usually*
want ``UTF32``.


*************
Annotate Text
*************
Expand Down