#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""This module contains a Google Cloud Translate Hook."""
from __future__ import annotations
from collections.abc import MutableMapping, MutableSequence, Sequence
from typing import (
TYPE_CHECKING,
cast,
)
from google.api_core.exceptions import GoogleAPICallError
from google.api_core.gapic_v1.method import DEFAULT, _MethodDefault
from google.api_core.retry import Retry
from google.cloud.translate_v2 import Client
from google.cloud.translate_v3 import TranslationServiceClient
from airflow.exceptions import AirflowException
from airflow.providers.google.common.consts import CLIENT_INFO
from airflow.providers.google.common.hooks.base_google import PROVIDE_PROJECT_ID, GoogleBaseHook
if TYPE_CHECKING:
from google.api_core.operation import Operation
from google.cloud.translate_v3.services.translation_service import pagers
from google.cloud.translate_v3.types import (
DatasetInputConfig,
InputConfig,
OutputConfig,
TranslateTextGlossaryConfig,
TransliterationConfig,
automl_translation,
)
from proto import Message
[docs]class WaitOperationNotDoneYetError(Exception):
"""Wait operation not done yet error."""
pass
def _if_exc_is_wait_failed_error(exc: Exception):
return isinstance(exc, WaitOperationNotDoneYetError)
def _check_if_operation_done(operation: Operation):
if not operation.done():
raise WaitOperationNotDoneYetError("Operation is not done yet.")
[docs]class CloudTranslateHook(GoogleBaseHook):
"""
Hook for Google Cloud translate APIs.
All the methods in the hook where project_id is used must be called with
keyword arguments rather than positional.
"""
def __init__(
self,
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(
gcp_conn_id=gcp_conn_id,
impersonation_chain=impersonation_chain,
**kwargs,
)
self._client: Client | None = None
[docs] def get_conn(self) -> Client:
"""
Retrieve connection to Cloud Translate.
:return: Google Cloud Translate client object.
"""
if not self._client:
self._client = Client(credentials=self.get_credentials(), client_info=CLIENT_INFO)
return self._client
@GoogleBaseHook.quota_retry()
[docs] def translate(
self,
values: str | list[str],
target_language: str,
format_: str | None = None,
source_language: str | None = None,
model: str | list[str] | None = None,
) -> dict:
"""
Translate a string or list of strings.
See https://cloud.google.com/translate/docs/translating-text
:param values: String or list of strings to translate.
:param target_language: The language to translate results into. This
is required by the API and defaults to
the target language of the current instance.
:param format_: (Optional) One of ``text`` or ``html``, to specify
if the input text is plain text or HTML.
:param source_language: (Optional) The language of the text to
be translated.
:param model: (Optional) The model used to translate the text, such
as ``'base'`` or ``'NMT'``.
:returns: A list of dictionaries for each queried value. Each
dictionary typically contains three keys (though not
all will be present in all cases)
* ``detectedSourceLanguage``: The detected language (as an
ISO 639-1 language code) of the text.
* ``translatedText``: The translation of the text into the
target language.
* ``input``: The corresponding input value.
* ``model``: The model used to translate the text.
If only a single value is passed, then only a single
dictionary will be returned.
:raises: :class:`~exceptions.ValueError` if the number of
values and translations differ.
"""
client = self.get_conn()
return client.translate(
values=values,
target_language=target_language,
format_=format_,
source_language=source_language,
model=model,
)
[docs]class TranslateHook(GoogleBaseHook):
"""
Hook for Google Cloud translation (Advanced) using client version V3.
See related docs https://cloud.google.com/translate/docs/editions#advanced.
"""
def __init__(
self,
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
) -> None:
super().__init__(
gcp_conn_id=gcp_conn_id,
impersonation_chain=impersonation_chain,
)
self._client: TranslationServiceClient | None = None
[docs] def get_client(self) -> TranslationServiceClient:
"""
Retrieve TranslationService client.
:return: Google Cloud Translation Service client object.
"""
if self._client is None:
self._client = TranslationServiceClient(
credentials=self.get_credentials(), client_info=CLIENT_INFO
)
return self._client
@staticmethod
[docs] def wait_for_operation_done(
*,
operation: Operation,
timeout: float | None = None,
initial: float = 3,
multiplier: float = 2,
maximum: float = 3600,
) -> None:
"""
Wait for long-running operation to be done.
Calls operation.done() until success or timeout exhaustion, following the back-off retry strategy.
See `google.api_core.retry.Retry`.
It's intended use on `Operation` instances that have empty result
(:class `google.protobuf.empty_pb2.Empty`) by design.
Thus calling operation.result() for such operation triggers the exception
``GoogleAPICallError("Unexpected state: Long-running operation had neither response nor error set.")``
even though operation itself is totally fine.
"""
wait_op_for_done = Retry(
predicate=_if_exc_is_wait_failed_error,
initial=initial,
timeout=timeout,
multiplier=multiplier,
maximum=maximum,
)(_check_if_operation_done)
try:
wait_op_for_done(operation=operation)
except GoogleAPICallError:
if timeout:
timeout = int(timeout)
error = operation.exception(timeout=timeout)
raise AirflowException(error)
@staticmethod
[docs] def wait_for_operation_result(operation: Operation, timeout: int | None = None) -> Message:
"""Wait for long-lasting operation to complete."""
try:
return operation.result(timeout=timeout)
except GoogleAPICallError:
error = operation.exception(timeout=timeout)
raise AirflowException(error)
@staticmethod
[docs] def translate_text(
self,
*,
project_id: str = PROVIDE_PROJECT_ID,
contents: Sequence[str],
target_language_code: str,
source_language_code: str | None = None,
mime_type: str | None = None,
location: str | None = None,
model: str | None = None,
transliteration_config: TransliterationConfig | None = None,
glossary_config: TranslateTextGlossaryConfig | None = None,
labels: str | None = None,
timeout: float | _MethodDefault = DEFAULT,
metadata: Sequence[tuple[str, str]] = (),
retry: Retry | _MethodDefault | None = DEFAULT,
) -> dict:
"""
Translate text content provided.
:param project_id: Required. The ID of the Google Cloud project that the service belongs to.
:param contents: Required. The content of the input in string
format. Max length 1024 items with 30_000 codepoints recommended.
:param mime_type: Optional. The format of the source text, If left
blank, the MIME type defaults to "text/html".
:param source_language_code: Optional. The ISO-639 language code of the
input text if known. If the source language
isn't specified, the API attempts to identify
the source language automatically and returns
the source language within the response.
:param target_language_code: Required. The ISO-639 language code to use
for translation of the input text
:param location: Optional. Project or location to make a call. Must refer to
a caller's project.
If not specified, 'global' is used.
Non-global location is required for requests using AutoML
models or custom glossaries.
Models and glossaries must be within the same region (have
the same location-id).
:param model: Optional. The ``model`` type requested for this translation.
If not provided, the default Google model (NMT) will be used.
The format depends on model type:
- AutoML Translation models:
``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}``
- General (built-in) models:
``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``
- Translation LLM models:
``projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm``
For global (no region) requests, use ``location-id`` ``global``.
For example, ``projects/{project-number-or-id}/locations/global/models/general/nmt``.
:param glossary_config: Optional. Glossary to be applied. The glossary must be
within the same region (have the same location-id) as the
model.
:param transliteration_config: Optional. Transliteration to be applied.
:param labels: Optional. The labels with user-defined
metadata for the request.
See https://cloud.google.com/translate/docs/advanced/labels for more information.
:param retry: Designation of what errors, if any, should be retried.
:param timeout: The timeout for this request.
:param metadata: Strings which should be sent along with the request as metadata.
:return: Translate text result from the API response.
"""
client = self.get_client()
location_id = "global" if not location else location
parent = f"projects/{project_id or self.project_id}/locations/{location_id}"
result = client.translate_text(
request={
"parent": parent,
"source_language_code": source_language_code,
"target_language_code": target_language_code,
"contents": contents,
"mime_type": mime_type,
"glossary_config": glossary_config,
"transliteration_config": transliteration_config,
"model": model,
"labels": labels,
},
timeout=timeout,
retry=retry,
metadata=metadata,
)
return cast(dict, type(result).to_dict(result))
[docs] def batch_translate_text(
self,
*,
project_id: str = PROVIDE_PROJECT_ID,
location: str,
source_language_code: str,
target_language_codes: MutableSequence[str],
input_configs: MutableSequence[InputConfig | dict],
output_config: OutputConfig | dict,
models: str | None = None,
glossaries: MutableMapping[str, TranslateTextGlossaryConfig] | None = None,
labels: MutableMapping[str, str] | None = None,
timeout: float | _MethodDefault = DEFAULT,
metadata: Sequence[tuple[str, str]] = (),
retry: Retry | _MethodDefault | None = DEFAULT,
) -> Operation:
"""
Translate large volumes of text data.
:param project_id: Required. The ID of the Google Cloud project that the service belongs to.
:param location: Optional. Project or location to make a call. Must refer to
a caller's project. Must be non-global.
:param source_language_code: Required. Source language code.
:param target_language_codes: Required. Specify up to 10 language codes here.
:param models: Optional. The models to use for translation. Map's key is
target language code. Map's value is model name. Value can
be a built-in general model, or an AutoML Translation model.
The value format depends on model type:
- AutoML Translation models:
``projects/{project-number-or-id}/locations/{location-id}/models/{model-id}``
- General (built-in) models:
``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``
If the map is empty or a specific model is not requested for
a language pair, then the default Google model (NMT) is used.
:param input_configs: Required. Input configurations.
The total number of files matched should be <= 100. The total content size should be <= 100M
Unicode codepoints. The files must use UTF-8 encoding.
:param output_config: Required. Output configuration.
:param glossaries: Optional. Glossaries to be applied for
translation. It's keyed by target language code.
:param labels: Optional. The labels with user-defined metadata for the request.
See https://cloud.google.com/translate/docs/advanced/labels for more information.
:param retry: Designation of what errors, if any, should be retried.
:param timeout: The timeout for this request.
:param metadata: Strings which should be sent along with the request as metadata.
:return: Operation object with the batch text translate results,
that are returned by batches as they are ready.
"""
client = self.get_client()
if location == "global":
raise AirflowException(
"Global location is not allowed for the batch text translation, "
"please provide the correct value!"
)
parent = f"projects/{project_id or self.project_id}/locations/{location}"
result = client.batch_translate_text(
request={
"parent": parent,
"source_language_code": source_language_code,
"target_language_codes": target_language_codes,
"input_configs": input_configs,
"output_config": output_config,
"glossaries": glossaries,
"models": models,
"labels": labels,
},
timeout=timeout,
retry=retry,
metadata=metadata,
)
return result
[docs] def create_dataset(
self,
*,
project_id: str = PROVIDE_PROJECT_ID,
location: str,
dataset: dict | automl_translation.Dataset,
timeout: float | _MethodDefault = DEFAULT,
metadata: Sequence[tuple[str, str]] = (),
retry: Retry | _MethodDefault | None = DEFAULT,
) -> Operation:
"""
Create the translation dataset.
:param dataset: The dataset to create. If a dict is provided, it must correspond to
the automl_translation.Dataset type.
:param project_id: ID of the Google Cloud project where dataset is located. If not provided
default project_id is used.
:param location: The location of the project.
:param retry: A retry object used to retry requests. If `None` is specified, requests will not be
retried.
:param timeout: 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.
:param metadata: Additional metadata that is provided to the method.
:return: `Operation` object for the dataset to be created.
"""
client = self.get_client()
parent = f"projects/{project_id or self.project_id}/locations/{location}"
return client.create_dataset(
request={"parent": parent, "dataset": dataset},
retry=retry,
timeout=timeout,
metadata=metadata,
)
[docs] def get_dataset(
self,
dataset_id: str,
project_id: str,
location: str,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | _MethodDefault = DEFAULT,
metadata: Sequence[tuple[str, str]] = (),
) -> automl_translation.Dataset:
"""
Retrieve the dataset for the given dataset_id.
:param dataset_id: ID of translation dataset to be retrieved.
:param project_id: ID of the Google Cloud project where dataset is located. If not provided
default project_id is used.
:param location: The location of the project.
:param retry: A retry object used to retry requests. If `None` is specified, requests will not be
retried.
:param timeout: 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.
:param metadata: Additional metadata that is provided to the method.
:return: `automl_translation.Dataset` instance.
"""
client = self.get_client()
name = f"projects/{project_id}/locations/{location}/datasets/{dataset_id}"
return client.get_dataset(
request={"name": name},
retry=retry,
timeout=timeout,
metadata=metadata,
)
[docs] def import_dataset_data(
self,
dataset_id: str,
location: str,
input_config: dict | DatasetInputConfig,
project_id: str = PROVIDE_PROJECT_ID,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> Operation:
"""
Import data into the translation dataset.
:param dataset_id: ID of the translation dataset.
:param input_config: The desired input location and its domain specific semantics, if any.
If a dict is provided, it must be of the same form as the protobuf message InputConfig.
:param project_id: ID of the Google Cloud project where dataset is located if None then
default project_id is used.
:param location: The location of the project.
:param retry: A retry object used to retry requests. If `None` is specified, requests will not be
retried.
:param timeout: 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.
:param metadata: Additional metadata that is provided to the method.
:return: `Operation` object for the import data.
"""
client = self.get_client()
name = f"projects/{project_id}/locations/{location}/datasets/{dataset_id}"
result = client.import_data(
request={"dataset": name, "input_config": input_config},
retry=retry,
timeout=timeout,
metadata=metadata,
)
return result
[docs] def list_datasets(
self,
project_id: str,
location: str,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | _MethodDefault = DEFAULT,
metadata: Sequence[tuple[str, str]] = (),
) -> pagers.ListDatasetsPager:
"""
List translation datasets in a project.
:param project_id: ID of the Google Cloud project where dataset is located. If not provided
default project_id is used.
:param location: The location of the project.
:param retry: A retry object used to retry requests. If `None` is specified, requests will not be
retried.
:param timeout: 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.
:param metadata: Additional metadata that is provided to the method.
:return: ``pagers.ListDatasetsPager`` instance, iterable object to retrieve the datasets list.
"""
client = self.get_client()
parent = f"projects/{project_id}/locations/{location}"
result = client.list_datasets(
request={"parent": parent},
retry=retry,
timeout=timeout,
metadata=metadata,
)
return result
[docs] def delete_dataset(
self,
dataset_id: str,
project_id: str,
location: str,
retry: Retry | _MethodDefault = DEFAULT,
timeout: float | None = None,
metadata: Sequence[tuple[str, str]] = (),
) -> Operation:
"""
Delete the translation dataset and all of its contents.
:param dataset_id: ID of dataset to be deleted.
:param project_id: ID of the Google Cloud project where dataset is located. If not provided
default project_id is used.
:param location: The location of the project.
:param retry: A retry object used to retry requests. If `None` is specified, requests will not be
retried.
:param timeout: 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.
:param metadata: Additional metadata that is provided to the method.
:return: `Operation` object with dataset deletion results, when finished.
"""
client = self.get_client()
name = f"projects/{project_id}/locations/{location}/datasets/{dataset_id}"
result = client.delete_dataset(
request={"name": name},
retry=retry,
timeout=timeout,
metadata=metadata,
)
return result