Natural Language Client API

class google.cloud.language_v1.LanguageServiceClient(transport=None, channel=None, credentials=None, client_config=None, client_info=None, client_options=None)[source]

Provides text analysis operations such as sentiment analysis and entity recognition.

Constructor.

Parameters
  • (Union[LanguageServiceGrpcTransport, (transport) – Callable[[~.Credentials, type], ~.LanguageServiceGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.

  • channel (grpc.Channel) – DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

  • credentials (google.auth.credentials.Credentials) – The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

  • client_config (dict) – DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

  • client_options (Union[dict, google.api_core.client_options.ClientOptions]) – Client options used to set user options on the client. API Endpoint should be set through client_options.

analyze_entities(document, encoding_type=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

Example

>>> from google.cloud import language_v1
>>>
>>> client = language_v1.LanguageServiceClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> response = client.analyze_entities(document)
Parameters
  • document (Union[dict, Document]) –

    Input document.

    If a dict is provided, it must be of the same form as the protobuf message Document

  • encoding_type (EncodingType) – The encoding type used by the API to calculate offsets.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A AnalyzeEntitiesResponse instance.

Raises
analyze_entity_sentiment(document, encoding_type=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.

Example

>>> from google.cloud import language_v1
>>>
>>> client = language_v1.LanguageServiceClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> response = client.analyze_entity_sentiment(document)
Parameters
  • document (Union[dict, Document]) –

    Input document.

    If a dict is provided, it must be of the same form as the protobuf message Document

  • encoding_type (EncodingType) – The encoding type used by the API to calculate offsets.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A AnalyzeEntitySentimentResponse instance.

Raises
analyze_sentiment(document, encoding_type=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Analyzes the sentiment of the provided text.

Example

>>> from google.cloud import language_v1
>>>
>>> client = language_v1.LanguageServiceClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> response = client.analyze_sentiment(document)
Parameters
  • document (Union[dict, Document]) –

    Input document.

    If a dict is provided, it must be of the same form as the protobuf message Document

  • encoding_type (EncodingType) – The encoding type used by the API to calculate sentence offsets.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A AnalyzeSentimentResponse instance.

Raises
analyze_syntax(document, encoding_type=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

Example

>>> from google.cloud import language_v1
>>>
>>> client = language_v1.LanguageServiceClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> response = client.analyze_syntax(document)
Parameters
  • document (Union[dict, Document]) –

    Input document.

    If a dict is provided, it must be of the same form as the protobuf message Document

  • encoding_type (EncodingType) – The encoding type used by the API to calculate offsets.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A AnalyzeSyntaxResponse instance.

Raises
annotate_text(document, features, encoding_type=None, retry=<object object>, timeout=<object object>, metadata=None)[source]

A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

Example

>>> from google.cloud import language_v1
>>>
>>> client = language_v1.LanguageServiceClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> # TODO: Initialize `features`:
>>> features = {}
>>>
>>> response = client.annotate_text(document, features)
Parameters
  • document (Union[dict, Document]) –

    Input document.

    If a dict is provided, it must be of the same form as the protobuf message Document

  • features (Union[dict, Features]) –

    The enabled features.

    If a dict is provided, it must be of the same form as the protobuf message Features

  • encoding_type (EncodingType) – The encoding type used by the API to calculate offsets.

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A AnnotateTextResponse instance.

Raises
classify_text(document, retry=<object object>, timeout=<object object>, metadata=None)[source]

Classifies a document into categories.

Example

>>> from google.cloud import language_v1
>>>
>>> client = language_v1.LanguageServiceClient()
>>>
>>> # TODO: Initialize `document`:
>>> document = {}
>>>
>>> response = client.classify_text(document)
Parameters
  • document (Union[dict, Document]) –

    Input document.

    If a dict is provided, it must be of the same form as the protobuf message Document

  • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will not be retried.

  • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Optional[Sequence[Tuple[str, str]]]) – Additional metadata that is provided to the method.

Returns

A ClassifyTextResponse instance.

Raises
enums = <module 'google.cloud.language_v1.gapic.enums' from '/tmpfs/src/github/google-cloud-python/language/google/cloud/language_v1/gapic/enums.py'>
classmethod from_service_account_file(filename, *args, **kwargs)[source]

Creates an instance of this client using the provided credentials file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

LanguageServiceClient

classmethod from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

LanguageServiceClient