Google Cloud Natural Language API Python Samples

This directory contains samples for Google Cloud Natural Language API. The Google Cloud Natural Language API provides natural language understanding technologies to developers, including sentiment analysis, entity recognition, and syntax analysis. This API is part of the larger Cloud Machine Learning API.

• See the migration guide for information about migrating to Python client library v0.26.1.

Setup

Authentication

Authentication is typically done through Application Default Credentials, which means you do not have to change the code to authenticate as long as your environment has credentials. You have a few options for setting up authentication:

1. When running locally, use the Google Cloud SDK

   gcloud auth application-default login

2. When running on App Engine or Compute Engine, credentials are already set-up. However, you may need to configure your Compute Engine instance with additional scopes.

3. You can create a Service Account key file. This file can be used to authenticate to Google Cloud Platform services from any environment. To use the file, set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path to the key file, for example:

   export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service_account.json

Install Dependencies

1. Install pip and virtualenv if you do not already have them.

2. Create a virtualenv. Samples are compatible with Python 2.7 and 3.4+.

   $ virtualenv env
   $ source env/bin/activate

3. Install the dependencies needed to run the samples.

   $ pip install -r requirements.txt

Samples

Quickstart

To run this sample:

$ python quickstart.py

Snippets

To run this sample:

$ python snippets.py

usage: snippets.py [-h]
                   {sentiment-text,sentiment-file,entities-text,entities-file,syntax-text,syntax-file}
                   ...

This application demonstrates how to perform basic operations with the
Google Cloud Natural Language API

For more information, the documentation at
https://cloud.google.com/natural-language/docs.

positional arguments:
  {sentiment-text,sentiment-file,entities-text,entities-file,syntax-text,syntax-file}
    sentiment-text      Detects sentiment in the text.
    sentiment-file      Detects sentiment in the file located in Google Cloud
                        Storage.
    entities-text       Detects entities in the text.
    entities-file       Detects entities in the file located in Google Cloud
                        Storage.
    syntax-text         Detects syntax in the text.
    syntax-file         Detects syntax in the file located in Google Cloud
                        Storage.

optional arguments:
  -h, --help            show this help message and exit

The client library

This sample uses the Google Cloud Client Library for Python. You can read the documentation for more details on API usage and use GitHub to browse the source and report issues.