LanguageServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Provides text analysis operations such as sentiment analysis and entity recognition.
Methods
LanguageServiceClient
LanguageServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Constructor.
Parameters | |
---|---|
Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
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 |
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 |
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
analyze_entities(document, encoding_type=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
.. rubric:: Example
from google.cloud import language_v1beta2
client = language_v1beta2.LanguageServiceClient()
TODO: Initialize
document
:document = {}
response = client.analyze_entities(document)
Parameters | |
---|---|
Name | Description |
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 |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
analyze_entity_sentiment
analyze_entity_sentiment(document, encoding_type=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Finds entities, similar to AnalyzeEntities
in the text and analyzes
sentiment associated with each entity and its mentions.
.. rubric:: Example
from google.cloud import language_v1beta2
client = language_v1beta2.LanguageServiceClient()
TODO: Initialize
document
:document = {}
response = client.analyze_entity_sentiment(document)
Parameters | |
---|---|
Name | Description |
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 |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
analyze_sentiment
analyze_sentiment(document, encoding_type=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Analyzes the sentiment of the provided text.
.. rubric:: Example
from google.cloud import language_v1beta2
client = language_v1beta2.LanguageServiceClient()
TODO: Initialize
document
:document = {}
response = client.analyze_sentiment(document)
Parameters | |
---|---|
Name | Description |
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 for the sentence sentiment. |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
analyze_syntax
analyze_syntax(document, encoding_type=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
.. rubric:: Example
from google.cloud import language_v1beta2
client = language_v1beta2.LanguageServiceClient()
TODO: Initialize
document
:document = {}
response = client.analyze_syntax(document)
Parameters | |
---|---|
Name | Description |
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 |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
annotate_text
annotate_text(document, features, encoding_type=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
.. rubric:: Example
from google.cloud import language_v1beta2
client = language_v1beta2.LanguageServiceClient()
TODO: Initialize
document
:document = {}
TODO: Initialize
features
:features = {}
response = client.annotate_text(document, features)
Parameters | |
---|---|
Name | Description |
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 |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
classify_text
classify_text(document, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Classifies a document into categories.
.. rubric:: Example
from google.cloud import language_v1beta2
client = language_v1beta2.LanguageServiceClient()
TODO: Initialize
document
:document = {}
response = client.classify_text(document)
Parameters | |
---|---|
Name | Description |
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 |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
Exceptions | |
---|---|
Type | Description |
google.api_core.exceptions.GoogleAPICallError | If the request failed for any reason. |
google.api_core.exceptions.RetryError | If the request failed due to a retryable error and retry attempts failed. |
ValueError | If the parameters are invalid. |
from_service_account_file
from_service_account_file(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
LanguageServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
LanguageServiceClient | The constructed client. |