Class LanguageServiceClient (2.12.0)

LanguageServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.language_v1.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>)

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

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`LanguageServiceTransport`	The transport used by the client instance.

Methods

LanguageServiceClient

LanguageServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.language_v1.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>)

Instantiates the language service client.

Parameters
Name	Description
`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`	`Union[str, LanguageServiceTransport]` The transport to use. 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. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

analyze_entities

analyze_entities(
    request: typing.Optional[
        typing.Union[
            google.cloud.language_v1.types.language_service.AnalyzeEntitiesRequest, dict
        ]
    ] = None,
    *,
    document: typing.Optional[
        google.cloud.language_v1.types.language_service.Document
    ] = None,
    encoding_type: typing.Optional[
        google.cloud.language_v1.types.language_service.EncodingType
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.language_v1.types.language_service.AnalyzeEntitiesResponse

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_v1

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

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

    request = language_v1.AnalyzeEntitiesRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.types.AnalyzeEntitiesRequest, dict]` The request object. The entity analysis request message.
`document`	`google.cloud.language_v1.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_v1.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.Retry` 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
Type	Description
`google.cloud.language_v1.types.AnalyzeEntitiesResponse`	The entity analysis response message.

analyze_entity_sentiment

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

Finds entities, similar to xref_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_v1

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

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

    request = language_v1.AnalyzeEntitySentimentRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.types.AnalyzeEntitySentimentRequest, dict]` The request object. The entity-level sentiment analysis request message.
`document`	`google.cloud.language_v1.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_v1.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.Retry` 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
Type	Description
`google.cloud.language_v1.types.AnalyzeEntitySentimentResponse`	The entity-level sentiment analysis response message.

analyze_sentiment

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

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_v1

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

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

    request = language_v1.AnalyzeSentimentRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.types.AnalyzeSentimentRequest, dict]` The request object. The sentiment analysis request message.
`document`	`google.cloud.language_v1.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_v1.types.EncodingType` The encoding type used by the API to calculate sentence 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.Retry` 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
Type	Description
`google.cloud.language_v1.types.AnalyzeSentimentResponse`	The sentiment analysis response message.

analyze_syntax

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

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_v1

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

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

    request = language_v1.AnalyzeSyntaxRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.types.AnalyzeSyntaxRequest, dict]` The request object. The syntax analysis request message.
`document`	`google.cloud.language_v1.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_v1.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.Retry` 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
Type	Description
`google.cloud.language_v1.types.AnalyzeSyntaxResponse`	The syntax analysis response message.

annotate_text

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

A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide 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_v1

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

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

    request = language_v1.AnnotateTextRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.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_v1.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_v1.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_v1.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.Retry` 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
Type	Description
`google.cloud.language_v1.types.AnnotateTextResponse`	The text annotations response message.

classify_text

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

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_v1

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

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

    request = language_v1.ClassifyTextRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.types.ClassifyTextRequest, dict]` The request object. The document classification request message.
`document`	`google.cloud.language_v1.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.Retry` 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
Type	Description
`google.cloud.language_v1.types.ClassifyTextResponse`	The document classification response message.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

from_service_account_file

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

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`LanguageServiceClient`	The constructed client.

from_service_account_json

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

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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.

Parameter
Name	Description
`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

moderate_text

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

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_v1

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

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

    request = language_v1.ModerateTextRequest(
        document=document,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.language_v1.types.ModerateTextRequest, dict]` The request object. The document moderation request message.
`document`	`google.cloud.language_v1.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.Retry` 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
Type	Description
`google.cloud.language_v1.types.ModerateTextResponse`	The document moderation response message.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.