Skip to content
This repository was archived by the owner on Feb 23, 2024. It is now read-only.

Commit b5962d6

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add translate_document and batch_translate_document (#234)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 393656336 Source-Link: googleapis/googleapis@17d3fb2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/00ca50bdde80906d6f62314ef4f7630b8cdb6e15 feat(v3beta1): add format_conversions
1 parent a1297ba commit b5962d6

14 files changed

Lines changed: 1431 additions & 47 deletions

File tree

‎google/cloud/translate/__init__.py‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@
2121
TranslationServiceAsyncClient,
2222
)
2323

24+
from google.cloud.translate_v3.types.translation_service import BatchDocumentInputConfig
25+
from google.cloud.translate_v3.types.translation_service import (
26+
BatchDocumentOutputConfig,
27+
)
28+
from google.cloud.translate_v3.types.translation_service import (
29+
BatchTranslateDocumentMetadata,
30+
)
31+
from google.cloud.translate_v3.types.translation_service import (
32+
BatchTranslateDocumentRequest,
33+
)
34+
from google.cloud.translate_v3.types.translation_service import (
35+
BatchTranslateDocumentResponse,
36+
)
2437
from google.cloud.translate_v3.types.translation_service import BatchTranslateMetadata
2538
from google.cloud.translate_v3.types.translation_service import BatchTranslateResponse
2639
from google.cloud.translate_v3.types.translation_service import (
@@ -34,6 +47,9 @@
3447
from google.cloud.translate_v3.types.translation_service import DetectedLanguage
3548
from google.cloud.translate_v3.types.translation_service import DetectLanguageRequest
3649
from google.cloud.translate_v3.types.translation_service import DetectLanguageResponse
50+
from google.cloud.translate_v3.types.translation_service import DocumentInputConfig
51+
from google.cloud.translate_v3.types.translation_service import DocumentOutputConfig
52+
from google.cloud.translate_v3.types.translation_service import DocumentTranslation
3753
from google.cloud.translate_v3.types.translation_service import GcsDestination
3854
from google.cloud.translate_v3.types.translation_service import GcsSource
3955
from google.cloud.translate_v3.types.translation_service import GetGlossaryRequest
@@ -48,6 +64,10 @@
4864
from google.cloud.translate_v3.types.translation_service import OutputConfig
4965
from google.cloud.translate_v3.types.translation_service import SupportedLanguage
5066
from google.cloud.translate_v3.types.translation_service import SupportedLanguages
67+
from google.cloud.translate_v3.types.translation_service import TranslateDocumentRequest
68+
from google.cloud.translate_v3.types.translation_service import (
69+
TranslateDocumentResponse,
70+
)
5171
from google.cloud.translate_v3.types.translation_service import (
5272
TranslateTextGlossaryConfig,
5373
)
@@ -58,6 +78,11 @@
5878
__all__ = (
5979
"TranslationServiceClient",
6080
"TranslationServiceAsyncClient",
81+
"BatchDocumentInputConfig",
82+
"BatchDocumentOutputConfig",
83+
"BatchTranslateDocumentMetadata",
84+
"BatchTranslateDocumentRequest",
85+
"BatchTranslateDocumentResponse",
6186
"BatchTranslateMetadata",
6287
"BatchTranslateResponse",
6388
"BatchTranslateTextRequest",
@@ -69,6 +94,9 @@
6994
"DetectedLanguage",
7095
"DetectLanguageRequest",
7196
"DetectLanguageResponse",
97+
"DocumentInputConfig",
98+
"DocumentOutputConfig",
99+
"DocumentTranslation",
72100
"GcsDestination",
73101
"GcsSource",
74102
"GetGlossaryRequest",
@@ -81,6 +109,8 @@
81109
"OutputConfig",
82110
"SupportedLanguage",
83111
"SupportedLanguages",
112+
"TranslateDocumentRequest",
113+
"TranslateDocumentResponse",
84114
"TranslateTextGlossaryConfig",
85115
"TranslateTextRequest",
86116
"TranslateTextResponse",

‎google/cloud/translate_v3/__init__.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@
1717
from .services.translation_service import TranslationServiceClient
1818
from .services.translation_service import TranslationServiceAsyncClient
1919

20+
from .types.translation_service import BatchDocumentInputConfig
21+
from .types.translation_service import BatchDocumentOutputConfig
22+
from .types.translation_service import BatchTranslateDocumentMetadata
23+
from .types.translation_service import BatchTranslateDocumentRequest
24+
from .types.translation_service import BatchTranslateDocumentResponse
2025
from .types.translation_service import BatchTranslateMetadata
2126
from .types.translation_service import BatchTranslateResponse
2227
from .types.translation_service import BatchTranslateTextRequest
@@ -28,6 +33,9 @@
2833
from .types.translation_service import DetectedLanguage
2934
from .types.translation_service import DetectLanguageRequest
3035
from .types.translation_service import DetectLanguageResponse
36+
from .types.translation_service import DocumentInputConfig
37+
from .types.translation_service import DocumentOutputConfig
38+
from .types.translation_service import DocumentTranslation
3139
from .types.translation_service import GcsDestination
3240
from .types.translation_service import GcsSource
3341
from .types.translation_service import GetGlossaryRequest
@@ -40,13 +48,20 @@
4048
from .types.translation_service import OutputConfig
4149
from .types.translation_service import SupportedLanguage
4250
from .types.translation_service import SupportedLanguages
51+
from .types.translation_service import TranslateDocumentRequest
52+
from .types.translation_service import TranslateDocumentResponse
4353
from .types.translation_service import TranslateTextGlossaryConfig
4454
from .types.translation_service import TranslateTextRequest
4555
from .types.translation_service import TranslateTextResponse
4656
from .types.translation_service import Translation
4757

4858
__all__ = (
4959
"TranslationServiceAsyncClient",
60+
"BatchDocumentInputConfig",
61+
"BatchDocumentOutputConfig",
62+
"BatchTranslateDocumentMetadata",
63+
"BatchTranslateDocumentRequest",
64+
"BatchTranslateDocumentResponse",
5065
"BatchTranslateMetadata",
5166
"BatchTranslateResponse",
5267
"BatchTranslateTextRequest",
@@ -58,6 +73,9 @@
5873
"DetectLanguageRequest",
5974
"DetectLanguageResponse",
6075
"DetectedLanguage",
76+
"DocumentInputConfig",
77+
"DocumentOutputConfig",
78+
"DocumentTranslation",
6179
"GcsDestination",
6280
"GcsSource",
6381
"GetGlossaryRequest",
@@ -70,6 +88,8 @@
7088
"OutputConfig",
7189
"SupportedLanguage",
7290
"SupportedLanguages",
91+
"TranslateDocumentRequest",
92+
"TranslateDocumentResponse",
7393
"TranslateTextGlossaryConfig",
7494
"TranslateTextRequest",
7595
"TranslateTextResponse",

‎google/cloud/translate_v3/gapic_metadata.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
"grpc": {
1111
"libraryClient": "TranslationServiceClient",
1212
"rpcs": {
13+
"BatchTranslateDocument": {
14+
"methods": [
15+
"batch_translate_document"
16+
]
17+
},
1318
"BatchTranslateText": {
1419
"methods": [
1520
"batch_translate_text"
@@ -45,6 +50,11 @@
4550
"list_glossaries"
4651
]
4752
},
53+
"TranslateDocument": {
54+
"methods": [
55+
"translate_document"
56+
]
57+
},
4858
"TranslateText": {
4959
"methods": [
5060
"translate_text"
@@ -55,6 +65,11 @@
5565
"grpc-async": {
5666
"libraryClient": "TranslationServiceAsyncClient",
5767
"rpcs": {
68+
"BatchTranslateDocument": {
69+
"methods": [
70+
"batch_translate_document"
71+
]
72+
},
5873
"BatchTranslateText": {
5974
"methods": [
6075
"batch_translate_text"
@@ -90,6 +105,11 @@
90105
"list_glossaries"
91106
]
92107
},
108+
"TranslateDocument": {
109+
"methods": [
110+
"translate_document"
111+
]
112+
},
93113
"TranslateText": {
94114
"methods": [
95115
"translate_text"

‎google/cloud/translate_v3/services/translation_service/async_client.py‎

Lines changed: 122 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -218,8 +218,9 @@ async def translate_text(
218218
contents (:class:`Sequence[str]`):
219219
Required. The content of the input in
220220
string format. We recommend the total
221-
content be less than 30k codepoints. Use
222-
BatchTranslateText for larger text.
221+
content be less than 30k codepoints. The
222+
max length of this field is 1024.
223+
Use BatchTranslateText for larger text.
223224
224225
This corresponds to the ``contents`` field
225226
on the ``request`` instance; if ``request`` is provided, this
@@ -235,14 +236,13 @@ async def translate_text(
235236
236237
- General (built-in) models:
237238
``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``,
238-
``projects/{project-number-or-id}/locations/{location-id}/models/general/base``
239239
240240
For global (non-regionalized) requests, use
241241
``location-id`` ``global``. For example,
242242
``projects/{project-number-or-id}/locations/global/models/general/nmt``.
243243
244-
If missing, the system decides which google base model
245-
to use.
244+
If not provided, the default Google model (NMT) will be
245+
used.
246246
247247
This corresponds to the ``model`` field
248248
on the ``request`` instance; if ``request`` is provided, this
@@ -506,11 +506,10 @@ async def get_supported_languages(
506506
507507
- General (built-in) models:
508508
``projects/{project-number-or-id}/locations/{location-id}/models/general/nmt``,
509-
``projects/{project-number-or-id}/locations/{location-id}/models/general/base``
510509
511510
Returns languages supported by the specified model. If
512511
missing, we get supported languages of Google general
513-
base (PBMT) model.
512+
NMT model.
514513
515514
This corresponds to the ``model`` field
516515
on the ``request`` instance; if ``request`` is provided, this
@@ -588,6 +587,54 @@ async def get_supported_languages(
588587
# Done; return the response.
589588
return response
590589

590+
async def translate_document(
591+
self,
592+
request: translation_service.TranslateDocumentRequest = None,
593+
*,
594+
retry: retries.Retry = gapic_v1.method.DEFAULT,
595+
timeout: float = None,
596+
metadata: Sequence[Tuple[str, str]] = (),
597+
) -> translation_service.TranslateDocumentResponse:
598+
r"""Translates documents in synchronous mode.
599+
600+
Args:
601+
request (:class:`google.cloud.translate_v3.types.TranslateDocumentRequest`):
602+
The request object. A document translation request.
603+
retry (google.api_core.retry.Retry): Designation of what errors, if any,
604+
should be retried.
605+
timeout (float): The timeout for this request.
606+
metadata (Sequence[Tuple[str, str]]): Strings which should be
607+
sent along with the request as metadata.
608+
609+
Returns:
610+
google.cloud.translate_v3.types.TranslateDocumentResponse:
611+
A translated document response
612+
message.
613+
614+
"""
615+
# Create or coerce a protobuf request object.
616+
request = translation_service.TranslateDocumentRequest(request)
617+
618+
# Wrap the RPC method; this adds retry and timeout information,
619+
# and friendly error handling.
620+
rpc = gapic_v1.method_async.wrap_method(
621+
self._client._transport.translate_document,
622+
default_timeout=600.0,
623+
client_info=DEFAULT_CLIENT_INFO,
624+
)
625+
626+
# Certain fields should be provided within the metadata header;
627+
# add these here.
628+
metadata = tuple(metadata) + (
629+
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
630+
)
631+
632+
# Send the request.
633+
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
634+
635+
# Done; return the response.
636+
return response
637+
591638
async def batch_translate_text(
592639
self,
593640
request: translation_service.BatchTranslateTextRequest = None,
@@ -656,6 +703,74 @@ async def batch_translate_text(
656703
# Done; return the response.
657704
return response
658705

706+
async def batch_translate_document(
707+
self,
708+
request: translation_service.BatchTranslateDocumentRequest = None,
709+
*,
710+
retry: retries.Retry = gapic_v1.method.DEFAULT,
711+
timeout: float = None,
712+
metadata: Sequence[Tuple[str, str]] = (),
713+
) -> operation_async.AsyncOperation:
714+
r"""Translates a large volume of document in asynchronous
715+
batch mode. This function provides real-time output as
716+
the inputs are being processed. If caller cancels a
717+
request, the partial results (for an input file, it's
718+
all or nothing) may still be available on the specified
719+
output location.
720+
This call returns immediately and you can use
721+
google.longrunning.Operation.name to poll the status of
722+
the call.
723+
724+
Args:
725+
request (:class:`google.cloud.translate_v3.types.BatchTranslateDocumentRequest`):
726+
The request object. The BatchTranslateDocument request.
727+
retry (google.api_core.retry.Retry): Designation of what errors, if any,
728+
should be retried.
729+
timeout (float): The timeout for this request.
730+
metadata (Sequence[Tuple[str, str]]): Strings which should be
731+
sent along with the request as metadata.
732+
733+
Returns:
734+
google.api_core.operation_async.AsyncOperation:
735+
An object representing a long-running operation.
736+
737+
The result type for the operation will be :class:`google.cloud.translate_v3.types.BatchTranslateDocumentResponse` Stored in the
738+
[google.longrunning.Operation.response][google.longrunning.Operation.response]
739+
field returned by BatchTranslateDocument if at least
740+
one document is translated successfully.
741+
742+
"""
743+
# Create or coerce a protobuf request object.
744+
request = translation_service.BatchTranslateDocumentRequest(request)
745+
746+
# Wrap the RPC method; this adds retry and timeout information,
747+
# and friendly error handling.
748+
rpc = gapic_v1.method_async.wrap_method(
749+
self._client._transport.batch_translate_document,
750+
default_timeout=600.0,
751+
client_info=DEFAULT_CLIENT_INFO,
752+
)
753+
754+
# Certain fields should be provided within the metadata header;
755+
# add these here.
756+
metadata = tuple(metadata) + (
757+
gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
758+
)
759+
760+
# Send the request.
761+
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
762+
763+
# Wrap the response in an operation future.
764+
response = operation_async.from_gapic(
765+
response,
766+
self._client._transport.operations_client,
767+
translation_service.BatchTranslateDocumentResponse,
768+
metadata_type=translation_service.BatchTranslateDocumentMetadata,
769+
)
770+
771+
# Done; return the response.
772+
return response
773+
659774
async def create_glossary(
660775
self,
661776
request: translation_service.CreateGlossaryRequest = None,

0 commit comments

Comments
 (0)