This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
/
translation_service.py
1516 lines (1295 loc) · 63.8 KB
/
translation_service.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed 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.
#
import proto # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
__protobuf__ = proto.module(
package="google.cloud.translation.v3beta1",
manifest={
"TranslateTextGlossaryConfig",
"TranslateTextRequest",
"TranslateTextResponse",
"Translation",
"DetectLanguageRequest",
"DetectedLanguage",
"DetectLanguageResponse",
"GetSupportedLanguagesRequest",
"SupportedLanguages",
"SupportedLanguage",
"GcsSource",
"InputConfig",
"GcsDestination",
"OutputConfig",
"DocumentInputConfig",
"DocumentOutputConfig",
"TranslateDocumentRequest",
"DocumentTranslation",
"TranslateDocumentResponse",
"BatchTranslateTextRequest",
"BatchTranslateMetadata",
"BatchTranslateResponse",
"GlossaryInputConfig",
"Glossary",
"CreateGlossaryRequest",
"GetGlossaryRequest",
"DeleteGlossaryRequest",
"ListGlossariesRequest",
"ListGlossariesResponse",
"CreateGlossaryMetadata",
"DeleteGlossaryMetadata",
"DeleteGlossaryResponse",
"BatchTranslateDocumentRequest",
"BatchDocumentInputConfig",
"BatchDocumentOutputConfig",
"BatchTranslateDocumentResponse",
"BatchTranslateDocumentMetadata",
},
)
class TranslateTextGlossaryConfig(proto.Message):
r"""Configures which glossary should be used for a specific
target language, and defines options for applying that glossary.
Attributes:
glossary (str):
Required. Specifies the glossary used for this translation.
Use this format: projects/\ */locations/*/glossaries/\*
ignore_case (bool):
Optional. Indicates match is case-
nsensitive. Default value is false if missing.
"""
glossary = proto.Field(proto.STRING, number=1,)
ignore_case = proto.Field(proto.BOOL, number=2,)
class TranslateTextRequest(proto.Message):
r"""The request message for synchronous translation.
Attributes:
contents (Sequence[str]):
Required. The content of the input in string
format. We recommend the total content be less
than 30k codepoints. The max length of this
field is 1024.
Use BatchTranslateText for larger text.
mime_type (str):
Optional. The format of the source text, for
example, "text/html", "text/plain". If left
blank, the MIME type defaults to "text/html".
source_language_code (str):
Optional. The BCP-47 language code of the
input text if known, for example, "en-US" or
"sr-Latn". Supported language codes are listed
in Language Support. If the source language
isn't specified, the API attempts to identify
the source language automatically and returns
the source language within the response.
target_language_code (str):
Required. The BCP-47 language code to use for
translation of the input text, set to one of the
language codes listed in Language Support.
parent (str):
Required. Project or location to make a call. Must refer to
a caller's project.
Format: ``projects/{project-number-or-id}`` or
``projects/{project-number-or-id}/locations/{location-id}``.
For global calls, use
``projects/{project-number-or-id}/locations/global`` or
``projects/{project-number-or-id}``.
Non-global location is required for requests using AutoML
models or custom glossaries.
Models and glossaries must be within the same region (have
same location-id), otherwise an INVALID_ARGUMENT (400) error
is returned.
model (str):
Optional. The ``model`` type requested for this translation.
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``,
For global (non-regionalized) requests, use ``location-id``
``global``. For example,
``projects/{project-number-or-id}/locations/global/models/general/nmt``.
If not provided, the default Google model (NMT) will be used
glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig):
Optional. Glossary to be applied. The glossary must be
within the same region (have the same location-id) as the
model, otherwise an INVALID_ARGUMENT (400) error is
returned.
labels (Sequence[google.cloud.translate_v3beta1.types.TranslateTextRequest.LabelsEntry]):
Optional. The labels with user-defined
metadata for the request.
Label keys and values can be no longer than 63
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed. Label values are optional. Label
keys must start with a letter.
See
https://cloud.google.com/translate/docs/labels
for more information.
"""
contents = proto.RepeatedField(proto.STRING, number=1,)
mime_type = proto.Field(proto.STRING, number=3,)
source_language_code = proto.Field(proto.STRING, number=4,)
target_language_code = proto.Field(proto.STRING, number=5,)
parent = proto.Field(proto.STRING, number=8,)
model = proto.Field(proto.STRING, number=6,)
glossary_config = proto.Field(
proto.MESSAGE, number=7, message="TranslateTextGlossaryConfig",
)
labels = proto.MapField(proto.STRING, proto.STRING, number=10,)
class TranslateTextResponse(proto.Message):
r"""
Attributes:
translations (Sequence[google.cloud.translate_v3beta1.types.Translation]):
Text translation responses with no glossary applied. This
field has the same length as
[``contents``][google.cloud.translation.v3beta1.TranslateTextRequest.contents].
glossary_translations (Sequence[google.cloud.translate_v3beta1.types.Translation]):
Text translation responses if a glossary is provided in the
request. This can be the same as
[``translations``][google.cloud.translation.v3beta1.TranslateTextResponse.translations]
if no terms apply. This field has the same length as
[``contents``][google.cloud.translation.v3beta1.TranslateTextRequest.contents].
"""
translations = proto.RepeatedField(proto.MESSAGE, number=1, message="Translation",)
glossary_translations = proto.RepeatedField(
proto.MESSAGE, number=3, message="Translation",
)
class Translation(proto.Message):
r"""A single translation response.
Attributes:
translated_text (str):
Text translated into the target language.
If an error occurs during translation, this
field might be excluded from the response.
model (str):
Only present when ``model`` is present in the request.
``model`` here is normalized to have project number.
For example: If the ``model`` requested in
TranslationTextRequest is
``projects/{project-id}/locations/{location-id}/models/general/nmt``
then ``model`` here would be normalized to
``projects/{project-number}/locations/{location-id}/models/general/nmt``.
detected_language_code (str):
The BCP-47 language code of source text in
the initial request, detected automatically, if
no source language was passed within the initial
request. If the source language was passed,
auto-detection of the language does not occur
and this field is empty.
glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig):
The ``glossary_config`` used for this translation.
"""
translated_text = proto.Field(proto.STRING, number=1,)
model = proto.Field(proto.STRING, number=2,)
detected_language_code = proto.Field(proto.STRING, number=4,)
glossary_config = proto.Field(
proto.MESSAGE, number=3, message="TranslateTextGlossaryConfig",
)
class DetectLanguageRequest(proto.Message):
r"""The request message for language detection.
Attributes:
parent (str):
Required. Project or location to make a call. Must refer to
a caller's project.
Format:
``projects/{project-number-or-id}/locations/{location-id}``
or ``projects/{project-number-or-id}``.
For global calls, use
``projects/{project-number-or-id}/locations/global`` or
``projects/{project-number-or-id}``.
Only models within the same region (has same location-id)
can be used. Otherwise an INVALID_ARGUMENT (400) error is
returned.
model (str):
Optional. The language detection model to be used.
Format:
``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}``
Only one language detection model is currently supported:
``projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default``.
If not specified, the default model is used.
content (str):
The content of the input stored as a string.
mime_type (str):
Optional. The format of the source text, for
example, "text/html", "text/plain". If left
blank, the MIME type defaults to "text/html".
labels (Sequence[google.cloud.translate_v3beta1.types.DetectLanguageRequest.LabelsEntry]):
Optional. The labels with user-defined
metadata for the request.
Label keys and values can be no longer than 63
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed. Label values are optional. Label
keys must start with a letter.
See
https://cloud.google.com/translate/docs/labels
for more information.
"""
parent = proto.Field(proto.STRING, number=5,)
model = proto.Field(proto.STRING, number=4,)
content = proto.Field(proto.STRING, number=1, oneof="source",)
mime_type = proto.Field(proto.STRING, number=3,)
labels = proto.MapField(proto.STRING, proto.STRING, number=6,)
class DetectedLanguage(proto.Message):
r"""The response message for language detection.
Attributes:
language_code (str):
The BCP-47 language code of source content in
the request, detected automatically.
confidence (float):
The confidence of the detection result for
this language.
"""
language_code = proto.Field(proto.STRING, number=1,)
confidence = proto.Field(proto.FLOAT, number=2,)
class DetectLanguageResponse(proto.Message):
r"""The response message for language detection.
Attributes:
languages (Sequence[google.cloud.translate_v3beta1.types.DetectedLanguage]):
A list of detected languages sorted by
detection confidence in descending order. The
most probable language first.
"""
languages = proto.RepeatedField(
proto.MESSAGE, number=1, message="DetectedLanguage",
)
class GetSupportedLanguagesRequest(proto.Message):
r"""The request message for discovering supported languages.
Attributes:
parent (str):
Required. Project or location to make a call. Must refer to
a caller's project.
Format: ``projects/{project-number-or-id}`` or
``projects/{project-number-or-id}/locations/{location-id}``.
For global calls, use
``projects/{project-number-or-id}/locations/global`` or
``projects/{project-number-or-id}``.
Non-global location is required for AutoML models.
Only models within the same region (have same location-id)
can be used, otherwise an INVALID_ARGUMENT (400) error is
returned.
display_language_code (str):
Optional. The language to use to return
localized, human readable names of supported
languages. If missing, then display names are
not returned in a response.
model (str):
Optional. Get supported languages of this model.
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``,
Returns languages supported by the specified model. If
missing, we get supported languages of Google general NMT
model.
"""
parent = proto.Field(proto.STRING, number=3,)
display_language_code = proto.Field(proto.STRING, number=1,)
model = proto.Field(proto.STRING, number=2,)
class SupportedLanguages(proto.Message):
r"""The response message for discovering supported languages.
Attributes:
languages (Sequence[google.cloud.translate_v3beta1.types.SupportedLanguage]):
A list of supported language responses. This
list contains an entry for each language the
Translation API supports.
"""
languages = proto.RepeatedField(
proto.MESSAGE, number=1, message="SupportedLanguage",
)
class SupportedLanguage(proto.Message):
r"""A single supported language response corresponds to
information related to one supported language.
Attributes:
language_code (str):
Supported language code, generally consisting
of its ISO 639-1 identifier, for example, 'en',
'ja'. In certain cases, BCP-47 codes including
language and region identifiers are returned
(for example, 'zh-TW' and 'zh-CN')
display_name (str):
Human readable name of the language localized
in the display language specified in the
request.
support_source (bool):
Can be used as source language.
support_target (bool):
Can be used as target language.
"""
language_code = proto.Field(proto.STRING, number=1,)
display_name = proto.Field(proto.STRING, number=2,)
support_source = proto.Field(proto.BOOL, number=3,)
support_target = proto.Field(proto.BOOL, number=4,)
class GcsSource(proto.Message):
r"""The Google Cloud Storage location for the input content.
Attributes:
input_uri (str):
Required. Source data URI. For example,
``gs://my_bucket/my_object``.
"""
input_uri = proto.Field(proto.STRING, number=1,)
class InputConfig(proto.Message):
r"""Input configuration for BatchTranslateText request.
Attributes:
mime_type (str):
Optional. Can be "text/plain" or "text/html". For ``.tsv``,
"text/html" is used if mime_type is missing. For ``.html``,
this field must be "text/html" or empty. For ``.txt``, this
field must be "text/plain" or empty.
gcs_source (google.cloud.translate_v3beta1.types.GcsSource):
Required. Google Cloud Storage location for the source
input. This can be a single file (for example,
``gs://translation-test/input.tsv``) or a wildcard (for
example, ``gs://translation-test/*``). If a file extension
is ``.tsv``, it can contain either one or two columns. The
first column (optional) is the id of the text request. If
the first column is missing, we use the row number (0-based)
from the input file as the ID in the output file. The second
column is the actual text to be translated. We recommend
each row be <= 10K Unicode codepoints, otherwise an error
might be returned. Note that the input tsv must be RFC 4180
compliant.
You could use https://github.com/Clever/csvlint to check
potential formatting errors in your tsv file. csvlint
--delimiter='\t' your_input_file.tsv
The other supported file extensions are ``.txt`` or
``.html``, which is treated as a single large chunk of text.
"""
mime_type = proto.Field(proto.STRING, number=1,)
gcs_source = proto.Field(
proto.MESSAGE, number=2, oneof="source", message="GcsSource",
)
class GcsDestination(proto.Message):
r"""The Google Cloud Storage location for the output content.
Attributes:
output_uri_prefix (str):
Required. There must be no files under 'output_uri_prefix'.
'output_uri_prefix' must end with "/" and start with
"gs://", otherwise an INVALID_ARGUMENT (400) error is
returned.
"""
output_uri_prefix = proto.Field(proto.STRING, number=1,)
class OutputConfig(proto.Message):
r"""Output configuration for BatchTranslateText request.
Attributes:
gcs_destination (google.cloud.translate_v3beta1.types.GcsDestination):
Google Cloud Storage destination for output content. For
every single input file (for example,
gs://a/b/c.[extension]), we generate at most 2 \* n output
files. (n is the # of target_language_codes in the
BatchTranslateTextRequest).
Output files (tsv) generated are compliant with RFC 4180
except that record delimiters are '\n' instead of '\r\n'. We
don't provide any way to change record delimiters.
While the input files are being processed, we write/update
an index file 'index.csv' under 'output_uri_prefix' (for
example, gs://translation-test/index.csv) The index file is
generated/updated as new files are being translated. The
format is:
input_file,target_language_code,translations_file,errors_file,
glossary_translations_file,glossary_errors_file
input_file is one file we matched using
gcs_source.input_uri. target_language_code is provided in
the request. translations_file contains the translations.
(details provided below) errors_file contains the errors
during processing of the file. (details below). Both
translations_file and errors_file could be empty strings if
we have no content to output. glossary_translations_file and
glossary_errors_file are always empty strings if the
input_file is tsv. They could also be empty if we have no
content to output.
Once a row is present in index.csv, the input/output
matching never changes. Callers should also expect all the
content in input_file are processed and ready to be consumed
(that is, no partial output file is written).
Since index.csv will be keeping updated during the process,
please make sure there is no custom retention policy applied
on the output bucket that may avoid file updating.
(https://cloud.google.com/storage/docs/bucket-lock?hl=en#retention-policy)
The format of translations_file (for target language code
'trg') is:
gs://translation_test/a_b_c\_'trg'_translations.[extension]
If the input file extension is tsv, the output has the
following columns: Column 1: ID of the request provided in
the input, if it's not provided in the input, then the input
row number is used (0-based). Column 2: source sentence.
Column 3: translation without applying a glossary. Empty
string if there is an error. Column 4 (only present if a
glossary is provided in the request): translation after
applying the glossary. Empty string if there is an error
applying the glossary. Could be same string as column 3 if
there is no glossary applied.
If input file extension is a txt or html, the translation is
directly written to the output file. If glossary is
requested, a separate glossary_translations_file has format
of
gs://translation_test/a_b_c\_'trg'_glossary_translations.[extension]
The format of errors file (for target language code 'trg')
is: gs://translation_test/a_b_c\_'trg'_errors.[extension]
If the input file extension is tsv, errors_file contains the
following: Column 1: ID of the request provided in the
input, if it's not provided in the input, then the input row
number is used (0-based). Column 2: source sentence. Column
3: Error detail for the translation. Could be empty. Column
4 (only present if a glossary is provided in the request):
Error when applying the glossary.
If the input file extension is txt or html,
glossary_error_file will be generated that contains error
details. glossary_error_file has format of
gs://translation_test/a_b_c\_'trg'_glossary_errors.[extension]
"""
gcs_destination = proto.Field(
proto.MESSAGE, number=1, oneof="destination", message="GcsDestination",
)
class DocumentInputConfig(proto.Message):
r"""A document translation request input config.
Attributes:
content (bytes):
Document's content represented as a stream of
bytes.
gcs_source (google.cloud.translate_v3beta1.types.GcsSource):
Google Cloud Storage location. This must be a single file.
For example: gs://example_bucket/example_file.pdf
mime_type (str):
Specifies the input document's mime_type.
If not specified it will be determined using the file
extension for gcs_source provided files. For a file provided
through bytes content the mime_type must be provided.
Currently supported mime types are:
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
"""
content = proto.Field(proto.BYTES, number=1, oneof="source",)
gcs_source = proto.Field(
proto.MESSAGE, number=2, oneof="source", message="GcsSource",
)
mime_type = proto.Field(proto.STRING, number=4,)
class DocumentOutputConfig(proto.Message):
r"""A document translation request output config.
Attributes:
gcs_destination (google.cloud.translate_v3beta1.types.GcsDestination):
Optional. Google Cloud Storage destination for the
translation output, e.g., ``gs://my_bucket/my_directory/``.
The destination directory provided does not have to be
empty, but the bucket must exist. If a file with the same
name as the output file already exists in the destination an
error will be returned.
For a DocumentInputConfig.contents provided document, the
output file will have the name
"output_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension
according to its mime type.
For a DocumentInputConfig.gcs_uri provided document, the
output file will have a name according to its URI. For
example: an input file with URI: "gs://a/b/c.[extension]"
stored in a gcs_destination bucket with name "my_bucket"
will have an output URI:
"gs://my_bucket/a_b_c\_[trg]_translations.[ext]", where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension
according to its mime type.
If the document was directly provided through the request,
then the output document will have the format:
"gs://my_bucket/translated_document_[trg]_translations.[ext],
where
- [trg] corresponds to the translated file's language code,
- [ext] corresponds to the translated file's extension
according to its mime type.
If a glossary was provided, then the output URI for the
glossary translation will be equal to the default output URI
but have ``glossary_translations`` instead of
``translations``. For the previous example, its glossary URI
would be:
"gs://my_bucket/a_b_c\_[trg]_glossary_translations.[ext]".
Thus the max number of output files will be 2 (Translated
document, Glossary translated document).
Callers should expect no partial outputs. If there is any
error during document translation, no output will be stored
in the Cloud Storage bucket.
mime_type (str):
Optional. Specifies the translated document's mime_type. If
not specified, the translated file's mime type will be the
same as the input file's mime type. Currently only support
the output mime type to be the same as input mime type.
- application/pdf
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.presentationml.presentation
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
"""
gcs_destination = proto.Field(
proto.MESSAGE, number=1, oneof="destination", message="GcsDestination",
)
mime_type = proto.Field(proto.STRING, number=3,)
class TranslateDocumentRequest(proto.Message):
r"""A document translation request.
Attributes:
parent (str):
Required. Location to make a regional call.
Format:
``projects/{project-number-or-id}/locations/{location-id}``.
For global calls, use
``projects/{project-number-or-id}/locations/global``.
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), otherwise an INVALID_ARGUMENT (400)
error is returned.
source_language_code (str):
Optional. The BCP-47 language code of the
input document if known, for example, "en-US" or
"sr-Latn". Supported language codes are listed
in Language Support. If the source language
isn't specified, the API attempts to identify
the source language automatically and returns
the source language within the response. Source
language must be specified if the request
contains a glossary or a custom model.
target_language_code (str):
Required. The BCP-47 language code to use for
translation of the input document, set to one of
the language codes listed in Language Support.
document_input_config (google.cloud.translate_v3beta1.types.DocumentInputConfig):
Required. Input configurations.
document_output_config (google.cloud.translate_v3beta1.types.DocumentOutputConfig):
Optional. Output configurations.
Defines if the output file should be stored
within Cloud Storage as well as the desired
output format. If not provided the translated
file will only be returned through a byte-stream
and its output mime type will be the same as the
input file's mime type.
model (str):
Optional. The ``model`` type requested for this translation.
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``,
If not provided, the default Google model (NMT) will be used
for translation.
glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig):
Optional. Glossary to be applied. The glossary must be
within the same region (have the same location-id) as the
model, otherwise an INVALID_ARGUMENT (400) error is
returned.
labels (Sequence[google.cloud.translate_v3beta1.types.TranslateDocumentRequest.LabelsEntry]):
Optional. The labels with user-defined
metadata for the request.
Label keys and values can be no longer than 63
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed. Label values are optional. Label
keys must start with a letter.
See
https://cloud.google.com/translate/docs/advanced/labels
for more information.
"""
parent = proto.Field(proto.STRING, number=1,)
source_language_code = proto.Field(proto.STRING, number=2,)
target_language_code = proto.Field(proto.STRING, number=3,)
document_input_config = proto.Field(
proto.MESSAGE, number=4, message="DocumentInputConfig",
)
document_output_config = proto.Field(
proto.MESSAGE, number=5, message="DocumentOutputConfig",
)
model = proto.Field(proto.STRING, number=6,)
glossary_config = proto.Field(
proto.MESSAGE, number=7, message="TranslateTextGlossaryConfig",
)
labels = proto.MapField(proto.STRING, proto.STRING, number=8,)
class DocumentTranslation(proto.Message):
r"""A translated document message.
Attributes:
byte_stream_outputs (Sequence[bytes]):
The array of translated documents. It is
expected to be size 1 for now. We may produce
multiple translated documents in the future for
other type of file formats.
mime_type (str):
The translated document's mime type.
detected_language_code (str):
The detected language for the input document.
If the user did not provide the source language
for the input document, this field will have the
language code automatically detected. If the
source language was passed, auto-detection of
the language does not occur and this field is
empty.
"""
byte_stream_outputs = proto.RepeatedField(proto.BYTES, number=1,)
mime_type = proto.Field(proto.STRING, number=2,)
detected_language_code = proto.Field(proto.STRING, number=3,)
class TranslateDocumentResponse(proto.Message):
r"""A translated document response message.
Attributes:
document_translation (google.cloud.translate_v3beta1.types.DocumentTranslation):
Translated document.
glossary_document_translation (google.cloud.translate_v3beta1.types.DocumentTranslation):
The document's translation output if a glossary is provided
in the request. This can be the same as
[TranslateDocumentResponse.document_translation] if no
glossary terms apply.
model (str):
Only present when 'model' is present in the request. 'model'
is normalized to have a project number.
For example: If the 'model' field in
TranslateDocumentRequest is:
``projects/{project-id}/locations/{location-id}/models/general/nmt``
then ``model`` here would be normalized to
``projects/{project-number}/locations/{location-id}/models/general/nmt``.
glossary_config (google.cloud.translate_v3beta1.types.TranslateTextGlossaryConfig):
The ``glossary_config`` used for this translation.
"""
document_translation = proto.Field(
proto.MESSAGE, number=1, message="DocumentTranslation",
)
glossary_document_translation = proto.Field(
proto.MESSAGE, number=2, message="DocumentTranslation",
)
model = proto.Field(proto.STRING, number=3,)
glossary_config = proto.Field(
proto.MESSAGE, number=4, message="TranslateTextGlossaryConfig",
)
class BatchTranslateTextRequest(proto.Message):
r"""The batch translation request.
Attributes:
parent (str):
Required. Location to make a call. Must refer to a caller's
project.
Format:
``projects/{project-number-or-id}/locations/{location-id}``.
The ``global`` location is not supported for batch
translation.
Only AutoML Translation models or glossaries within the same
region (have the same location-id) can be used, otherwise an
INVALID_ARGUMENT (400) error is returned.
source_language_code (str):
Required. Source language code.
target_language_codes (Sequence[str]):
Required. Specify up to 10 language codes
here.
models (Sequence[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest.ModelsEntry]):
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 default google model (nmt) is used.
input_configs (Sequence[google.cloud.translate_v3beta1.types.InputConfig]):
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.
output_config (google.cloud.translate_v3beta1.types.OutputConfig):
Required. Output configuration.
If 2 input configs match to the same file (that
is, same input path), we don't generate output
for duplicate inputs.
glossaries (Sequence[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest.GlossariesEntry]):
Optional. Glossaries to be applied for
translation. It's keyed by target language code.
labels (Sequence[google.cloud.translate_v3beta1.types.BatchTranslateTextRequest.LabelsEntry]):
Optional. The labels with user-defined
metadata for the request.
Label keys and values can be no longer than 63
characters (Unicode codepoints), can only
contain lowercase letters, numeric characters,
underscores and dashes. International characters
are allowed. Label values are optional. Label
keys must start with a letter.
See
https://cloud.google.com/translate/docs/labels
for more information.
"""
parent = proto.Field(proto.STRING, number=1,)
source_language_code = proto.Field(proto.STRING, number=2,)
target_language_codes = proto.RepeatedField(proto.STRING, number=3,)
models = proto.MapField(proto.STRING, proto.STRING, number=4,)
input_configs = proto.RepeatedField(proto.MESSAGE, number=5, message="InputConfig",)
output_config = proto.Field(proto.MESSAGE, number=6, message="OutputConfig",)
glossaries = proto.MapField(
proto.STRING, proto.MESSAGE, number=7, message="TranslateTextGlossaryConfig",
)
labels = proto.MapField(proto.STRING, proto.STRING, number=9,)
class BatchTranslateMetadata(proto.Message):
r"""State metadata for the batch translation operation.
Attributes:
state (google.cloud.translate_v3beta1.types.BatchTranslateMetadata.State):
The state of the operation.
translated_characters (int):
Number of successfully translated characters
so far (Unicode codepoints).
failed_characters (int):
Number of characters that have failed to
process so far (Unicode codepoints).
total_characters (int):
Total number of characters (Unicode
codepoints). This is the total number of
codepoints from input files times the number of
target languages and appears here shortly after
the call is submitted.
submit_time (google.protobuf.timestamp_pb2.Timestamp):
Time when the operation was submitted.
"""
class State(proto.Enum):
r"""State of the job."""
STATE_UNSPECIFIED = 0
RUNNING = 1
SUCCEEDED = 2
FAILED = 3
CANCELLING = 4
CANCELLED = 5
state = proto.Field(proto.ENUM, number=1, enum=State,)
translated_characters = proto.Field(proto.INT64, number=2,)
failed_characters = proto.Field(proto.INT64, number=3,)
total_characters = proto.Field(proto.INT64, number=4,)
submit_time = proto.Field(proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp,)
class BatchTranslateResponse(proto.Message):
r"""Stored in the
[google.longrunning.Operation.response][google.longrunning.Operation.response]
field returned by BatchTranslateText if at least one sentence is
translated successfully.
Attributes:
total_characters (int):
Total number of characters (Unicode
codepoints).
translated_characters (int):
Number of successfully translated characters
(Unicode codepoints).
failed_characters (int):
Number of characters that have failed to
process (Unicode codepoints).
submit_time (google.protobuf.timestamp_pb2.Timestamp):
Time when the operation was submitted.
end_time (google.protobuf.timestamp_pb2.Timestamp):
The time when the operation is finished and
[google.longrunning.Operation.done][google.longrunning.Operation.done]
is set to true.
"""
total_characters = proto.Field(proto.INT64, number=1,)
translated_characters = proto.Field(proto.INT64, number=2,)
failed_characters = proto.Field(proto.INT64, number=3,)
submit_time = proto.Field(proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,)
end_time = proto.Field(proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp,)
class GlossaryInputConfig(proto.Message):
r"""Input configuration for glossaries.
Attributes:
gcs_source (google.cloud.translate_v3beta1.types.GcsSource):
Required. Google Cloud Storage location of glossary data.
File format is determined based on the filename extension.
API returns [google.rpc.Code.INVALID_ARGUMENT] for
unsupported URI-s and file formats. Wildcards are not
allowed. This must be a single file in one of the following
formats:
For unidirectional glossaries:
- TSV/CSV (``.tsv``/``.csv``): 2 column file, tab- or
comma-separated. The first column is source text. The
second column is target text. The file must not contain
headers. That is, the first row is data, not column
names.
- TMX (``.tmx``): TMX file with parallel data defining
source/target term pairs.
For equivalent term sets glossaries:
- CSV (``.csv``): Multi-column CSV file defining equivalent
glossary terms in multiple languages. The format is
defined for Google Translation Toolkit and documented in
`Use a
glossary <https://support.google.com/translatortoolkit/answer/6306379?hl=en>`__.
"""
gcs_source = proto.Field(
proto.MESSAGE, number=1, oneof="source", message="GcsSource",
)
class Glossary(proto.Message):
r"""Represents a glossary built from user provided data.
Attributes:
name (str):
Required. The resource name of the glossary. Glossary names
have the form
``projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}``.
language_pair (google.cloud.translate_v3beta1.types.Glossary.LanguageCodePair):
Used with unidirectional glossaries.
language_codes_set (google.cloud.translate_v3beta1.types.Glossary.LanguageCodesSet):
Used with equivalent term set glossaries.
input_config (google.cloud.translate_v3beta1.types.GlossaryInputConfig):
Required. Provides examples to build the
glossary from. Total glossary must not exceed
10M Unicode codepoints.
entry_count (int):
Output only. The number of entries defined in
the glossary.
submit_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. When CreateGlossary was called.
end_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. When the glossary creation was
finished.
"""
class LanguageCodePair(proto.Message):