As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

LanguageService

class google.cloud.language_v1beta2.services.language_service.LanguageServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport, typing.Callable[[...], google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the language service async client.

Parameters

  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,LanguageServiceTransport,Callable[..., LanguageServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the LanguageServiceTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • 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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async analyze_entities(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeEntitiesRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeEntitiesResponse[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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_analyze_entities():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeEntitiesRequest(
        document=document,
    )

    # Make the request
    response = await client.analyze_entities(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.AnalyzeEntitiesRequest, dict]]) – The request object. The entity analysis request message.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • encoding_type (google.cloud.language_v1beta2.types.EncodingType) –

    The encoding type used by the API to calculate offsets.

    This corresponds to the encoding_type field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The entity analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeEntitiesResponse

async analyze_entity_sentiment(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeEntitySentimentRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeEntitySentimentResponse[source]

Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_analyze_entity_sentiment():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeEntitySentimentRequest(
        document=document,
    )

    # Make the request
    response = await client.analyze_entity_sentiment(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.AnalyzeEntitySentimentRequest, dict]]) – The request object. The entity-level sentiment analysis request message.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • encoding_type (google.cloud.language_v1beta2.types.EncodingType) –

    The encoding type used by the API to calculate offsets.

    This corresponds to the encoding_type field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The entity-level sentiment analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeEntitySentimentResponse

async analyze_sentiment(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeSentimentRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeSentimentResponse[source]

Analyzes the sentiment of the provided text.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_analyze_sentiment():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeSentimentRequest(
        document=document,
    )

    # Make the request
    response = await client.analyze_sentiment(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.AnalyzeSentimentRequest, dict]]) – The request object. The sentiment analysis request message.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • encoding_type (google.cloud.language_v1beta2.types.EncodingType) –

    The encoding type used by the API to calculate sentence offsets for the sentence sentiment.

    This corresponds to the encoding_type field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The sentiment analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeSentimentResponse

async analyze_syntax(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeSyntaxRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeSyntaxResponse[source]

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_analyze_syntax():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeSyntaxRequest(
        document=document,
    )

    # Make the request
    response = await client.analyze_syntax(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.AnalyzeSyntaxRequest, dict]]) – The request object. The syntax analysis request message.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • encoding_type (google.cloud.language_v1beta2.types.EncodingType) –

    The encoding type used by the API to calculate offsets.

    This corresponds to the encoding_type field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The syntax analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeSyntaxResponse

async annotate_text(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnnotateTextRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, features: Optional[google.cloud.language_v1beta2.types.language_service.AnnotateTextRequest.Features] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnnotateTextResponse[source]

A convenience method that provides all syntax, sentiment, entity, and classification features in one call.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_annotate_text():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnnotateTextRequest(
        document=document,
    )

    # Make the request
    response = await client.annotate_text(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.AnnotateTextRequest, dict]]) – The request object. The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • features (google.cloud.language_v1beta2.types.AnnotateTextRequest.Features) – Required. The enabled features. This corresponds to the features field on the request instance; if request is provided, this should not be set.

  • encoding_type (google.cloud.language_v1beta2.types.EncodingType) –

    The encoding type used by the API to calculate offsets.

    This corresponds to the encoding_type field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The text annotations response message.

Return type

google.cloud.language_v1beta2.types.AnnotateTextResponse

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

async classify_text(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.ClassifyTextRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.ClassifyTextResponse[source]

Classifies a document into categories.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_classify_text():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.ClassifyTextRequest(
        document=document,
    )

    # Make the request
    response = await client.classify_text(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.ClassifyTextRequest, dict]]) – The request object. The document classification request message.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The document classification response message.

Return type

google.cloud.language_v1beta2.types.ClassifyTextResponse

static common_billing_account_path(billing_account: str) → str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str

Returns a fully-qualified organization string.

static common_project_path(project: str) → str

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *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

LanguageServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

LanguageServiceAsyncClient

classmethod from_service_account_json(filename: str, *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

LanguageServiceAsyncClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async moderate_text(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.ModerateTextRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.ModerateTextResponse[source]

Moderates a document for harmful and sensitive categories.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

async def sample_moderate_text():
    # Create a client
    client = language_v1beta2.LanguageServiceAsyncClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.ModerateTextRequest(
        document=document,
    )

    # Make the request
    response = await client.moderate_text(request=request)

    # Handle the response
    print(response)
Parameters

  • request (Optional[Union[google.cloud.language_v1beta2.types.ModerateTextRequest, dict]]) – The request object. The document moderation request message.

  • document (google.cloud.language_v1beta2.types.Document) – Required. Input document. This corresponds to the document field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The document moderation response message.

Return type

google.cloud.language_v1beta2.types.ModerateTextResponse

static parse_common_billing_account_path(path: str) → Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]

Parse a project path into its component segments.

property transport: google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

LanguageServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

class google.cloud.language_v1beta2.services.language_service.LanguageServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport, typing.Callable[[...], google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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

Instantiates the language service client.

Parameters

  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Optional[Union[str,LanguageServiceTransport,Callable[..., LanguageServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the LanguageServiceTransport constructor. If set to None, a transport is chosen automatically.

  • client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

    Custom options for the client.

    1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

    2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

  • 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.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

analyze_entities(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeEntitiesRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeEntitiesResponse[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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_analyze_entities():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeEntitiesRequest(
        document=document,
    )

    # Make the request
    response = client.analyze_entities(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The entity analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeEntitiesResponse

analyze_entity_sentiment(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeEntitySentimentRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeEntitySentimentResponse[source]

Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_analyze_entity_sentiment():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeEntitySentimentRequest(
        document=document,
    )

    # Make the request
    response = client.analyze_entity_sentiment(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The entity-level sentiment analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeEntitySentimentResponse

analyze_sentiment(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeSentimentRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeSentimentResponse[source]

Analyzes the sentiment of the provided text.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_analyze_sentiment():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeSentimentRequest(
        document=document,
    )

    # Make the request
    response = client.analyze_sentiment(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The sentiment analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeSentimentResponse

analyze_syntax(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnalyzeSyntaxRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnalyzeSyntaxResponse[source]

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_analyze_syntax():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnalyzeSyntaxRequest(
        document=document,
    )

    # Make the request
    response = client.analyze_syntax(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The syntax analysis response message.

Return type

google.cloud.language_v1beta2.types.AnalyzeSyntaxResponse

annotate_text(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.AnnotateTextRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, features: Optional[google.cloud.language_v1beta2.types.language_service.AnnotateTextRequest.Features] = None, encoding_type: Optional[google.cloud.language_v1beta2.types.language_service.EncodingType] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.AnnotateTextResponse[source]

A convenience method that provides all syntax, sentiment, entity, and classification features in one call.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_annotate_text():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.AnnotateTextRequest(
        document=document,
    )

    # Make the request
    response = client.annotate_text(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The text annotations response message.

Return type

google.cloud.language_v1beta2.types.AnnotateTextResponse

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

classify_text(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.ClassifyTextRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.ClassifyTextResponse[source]

Classifies a document into categories.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_classify_text():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.ClassifyTextRequest(
        document=document,
    )

    # Make the request
    response = client.classify_text(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The document classification response message.

Return type

google.cloud.language_v1beta2.types.ClassifyTextResponse

static common_billing_account_path(billing_account: str) → str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]

Returns a fully-qualified project string.

classmethod from_service_account_file(filename: str, *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_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters

  • info (dict) – The service account private key info.

  • 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: str, *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

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

moderate_text(request: Optional[Union[google.cloud.language_v1beta2.types.language_service.ModerateTextRequest, dict]] = None, *, document: Optional[google.cloud.language_v1beta2.types.language_service.Document] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.language_v1beta2.types.language_service.ModerateTextResponse[source]

Moderates a document for harmful and sensitive categories.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import language_v1beta2

def sample_moderate_text():
    # Create a client
    client = language_v1beta2.LanguageServiceClient()

    # Initialize request argument(s)
    document = language_v1beta2.Document()
    document.content = "content_value"

    request = language_v1beta2.ModerateTextRequest(
        document=document,
    )

    # Make the request
    response = client.moderate_text(request=request)

    # Handle the response
    print(response)
Parameters
Returns

The document moderation response message.

Return type

google.cloud.language_v1beta2.types.ModerateTextResponse

static parse_common_billing_account_path(path: str) → Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]

Parse a project path into its component segments.

property transport: google.cloud.language_v1beta2.services.language_service.transports.base.LanguageServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

LanguageServiceTransport

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str