Enum value maps for BatchTranslateMetadata_State.
var (
BatchTranslateMetadata_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "RUNNING",
2: "SUCCEEDED",
3: "FAILED",
4: "CANCELLING",
5: "CANCELLED",
}
BatchTranslateMetadata_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"RUNNING": 1,
"SUCCEEDED": 2,
"FAILED": 3,
"CANCELLING": 4,
"CANCELLED": 5,
}
)
Enum value maps for CreateGlossaryMetadata_State.
var (
CreateGlossaryMetadata_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "RUNNING",
2: "SUCCEEDED",
3: "FAILED",
4: "CANCELLING",
5: "CANCELLED",
}
CreateGlossaryMetadata_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"RUNNING": 1,
"SUCCEEDED": 2,
"FAILED": 3,
"CANCELLING": 4,
"CANCELLED": 5,
}
)
Enum value maps for DeleteGlossaryMetadata_State.
var (
DeleteGlossaryMetadata_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "RUNNING",
2: "SUCCEEDED",
3: "FAILED",
4: "CANCELLING",
5: "CANCELLED",
}
DeleteGlossaryMetadata_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"RUNNING": 1,
"SUCCEEDED": 2,
"FAILED": 3,
"CANCELLING": 4,
"CANCELLED": 5,
}
)
Enum value maps for BatchTranslateDocumentMetadata_State.
var (
BatchTranslateDocumentMetadata_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "RUNNING",
2: "SUCCEEDED",
3: "FAILED",
4: "CANCELLING",
5: "CANCELLED",
}
BatchTranslateDocumentMetadata_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"RUNNING": 1,
"SUCCEEDED": 2,
"FAILED": 3,
"CANCELLING": 4,
"CANCELLED": 5,
}
)
var File_google_cloud_translate_v3beta1_translation_service_proto protoreflect.FileDescriptor
func RegisterTranslationServiceServer(s *grpc.Server, srv TranslationServiceServer)
Input configuration for BatchTranslateDocument request.
type BatchDocumentInputConfig struct {
// Specify the input.
//
// Types that are assignable to Source:
//
// *BatchDocumentInputConfig_GcsSource
Source isBatchDocumentInputConfig_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}
func (*BatchDocumentInputConfig) Descriptor() ([]byte, []int)
Deprecated: Use BatchDocumentInputConfig.ProtoReflect.Descriptor instead.
func (x *BatchDocumentInputConfig) GetGcsSource() *GcsSource
func (m *BatchDocumentInputConfig) GetSource() isBatchDocumentInputConfig_Source
func (*BatchDocumentInputConfig) ProtoMessage()
func (x *BatchDocumentInputConfig) ProtoReflect() protoreflect.Message
func (x *BatchDocumentInputConfig) Reset()
func (x *BatchDocumentInputConfig) String() string
type BatchDocumentInputConfig_GcsSource struct {
// Google Cloud Storage location for the source input.
// This can be a single file (for example,
// `gs://translation-test/input.docx`) or a wildcard (for example,
// `gs://translation-test/*`).
//
// File mime type is determined based on extension. Supported mime type
// includes:
// - `pdf`, application/pdf
// - `docx`,
// application/vnd.openxmlformats-officedocument.wordprocessingml.document
// - `pptx`,
// application/vnd.openxmlformats-officedocument.presentationml.presentation
// - `xlsx`,
// application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
//
// The max file size to support for `.docx`, `.pptx` and `.xlsx` is 100MB.
// The max file size to support for `.pdf` is 1GB and the max page limit is
// 1000 pages.
// The max file size to support for all input documents is 1GB.
GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}
Output configuration for BatchTranslateDocument request.
type BatchDocumentOutputConfig struct {
// The destination of output. The destination directory provided must exist
// and be empty.
//
// Types that are assignable to Destination:
//
// *BatchDocumentOutputConfig_GcsDestination
Destination isBatchDocumentOutputConfig_Destination `protobuf_oneof:"destination"`
// contains filtered or unexported fields
}
func (*BatchDocumentOutputConfig) Descriptor() ([]byte, []int)
Deprecated: Use BatchDocumentOutputConfig.ProtoReflect.Descriptor instead.
func (m *BatchDocumentOutputConfig) GetDestination() isBatchDocumentOutputConfig_Destination
func (x *BatchDocumentOutputConfig) GetGcsDestination() *GcsDestination
func (*BatchDocumentOutputConfig) ProtoMessage()
func (x *BatchDocumentOutputConfig) ProtoReflect() protoreflect.Message
func (x *BatchDocumentOutputConfig) Reset()
func (x *BatchDocumentOutputConfig) String() string
type BatchDocumentOutputConfig_GcsDestination struct {
// Google Cloud Storage destination for output content.
// For every single input document (for example, gs://a/b/c.[extension]), we
// generate at most 2 * n output files. (n is the # of target_language_codes
// in the BatchTranslateDocumentRequest).
//
// While the input documents are being processed, we write/update an index
// file `index.csv` under `gcs_destination.output_uri_prefix` (for example,
// gs://translation_output/index.csv) The index file is generated/updated as
// new files are being translated. The format is:
//
// input_document,target_language_code,translation_output,error_output,
// glossary_translation_output,glossary_error_output
//
// `input_document` is one file we matched using gcs_source.input_uri.
// `target_language_code` is provided in the request.
// `translation_output` contains the translations. (details provided below)
// `error_output` contains the error message during processing of the file.
// Both translations_file and errors_file could be empty strings if we have
// no content to output.
// `glossary_translation_output` and `glossary_error_output` are the
// translated output/error when we apply glossaries. 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 naming format of translation output files follows (for target
// language code [trg]): `translation_output`:
// gs://translation_output/a_b_c_[trg]_translation.[extension]
// `glossary_translation_output`:
// gs://translation_test/a_b_c_[trg]_glossary_translation.[extension] The
// output document will maintain the same file format as the input document.
//
// The naming format of error output files follows (for target language code
// [trg]): `error_output`: gs://translation_test/a_b_c_[trg]_errors.txt
// `glossary_error_output`:
// gs://translation_test/a_b_c_[trg]_glossary_translation.txt The error
// output is a txt file containing error details.
GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}
State metadata for the batch translation operation.
type BatchTranslateDocumentMetadata struct {
// The state of the operation.
State BatchTranslateDocumentMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata_State" json:"state,omitempty"`
// Total number of pages to translate in all documents so far. Documents
// without clear page definition (such as XLSX) are not counted.
TotalPages int64 `protobuf:"varint,2,opt,name=total_pages,json=totalPages,proto3" json:"total_pages,omitempty"`
// Number of successfully translated pages in all documents so far. Documents
// without clear page definition (such as XLSX) are not counted.
TranslatedPages int64 `protobuf:"varint,3,opt,name=translated_pages,json=translatedPages,proto3" json:"translated_pages,omitempty"`
// Number of pages that failed to process in all documents so far. Documents
// without clear page definition (such as XLSX) are not counted.
FailedPages int64 `protobuf:"varint,4,opt,name=failed_pages,json=failedPages,proto3" json:"failed_pages,omitempty"`
// Number of billable pages in documents with clear page definition (such as
// PDF, DOCX, PPTX) so far.
TotalBillablePages int64 `protobuf:"varint,5,opt,name=total_billable_pages,json=totalBillablePages,proto3" json:"total_billable_pages,omitempty"`
// Total number of characters (Unicode codepoints) in all documents so far.
TotalCharacters int64 `protobuf:"varint,6,opt,name=total_characters,json=totalCharacters,proto3" json:"total_characters,omitempty"`
// Number of successfully translated characters (Unicode codepoints) in all
// documents so far.
TranslatedCharacters int64 `protobuf:"varint,7,opt,name=translated_characters,json=translatedCharacters,proto3" json:"translated_characters,omitempty"`
// Number of characters that have failed to process (Unicode codepoints) in
// all documents so far.
FailedCharacters int64 `protobuf:"varint,8,opt,name=failed_characters,json=failedCharacters,proto3" json:"failed_characters,omitempty"`
// Number of billable characters (Unicode codepoints) in documents without
// clear page definition (such as XLSX) so far.
TotalBillableCharacters int64 `protobuf:"varint,9,opt,name=total_billable_characters,json=totalBillableCharacters,proto3" json:"total_billable_characters,omitempty"`
// Time when the operation was submitted.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// contains filtered or unexported fields
}
func (*BatchTranslateDocumentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use BatchTranslateDocumentMetadata.ProtoReflect.Descriptor instead.
func (x *BatchTranslateDocumentMetadata) GetFailedCharacters() int64
func (x *BatchTranslateDocumentMetadata) GetFailedPages() int64
func (x *BatchTranslateDocumentMetadata) GetState() BatchTranslateDocumentMetadata_State
func (x *BatchTranslateDocumentMetadata) GetSubmitTime() *timestamppb.Timestamp
func (x *BatchTranslateDocumentMetadata) GetTotalBillableCharacters() int64
func (x *BatchTranslateDocumentMetadata) GetTotalBillablePages() int64
func (x *BatchTranslateDocumentMetadata) GetTotalCharacters() int64
func (x *BatchTranslateDocumentMetadata) GetTotalPages() int64
func (x *BatchTranslateDocumentMetadata) GetTranslatedCharacters() int64
func (x *BatchTranslateDocumentMetadata) GetTranslatedPages() int64
func (*BatchTranslateDocumentMetadata) ProtoMessage()
func (x *BatchTranslateDocumentMetadata) ProtoReflect() protoreflect.Message
func (x *BatchTranslateDocumentMetadata) Reset()
func (x *BatchTranslateDocumentMetadata) String() string
State of the job.
type BatchTranslateDocumentMetadata_State int32
const (
// Invalid.
BatchTranslateDocumentMetadata_STATE_UNSPECIFIED BatchTranslateDocumentMetadata_State = 0
// Request is being processed.
BatchTranslateDocumentMetadata_RUNNING BatchTranslateDocumentMetadata_State = 1
// The batch is processed, and at least one item was successfully processed.
BatchTranslateDocumentMetadata_SUCCEEDED BatchTranslateDocumentMetadata_State = 2
// The batch is done and no item was successfully processed.
BatchTranslateDocumentMetadata_FAILED BatchTranslateDocumentMetadata_State = 3
// Request is in the process of being canceled after caller invoked
// longrunning.Operations.CancelOperation on the request id.
BatchTranslateDocumentMetadata_CANCELLING BatchTranslateDocumentMetadata_State = 4
// The batch is done after the user has called the
// longrunning.Operations.CancelOperation. Any records processed before the
// cancel command are output as specified in the request.
BatchTranslateDocumentMetadata_CANCELLED BatchTranslateDocumentMetadata_State = 5
)
func (BatchTranslateDocumentMetadata_State) Descriptor() protoreflect.EnumDescriptor
func (x BatchTranslateDocumentMetadata_State) Enum() *BatchTranslateDocumentMetadata_State
func (BatchTranslateDocumentMetadata_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use BatchTranslateDocumentMetadata_State.Descriptor instead.
func (x BatchTranslateDocumentMetadata_State) Number() protoreflect.EnumNumber
func (x BatchTranslateDocumentMetadata_State) String() string
func (BatchTranslateDocumentMetadata_State) Type() protoreflect.EnumType
The BatchTranslateDocument request.
type BatchTranslateDocumentRequest struct {
// Required. Location to make a regional call.
//
// 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.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. 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 (https://cloud.google.com/translate/docs/languages).
SourceLanguageCode string `protobuf:"bytes,2,opt,name=source_language_code,json=sourceLanguageCode,proto3" json:"source_language_code,omitempty"`
// Required. The BCP-47 language code to use for translation of the input
// document. Specify up to 10 language codes here.
TargetLanguageCodes []string `protobuf:"bytes,3,rep,name=target_language_codes,json=targetLanguageCodes,proto3" json:"target_language_codes,omitempty"`
// Required. Input configurations.
// The total number of files matched should be <= 100.
// The total content size to translate should be <= 100M Unicode codepoints.
// The files must use UTF-8 encoding.
InputConfigs []*BatchDocumentInputConfig `protobuf:"bytes,4,rep,name=input_configs,json=inputConfigs,proto3" json:"input_configs,omitempty"`
// 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.
OutputConfig *BatchDocumentOutputConfig `protobuf:"bytes,5,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
// Optional. The models to use for translation. Map's key is target language
// code. Map's value is the 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.
Models map[string]string `protobuf:"bytes,6,rep,name=models,proto3" json:"models,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. Glossaries to be applied. It's keyed by target language code.
Glossaries map[string]*TranslateTextGlossaryConfig `protobuf:"bytes,7,rep,name=glossaries,proto3" json:"glossaries,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. File format conversion map to be applied to all input files.
// Map's key is the original mime_type. Map's value is the target mime_type of
// translated documents.
//
// Supported file format conversion includes:
// - `application/pdf` to
// `application/vnd.openxmlformats-officedocument.wordprocessingml.document`
//
// If nothing specified, output files will be in the same format as the
// original file.
FormatConversions map[string]string `protobuf:"bytes,8,rep,name=format_conversions,json=formatConversions,proto3" json:"format_conversions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*BatchTranslateDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchTranslateDocumentRequest.ProtoReflect.Descriptor instead.
func (x *BatchTranslateDocumentRequest) GetFormatConversions() map[string]string
func (x *BatchTranslateDocumentRequest) GetGlossaries() map[string]*TranslateTextGlossaryConfig
func (x *BatchTranslateDocumentRequest) GetInputConfigs() []*BatchDocumentInputConfig
func (x *BatchTranslateDocumentRequest) GetModels() map[string]string
func (x *BatchTranslateDocumentRequest) GetOutputConfig() *BatchDocumentOutputConfig
func (x *BatchTranslateDocumentRequest) GetParent() string
func (x *BatchTranslateDocumentRequest) GetSourceLanguageCode() string
func (x *BatchTranslateDocumentRequest) GetTargetLanguageCodes() []string
func (*BatchTranslateDocumentRequest) ProtoMessage()
func (x *BatchTranslateDocumentRequest) ProtoReflect() protoreflect.Message
func (x *BatchTranslateDocumentRequest) Reset()
func (x *BatchTranslateDocumentRequest) String() string
Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateDocument if at least one document is translated successfully.
type BatchTranslateDocumentResponse struct {
// Total number of pages to translate in all documents. Documents without
// clear page definition (such as XLSX) are not counted.
TotalPages int64 `protobuf:"varint,1,opt,name=total_pages,json=totalPages,proto3" json:"total_pages,omitempty"`
// Number of successfully translated pages in all documents. Documents without
// clear page definition (such as XLSX) are not counted.
TranslatedPages int64 `protobuf:"varint,2,opt,name=translated_pages,json=translatedPages,proto3" json:"translated_pages,omitempty"`
// Number of pages that failed to process in all documents. Documents without
// clear page definition (such as XLSX) are not counted.
FailedPages int64 `protobuf:"varint,3,opt,name=failed_pages,json=failedPages,proto3" json:"failed_pages,omitempty"`
// Number of billable pages in documents with clear page definition (such as
// PDF, DOCX, PPTX)
TotalBillablePages int64 `protobuf:"varint,4,opt,name=total_billable_pages,json=totalBillablePages,proto3" json:"total_billable_pages,omitempty"`
// Total number of characters (Unicode codepoints) in all documents.
TotalCharacters int64 `protobuf:"varint,5,opt,name=total_characters,json=totalCharacters,proto3" json:"total_characters,omitempty"`
// Number of successfully translated characters (Unicode codepoints) in all
// documents.
TranslatedCharacters int64 `protobuf:"varint,6,opt,name=translated_characters,json=translatedCharacters,proto3" json:"translated_characters,omitempty"`
// Number of characters that have failed to process (Unicode codepoints) in
// all documents.
FailedCharacters int64 `protobuf:"varint,7,opt,name=failed_characters,json=failedCharacters,proto3" json:"failed_characters,omitempty"`
// Number of billable characters (Unicode codepoints) in documents without
// clear page definition, such as XLSX.
TotalBillableCharacters int64 `protobuf:"varint,8,opt,name=total_billable_characters,json=totalBillableCharacters,proto3" json:"total_billable_characters,omitempty"`
// Time when the operation was submitted.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// The time when the operation is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is
// set to true.
EndTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*BatchTranslateDocumentResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchTranslateDocumentResponse.ProtoReflect.Descriptor instead.
func (x *BatchTranslateDocumentResponse) GetEndTime() *timestamppb.Timestamp
func (x *BatchTranslateDocumentResponse) GetFailedCharacters() int64
func (x *BatchTranslateDocumentResponse) GetFailedPages() int64
func (x *BatchTranslateDocumentResponse) GetSubmitTime() *timestamppb.Timestamp
func (x *BatchTranslateDocumentResponse) GetTotalBillableCharacters() int64
func (x *BatchTranslateDocumentResponse) GetTotalBillablePages() int64
func (x *BatchTranslateDocumentResponse) GetTotalCharacters() int64
func (x *BatchTranslateDocumentResponse) GetTotalPages() int64
func (x *BatchTranslateDocumentResponse) GetTranslatedCharacters() int64
func (x *BatchTranslateDocumentResponse) GetTranslatedPages() int64
func (*BatchTranslateDocumentResponse) ProtoMessage()
func (x *BatchTranslateDocumentResponse) ProtoReflect() protoreflect.Message
func (x *BatchTranslateDocumentResponse) Reset()
func (x *BatchTranslateDocumentResponse) String() string
State metadata for the batch translation operation.
type BatchTranslateMetadata struct {
// The state of the operation.
State BatchTranslateMetadata_State `protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.translation.v3beta1.BatchTranslateMetadata_State" json:"state,omitempty"`
// Number of successfully translated characters so far (Unicode codepoints).
TranslatedCharacters int64 `protobuf:"varint,2,opt,name=translated_characters,json=translatedCharacters,proto3" json:"translated_characters,omitempty"`
// Number of characters that have failed to process so far (Unicode
// codepoints).
FailedCharacters int64 `protobuf:"varint,3,opt,name=failed_characters,json=failedCharacters,proto3" json:"failed_characters,omitempty"`
// 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.
TotalCharacters int64 `protobuf:"varint,4,opt,name=total_characters,json=totalCharacters,proto3" json:"total_characters,omitempty"`
// Time when the operation was submitted.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// contains filtered or unexported fields
}
func (*BatchTranslateMetadata) Descriptor() ([]byte, []int)
Deprecated: Use BatchTranslateMetadata.ProtoReflect.Descriptor instead.
func (x *BatchTranslateMetadata) GetFailedCharacters() int64
func (x *BatchTranslateMetadata) GetState() BatchTranslateMetadata_State
func (x *BatchTranslateMetadata) GetSubmitTime() *timestamppb.Timestamp
func (x *BatchTranslateMetadata) GetTotalCharacters() int64
func (x *BatchTranslateMetadata) GetTranslatedCharacters() int64
func (*BatchTranslateMetadata) ProtoMessage()
func (x *BatchTranslateMetadata) ProtoReflect() protoreflect.Message
func (x *BatchTranslateMetadata) Reset()
func (x *BatchTranslateMetadata) String() string
State of the job.
type BatchTranslateMetadata_State int32
const (
// Invalid.
BatchTranslateMetadata_STATE_UNSPECIFIED BatchTranslateMetadata_State = 0
// Request is being processed.
BatchTranslateMetadata_RUNNING BatchTranslateMetadata_State = 1
// The batch is processed, and at least one item was successfully
// processed.
BatchTranslateMetadata_SUCCEEDED BatchTranslateMetadata_State = 2
// The batch is done and no item was successfully processed.
BatchTranslateMetadata_FAILED BatchTranslateMetadata_State = 3
// Request is in the process of being canceled after caller invoked
// longrunning.Operations.CancelOperation on the request id.
BatchTranslateMetadata_CANCELLING BatchTranslateMetadata_State = 4
// The batch is done after the user has called the
// longrunning.Operations.CancelOperation. Any records processed before the
// cancel command are output as specified in the request.
BatchTranslateMetadata_CANCELLED BatchTranslateMetadata_State = 5
)
func (BatchTranslateMetadata_State) Descriptor() protoreflect.EnumDescriptor
func (x BatchTranslateMetadata_State) Enum() *BatchTranslateMetadata_State
func (BatchTranslateMetadata_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use BatchTranslateMetadata_State.Descriptor instead.
func (x BatchTranslateMetadata_State) Number() protoreflect.EnumNumber
func (x BatchTranslateMetadata_State) String() string
func (BatchTranslateMetadata_State) Type() protoreflect.EnumType
Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by BatchTranslateText if at least one sentence is translated successfully.
type BatchTranslateResponse struct {
// Total number of characters (Unicode codepoints).
TotalCharacters int64 `protobuf:"varint,1,opt,name=total_characters,json=totalCharacters,proto3" json:"total_characters,omitempty"`
// Number of successfully translated characters (Unicode codepoints).
TranslatedCharacters int64 `protobuf:"varint,2,opt,name=translated_characters,json=translatedCharacters,proto3" json:"translated_characters,omitempty"`
// Number of characters that have failed to process (Unicode codepoints).
FailedCharacters int64 `protobuf:"varint,3,opt,name=failed_characters,json=failedCharacters,proto3" json:"failed_characters,omitempty"`
// Time when the operation was submitted.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// The time when the operation is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is
// set to true.
EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*BatchTranslateResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchTranslateResponse.ProtoReflect.Descriptor instead.
func (x *BatchTranslateResponse) GetEndTime() *timestamppb.Timestamp
func (x *BatchTranslateResponse) GetFailedCharacters() int64
func (x *BatchTranslateResponse) GetSubmitTime() *timestamppb.Timestamp
func (x *BatchTranslateResponse) GetTotalCharacters() int64
func (x *BatchTranslateResponse) GetTranslatedCharacters() int64
func (*BatchTranslateResponse) ProtoMessage()
func (x *BatchTranslateResponse) ProtoReflect() protoreflect.Message
func (x *BatchTranslateResponse) Reset()
func (x *BatchTranslateResponse) String() string
The batch translation request.
type BatchTranslateTextRequest struct {
// 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.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Source language code.
SourceLanguageCode string `protobuf:"bytes,2,opt,name=source_language_code,json=sourceLanguageCode,proto3" json:"source_language_code,omitempty"`
// Required. Specify up to 10 language codes here.
TargetLanguageCodes []string `protobuf:"bytes,3,rep,name=target_language_codes,json=targetLanguageCodes,proto3" json:"target_language_codes,omitempty"`
// 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.
Models map[string]string `protobuf:"bytes,4,rep,name=models,proto3" json:"models,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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.
InputConfigs []*InputConfig `protobuf:"bytes,5,rep,name=input_configs,json=inputConfigs,proto3" json:"input_configs,omitempty"`
// 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.
OutputConfig *OutputConfig `protobuf:"bytes,6,opt,name=output_config,json=outputConfig,proto3" json:"output_config,omitempty"`
// Optional. Glossaries to be applied for translation.
// It's keyed by target language code.
Glossaries map[string]*TranslateTextGlossaryConfig `protobuf:"bytes,7,rep,name=glossaries,proto3" json:"glossaries,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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.
Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*BatchTranslateTextRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchTranslateTextRequest.ProtoReflect.Descriptor instead.
func (x *BatchTranslateTextRequest) GetGlossaries() map[string]*TranslateTextGlossaryConfig
func (x *BatchTranslateTextRequest) GetInputConfigs() []*InputConfig
func (x *BatchTranslateTextRequest) GetLabels() map[string]string
func (x *BatchTranslateTextRequest) GetModels() map[string]string
func (x *BatchTranslateTextRequest) GetOutputConfig() *OutputConfig
func (x *BatchTranslateTextRequest) GetParent() string
func (x *BatchTranslateTextRequest) GetSourceLanguageCode() string
func (x *BatchTranslateTextRequest) GetTargetLanguageCodes() []string
func (*BatchTranslateTextRequest) ProtoMessage()
func (x *BatchTranslateTextRequest) ProtoReflect() protoreflect.Message
func (x *BatchTranslateTextRequest) Reset()
func (x *BatchTranslateTextRequest) String() string
Stored in the [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by CreateGlossary.
type CreateGlossaryMetadata struct {
// The name of the glossary that is being created.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The current state of the glossary creation operation.
State CreateGlossaryMetadata_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.translation.v3beta1.CreateGlossaryMetadata_State" json:"state,omitempty"`
// The time when the operation was submitted to the server.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// contains filtered or unexported fields
}
func (*CreateGlossaryMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateGlossaryMetadata.ProtoReflect.Descriptor instead.
func (x *CreateGlossaryMetadata) GetName() string
func (x *CreateGlossaryMetadata) GetState() CreateGlossaryMetadata_State
func (x *CreateGlossaryMetadata) GetSubmitTime() *timestamppb.Timestamp
func (*CreateGlossaryMetadata) ProtoMessage()
func (x *CreateGlossaryMetadata) ProtoReflect() protoreflect.Message
func (x *CreateGlossaryMetadata) Reset()
func (x *CreateGlossaryMetadata) String() string
Enumerates the possible states that the creation request can be in.
type CreateGlossaryMetadata_State int32
const (
// Invalid.
CreateGlossaryMetadata_STATE_UNSPECIFIED CreateGlossaryMetadata_State = 0
// Request is being processed.
CreateGlossaryMetadata_RUNNING CreateGlossaryMetadata_State = 1
// The glossary was successfully created.
CreateGlossaryMetadata_SUCCEEDED CreateGlossaryMetadata_State = 2
// Failed to create the glossary.
CreateGlossaryMetadata_FAILED CreateGlossaryMetadata_State = 3
// Request is in the process of being canceled after caller invoked
// longrunning.Operations.CancelOperation on the request id.
CreateGlossaryMetadata_CANCELLING CreateGlossaryMetadata_State = 4
// The glossary creation request was successfully canceled.
CreateGlossaryMetadata_CANCELLED CreateGlossaryMetadata_State = 5
)
func (CreateGlossaryMetadata_State) Descriptor() protoreflect.EnumDescriptor
func (x CreateGlossaryMetadata_State) Enum() *CreateGlossaryMetadata_State
func (CreateGlossaryMetadata_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use CreateGlossaryMetadata_State.Descriptor instead.
func (x CreateGlossaryMetadata_State) Number() protoreflect.EnumNumber
func (x CreateGlossaryMetadata_State) String() string
func (CreateGlossaryMetadata_State) Type() protoreflect.EnumType
Request message for CreateGlossary.
type CreateGlossaryRequest struct {
// Required. The project name.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The glossary to create.
Glossary *Glossary `protobuf:"bytes,2,opt,name=glossary,proto3" json:"glossary,omitempty"`
// contains filtered or unexported fields
}
func (*CreateGlossaryRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateGlossaryRequest.ProtoReflect.Descriptor instead.
func (x *CreateGlossaryRequest) GetGlossary() *Glossary
func (x *CreateGlossaryRequest) GetParent() string
func (*CreateGlossaryRequest) ProtoMessage()
func (x *CreateGlossaryRequest) ProtoReflect() protoreflect.Message
func (x *CreateGlossaryRequest) Reset()
func (x *CreateGlossaryRequest) String() string
Stored in the [google.longrunning.Operation.metadata][google.longrunning.Operation.metadata] field returned by DeleteGlossary.
type DeleteGlossaryMetadata struct {
// The name of the glossary that is being deleted.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The current state of the glossary deletion operation.
State DeleteGlossaryMetadata_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.cloud.translation.v3beta1.DeleteGlossaryMetadata_State" json:"state,omitempty"`
// The time when the operation was submitted to the server.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteGlossaryMetadata) Descriptor() ([]byte, []int)
Deprecated: Use DeleteGlossaryMetadata.ProtoReflect.Descriptor instead.
func (x *DeleteGlossaryMetadata) GetName() string
func (x *DeleteGlossaryMetadata) GetState() DeleteGlossaryMetadata_State
func (x *DeleteGlossaryMetadata) GetSubmitTime() *timestamppb.Timestamp
func (*DeleteGlossaryMetadata) ProtoMessage()
func (x *DeleteGlossaryMetadata) ProtoReflect() protoreflect.Message
func (x *DeleteGlossaryMetadata) Reset()
func (x *DeleteGlossaryMetadata) String() string
Enumerates the possible states that the creation request can be in.
type DeleteGlossaryMetadata_State int32
const (
// Invalid.
DeleteGlossaryMetadata_STATE_UNSPECIFIED DeleteGlossaryMetadata_State = 0
// Request is being processed.
DeleteGlossaryMetadata_RUNNING DeleteGlossaryMetadata_State = 1
// The glossary was successfully deleted.
DeleteGlossaryMetadata_SUCCEEDED DeleteGlossaryMetadata_State = 2
// Failed to delete the glossary.
DeleteGlossaryMetadata_FAILED DeleteGlossaryMetadata_State = 3
// Request is in the process of being canceled after caller invoked
// longrunning.Operations.CancelOperation on the request id.
DeleteGlossaryMetadata_CANCELLING DeleteGlossaryMetadata_State = 4
// The glossary deletion request was successfully canceled.
DeleteGlossaryMetadata_CANCELLED DeleteGlossaryMetadata_State = 5
)
func (DeleteGlossaryMetadata_State) Descriptor() protoreflect.EnumDescriptor
func (x DeleteGlossaryMetadata_State) Enum() *DeleteGlossaryMetadata_State
func (DeleteGlossaryMetadata_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use DeleteGlossaryMetadata_State.Descriptor instead.
func (x DeleteGlossaryMetadata_State) Number() protoreflect.EnumNumber
func (x DeleteGlossaryMetadata_State) String() string
func (DeleteGlossaryMetadata_State) Type() protoreflect.EnumType
Request message for DeleteGlossary.
type DeleteGlossaryRequest struct {
// Required. The name of the glossary to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteGlossaryRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteGlossaryRequest.ProtoReflect.Descriptor instead.
func (x *DeleteGlossaryRequest) GetName() string
func (*DeleteGlossaryRequest) ProtoMessage()
func (x *DeleteGlossaryRequest) ProtoReflect() protoreflect.Message
func (x *DeleteGlossaryRequest) Reset()
func (x *DeleteGlossaryRequest) String() string
Stored in the [google.longrunning.Operation.response][google.longrunning.Operation.response] field returned by DeleteGlossary.
type DeleteGlossaryResponse struct {
// The name of the deleted glossary.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The time when the operation was submitted to the server.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// The time when the glossary deletion is finished and
// [google.longrunning.Operation.done][google.longrunning.Operation.done] is
// set to true.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteGlossaryResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteGlossaryResponse.ProtoReflect.Descriptor instead.
func (x *DeleteGlossaryResponse) GetEndTime() *timestamppb.Timestamp
func (x *DeleteGlossaryResponse) GetName() string
func (x *DeleteGlossaryResponse) GetSubmitTime() *timestamppb.Timestamp
func (*DeleteGlossaryResponse) ProtoMessage()
func (x *DeleteGlossaryResponse) ProtoReflect() protoreflect.Message
func (x *DeleteGlossaryResponse) Reset()
func (x *DeleteGlossaryResponse) String() string
The request message for language detection.
type DetectLanguageRequest struct {
// 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.
Parent string `protobuf:"bytes,5,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
Model string `protobuf:"bytes,4,opt,name=model,proto3" json:"model,omitempty"`
// Required. The source of the document from which to detect the language.
//
// Types that are assignable to Source:
//
// *DetectLanguageRequest_Content
Source isDetectLanguageRequest_Source `protobuf_oneof:"source"`
// Optional. The format of the source text, for example, "text/html",
// "text/plain". If left blank, the MIME type defaults to "text/html".
MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// 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.
Labels map[string]string `protobuf:"bytes,6,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*DetectLanguageRequest) Descriptor() ([]byte, []int)
Deprecated: Use DetectLanguageRequest.ProtoReflect.Descriptor instead.
func (x *DetectLanguageRequest) GetContent() string
func (x *DetectLanguageRequest) GetLabels() map[string]string
func (x *DetectLanguageRequest) GetMimeType() string
func (x *DetectLanguageRequest) GetModel() string
func (x *DetectLanguageRequest) GetParent() string
func (m *DetectLanguageRequest) GetSource() isDetectLanguageRequest_Source
func (*DetectLanguageRequest) ProtoMessage()
func (x *DetectLanguageRequest) ProtoReflect() protoreflect.Message
func (x *DetectLanguageRequest) Reset()
func (x *DetectLanguageRequest) String() string
type DetectLanguageRequest_Content struct {
// The content of the input stored as a string.
Content string `protobuf:"bytes,1,opt,name=content,proto3,oneof"`
}
The response message for language detection.
type DetectLanguageResponse struct {
// A list of detected languages sorted by detection confidence in descending
// order. The most probable language first.
Languages []*DetectedLanguage `protobuf:"bytes,1,rep,name=languages,proto3" json:"languages,omitempty"`
// contains filtered or unexported fields
}
func (*DetectLanguageResponse) Descriptor() ([]byte, []int)
Deprecated: Use DetectLanguageResponse.ProtoReflect.Descriptor instead.
func (x *DetectLanguageResponse) GetLanguages() []*DetectedLanguage
func (*DetectLanguageResponse) ProtoMessage()
func (x *DetectLanguageResponse) ProtoReflect() protoreflect.Message
func (x *DetectLanguageResponse) Reset()
func (x *DetectLanguageResponse) String() string
The response message for language detection.
type DetectedLanguage struct {
// The BCP-47 language code of source content in the request, detected
// automatically.
LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// The confidence of the detection result for this language.
Confidence float32 `protobuf:"fixed32,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
// contains filtered or unexported fields
}
func (*DetectedLanguage) Descriptor() ([]byte, []int)
Deprecated: Use DetectedLanguage.ProtoReflect.Descriptor instead.
func (x *DetectedLanguage) GetConfidence() float32
func (x *DetectedLanguage) GetLanguageCode() string
func (*DetectedLanguage) ProtoMessage()
func (x *DetectedLanguage) ProtoReflect() protoreflect.Message
func (x *DetectedLanguage) Reset()
func (x *DetectedLanguage) String() string
A document translation request input config.
type DocumentInputConfig struct {
// Specifies the source for the document's content.
// The input file size should be <= 20MB for
// - application/vnd.openxmlformats-officedocument.wordprocessingml.document
// - application/vnd.openxmlformats-officedocument.presentationml.presentation
// - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
// The input file size should be <= 20MB and the maximum page limit is 20 for
// - application/pdf
//
// Types that are assignable to Source:
//
// *DocumentInputConfig_Content
// *DocumentInputConfig_GcsSource
Source isDocumentInputConfig_Source `protobuf_oneof:"source"`
// 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
MimeType string `protobuf:"bytes,4,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentInputConfig) Descriptor() ([]byte, []int)
Deprecated: Use DocumentInputConfig.ProtoReflect.Descriptor instead.
func (x *DocumentInputConfig) GetContent() []byte
func (x *DocumentInputConfig) GetGcsSource() *GcsSource
func (x *DocumentInputConfig) GetMimeType() string
func (m *DocumentInputConfig) GetSource() isDocumentInputConfig_Source
func (*DocumentInputConfig) ProtoMessage()
func (x *DocumentInputConfig) ProtoReflect() protoreflect.Message
func (x *DocumentInputConfig) Reset()
func (x *DocumentInputConfig) String() string
type DocumentInputConfig_Content struct {
// Document's content represented as a stream of bytes.
Content []byte `protobuf:"bytes,1,opt,name=content,proto3,oneof"`
}
type DocumentInputConfig_GcsSource struct {
// Google Cloud Storage location. This must be a single file.
// For example: gs://example_bucket/example_file.pdf
GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}
A document translation request output config.
type DocumentOutputConfig struct {
// A URI destination for the translated document.
// It is optional to provide a destination. If provided the results from
// TranslateDocument will be stored in the destination.
// Whether a destination is provided or not, the translated documents will be
// returned within TranslateDocumentResponse.document_translation and
// TranslateDocumentResponse.glossary_document_translation.
//
// Types that are assignable to Destination:
//
// *DocumentOutputConfig_GcsDestination
Destination isDocumentOutputConfig_Destination `protobuf_oneof:"destination"`
// 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
MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentOutputConfig) Descriptor() ([]byte, []int)
Deprecated: Use DocumentOutputConfig.ProtoReflect.Descriptor instead.
func (m *DocumentOutputConfig) GetDestination() isDocumentOutputConfig_Destination
func (x *DocumentOutputConfig) GetGcsDestination() *GcsDestination
func (x *DocumentOutputConfig) GetMimeType() string
func (*DocumentOutputConfig) ProtoMessage()
func (x *DocumentOutputConfig) ProtoReflect() protoreflect.Message
func (x *DocumentOutputConfig) Reset()
func (x *DocumentOutputConfig) String() string
type DocumentOutputConfig_GcsDestination struct {
// 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.
GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}
A translated document message.
type DocumentTranslation struct {
// 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.
ByteStreamOutputs [][]byte `protobuf:"bytes,1,rep,name=byte_stream_outputs,json=byteStreamOutputs,proto3" json:"byte_stream_outputs,omitempty"`
// The translated document's mime type.
MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// 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.
DetectedLanguageCode string `protobuf:"bytes,3,opt,name=detected_language_code,json=detectedLanguageCode,proto3" json:"detected_language_code,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentTranslation) Descriptor() ([]byte, []int)
Deprecated: Use DocumentTranslation.ProtoReflect.Descriptor instead.
func (x *DocumentTranslation) GetByteStreamOutputs() [][]byte
func (x *DocumentTranslation) GetDetectedLanguageCode() string
func (x *DocumentTranslation) GetMimeType() string
func (*DocumentTranslation) ProtoMessage()
func (x *DocumentTranslation) ProtoReflect() protoreflect.Message
func (x *DocumentTranslation) Reset()
func (x *DocumentTranslation) String() string
The Google Cloud Storage location for the output content.
type GcsDestination struct {
// 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.
OutputUriPrefix string `protobuf:"bytes,1,opt,name=output_uri_prefix,json=outputUriPrefix,proto3" json:"output_uri_prefix,omitempty"`
// contains filtered or unexported fields
}
func (*GcsDestination) Descriptor() ([]byte, []int)
Deprecated: Use GcsDestination.ProtoReflect.Descriptor instead.
func (x *GcsDestination) GetOutputUriPrefix() string
func (*GcsDestination) ProtoMessage()
func (x *GcsDestination) ProtoReflect() protoreflect.Message
func (x *GcsDestination) Reset()
func (x *GcsDestination) String() string
The Google Cloud Storage location for the input content.
type GcsSource struct {
// Required. Source data URI. For example, `gs://my_bucket/my_object`.
InputUri string `protobuf:"bytes,1,opt,name=input_uri,json=inputUri,proto3" json:"input_uri,omitempty"`
// contains filtered or unexported fields
}
func (*GcsSource) Descriptor() ([]byte, []int)
Deprecated: Use GcsSource.ProtoReflect.Descriptor instead.
func (x *GcsSource) GetInputUri() string
func (*GcsSource) ProtoMessage()
func (x *GcsSource) ProtoReflect() protoreflect.Message
func (x *GcsSource) Reset()
func (x *GcsSource) String() string
Request message for GetGlossary.
type GetGlossaryRequest struct {
// Required. The name of the glossary to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetGlossaryRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetGlossaryRequest.ProtoReflect.Descriptor instead.
func (x *GetGlossaryRequest) GetName() string
func (*GetGlossaryRequest) ProtoMessage()
func (x *GetGlossaryRequest) ProtoReflect() protoreflect.Message
func (x *GetGlossaryRequest) Reset()
func (x *GetGlossaryRequest) String() string
The request message for discovering supported languages.
type GetSupportedLanguagesRequest struct {
// 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.
Parent string `protobuf:"bytes,3,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
DisplayLanguageCode string `protobuf:"bytes,1,opt,name=display_language_code,json=displayLanguageCode,proto3" json:"display_language_code,omitempty"`
// 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.
Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
// contains filtered or unexported fields
}
func (*GetSupportedLanguagesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSupportedLanguagesRequest.ProtoReflect.Descriptor instead.
func (x *GetSupportedLanguagesRequest) GetDisplayLanguageCode() string
func (x *GetSupportedLanguagesRequest) GetModel() string
func (x *GetSupportedLanguagesRequest) GetParent() string
func (*GetSupportedLanguagesRequest) ProtoMessage()
func (x *GetSupportedLanguagesRequest) ProtoReflect() protoreflect.Message
func (x *GetSupportedLanguagesRequest) Reset()
func (x *GetSupportedLanguagesRequest) String() string
Represents a glossary built from user provided data.
type Glossary struct {
// Required. The resource name of the glossary. Glossary names have the form
// `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Languages supported by the glossary.
//
// Types that are assignable to Languages:
//
// *Glossary_LanguagePair
// *Glossary_LanguageCodesSet_
Languages isGlossary_Languages `protobuf_oneof:"languages"`
// Required. Provides examples to build the glossary from.
// Total glossary must not exceed 10M Unicode codepoints.
InputConfig *GlossaryInputConfig `protobuf:"bytes,5,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
// Output only. The number of entries defined in the glossary.
EntryCount int32 `protobuf:"varint,6,opt,name=entry_count,json=entryCount,proto3" json:"entry_count,omitempty"`
// Output only. When CreateGlossary was called.
SubmitTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=submit_time,json=submitTime,proto3" json:"submit_time,omitempty"`
// Output only. When the glossary creation was finished.
EndTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*Glossary) Descriptor() ([]byte, []int)
Deprecated: Use Glossary.ProtoReflect.Descriptor instead.
func (x *Glossary) GetEndTime() *timestamppb.Timestamp
func (x *Glossary) GetEntryCount() int32
func (x *Glossary) GetInputConfig() *GlossaryInputConfig
func (x *Glossary) GetLanguageCodesSet() *Glossary_LanguageCodesSet
func (x *Glossary) GetLanguagePair() *Glossary_LanguageCodePair
func (m *Glossary) GetLanguages() isGlossary_Languages
func (x *Glossary) GetName() string
func (x *Glossary) GetSubmitTime() *timestamppb.Timestamp
func (*Glossary) ProtoMessage()
func (x *Glossary) ProtoReflect() protoreflect.Message
func (x *Glossary) Reset()
func (x *Glossary) String() string
Input configuration for glossaries.
type GlossaryInputConfig struct {
// Required. Specify the input.
//
// Types that are assignable to Source:
//
// *GlossaryInputConfig_GcsSource
Source isGlossaryInputConfig_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}
func (*GlossaryInputConfig) Descriptor() ([]byte, []int)
Deprecated: Use GlossaryInputConfig.ProtoReflect.Descriptor instead.
func (x *GlossaryInputConfig) GetGcsSource() *GcsSource
func (m *GlossaryInputConfig) GetSource() isGlossaryInputConfig_Source
func (*GlossaryInputConfig) ProtoMessage()
func (x *GlossaryInputConfig) ProtoReflect() protoreflect.Message
func (x *GlossaryInputConfig) Reset()
func (x *GlossaryInputConfig) String() string
type GlossaryInputConfig_GcsSource struct {
// 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).
GcsSource *GcsSource `protobuf:"bytes,1,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}
Used with unidirectional glossaries.
type Glossary_LanguageCodePair struct {
// Required. The BCP-47 language code of the input text, for example,
// "en-US". Expected to be an exact match for GlossaryTerm.language_code.
SourceLanguageCode string `protobuf:"bytes,1,opt,name=source_language_code,json=sourceLanguageCode,proto3" json:"source_language_code,omitempty"`
// Required. The BCP-47 language code for translation output, for example,
// "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
TargetLanguageCode string `protobuf:"bytes,2,opt,name=target_language_code,json=targetLanguageCode,proto3" json:"target_language_code,omitempty"`
// contains filtered or unexported fields
}
func (*Glossary_LanguageCodePair) Descriptor() ([]byte, []int)
Deprecated: Use Glossary_LanguageCodePair.ProtoReflect.Descriptor instead.
func (x *Glossary_LanguageCodePair) GetSourceLanguageCode() string
func (x *Glossary_LanguageCodePair) GetTargetLanguageCode() string
func (*Glossary_LanguageCodePair) ProtoMessage()
func (x *Glossary_LanguageCodePair) ProtoReflect() protoreflect.Message
func (x *Glossary_LanguageCodePair) Reset()
func (x *Glossary_LanguageCodePair) String() string
Used with equivalent term set glossaries.
type Glossary_LanguageCodesSet struct {
// The BCP-47 language code(s) for terms defined in the glossary.
// All entries are unique. The list contains at least two entries.
// Expected to be an exact match for GlossaryTerm.language_code.
LanguageCodes []string `protobuf:"bytes,1,rep,name=language_codes,json=languageCodes,proto3" json:"language_codes,omitempty"`
// contains filtered or unexported fields
}
func (*Glossary_LanguageCodesSet) Descriptor() ([]byte, []int)
Deprecated: Use Glossary_LanguageCodesSet.ProtoReflect.Descriptor instead.
func (x *Glossary_LanguageCodesSet) GetLanguageCodes() []string
func (*Glossary_LanguageCodesSet) ProtoMessage()
func (x *Glossary_LanguageCodesSet) ProtoReflect() protoreflect.Message
func (x *Glossary_LanguageCodesSet) Reset()
func (x *Glossary_LanguageCodesSet) String() string
type Glossary_LanguageCodesSet_ struct {
// Used with equivalent term set glossaries.
LanguageCodesSet *Glossary_LanguageCodesSet `protobuf:"bytes,4,opt,name=language_codes_set,json=languageCodesSet,proto3,oneof"`
}
type Glossary_LanguagePair struct {
// Used with unidirectional glossaries.
LanguagePair *Glossary_LanguageCodePair `protobuf:"bytes,3,opt,name=language_pair,json=languagePair,proto3,oneof"`
}
Input configuration for BatchTranslateText request.
type InputConfig struct {
// 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.
MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// Required. Specify the input.
//
// Types that are assignable to Source:
//
// *InputConfig_GcsSource
Source isInputConfig_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}
func (*InputConfig) Descriptor() ([]byte, []int)
Deprecated: Use InputConfig.ProtoReflect.Descriptor instead.
func (x *InputConfig) GetGcsSource() *GcsSource
func (x *InputConfig) GetMimeType() string
func (m *InputConfig) GetSource() isInputConfig_Source
func (*InputConfig) ProtoMessage()
func (x *InputConfig) ProtoReflect() protoreflect.Message
func (x *InputConfig) Reset()
func (x *InputConfig) String() string
type InputConfig_GcsSource struct {
// 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.
GcsSource *GcsSource `protobuf:"bytes,2,opt,name=gcs_source,json=gcsSource,proto3,oneof"`
}
Request message for ListGlossaries.
type ListGlossariesRequest struct {
// Required. The name of the project from which to list all of the glossaries.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Requested page size. The server may return fewer glossaries than
// requested. If unspecified, the server picks an appropriate default.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A token identifying a page of results the server should return.
// Typically, this is the value of [ListGlossariesResponse.next_page_token]
// returned from the previous call to `ListGlossaries` method.
// The first page is returned if `page_token`is empty or missing.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter specifying constraints of a list operation.
// Specify the constraint by the format of "key=value", where key must be
// "src" or "tgt", and the value must be a valid language code.
// For multiple restrictions, concatenate them by "AND" (uppercase only),
// such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used
// here, which means using 'en-US' and 'en' can lead to different results,
// which depends on the language code you used when you create the glossary.
// For the unidirectional glossaries, the "src" and "tgt" add restrictions
// on the source and target language code separately.
// For the equivalent term set glossaries, the "src" and/or "tgt" add
// restrictions on the term set.
// For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional
// glossaries which exactly match the source language code as "en-US" and the
// target language code "zh-CN", but all equivalent term set glossaries which
// contain "en-US" and "zh-CN" in their language set will be picked.
// If missing, no filtering is performed.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListGlossariesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListGlossariesRequest.ProtoReflect.Descriptor instead.
func (x *ListGlossariesRequest) GetFilter() string
func (x *ListGlossariesRequest) GetPageSize() int32
func (x *ListGlossariesRequest) GetPageToken() string
func (x *ListGlossariesRequest) GetParent() string
func (*ListGlossariesRequest) ProtoMessage()
func (x *ListGlossariesRequest) ProtoReflect() protoreflect.Message
func (x *ListGlossariesRequest) Reset()
func (x *ListGlossariesRequest) String() string
Response message for ListGlossaries.
type ListGlossariesResponse struct {
// The list of glossaries for a project.
Glossaries []*Glossary `protobuf:"bytes,1,rep,name=glossaries,proto3" json:"glossaries,omitempty"`
// A token to retrieve a page of results. Pass this value in the
// [ListGlossariesRequest.page_token] field in the subsequent call to
// `ListGlossaries` method to retrieve the next page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListGlossariesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListGlossariesResponse.ProtoReflect.Descriptor instead.
func (x *ListGlossariesResponse) GetGlossaries() []*Glossary
func (x *ListGlossariesResponse) GetNextPageToken() string
func (*ListGlossariesResponse) ProtoMessage()
func (x *ListGlossariesResponse) ProtoReflect() protoreflect.Message
func (x *ListGlossariesResponse) Reset()
func (x *ListGlossariesResponse) String() string
Output configuration for BatchTranslateText request.
type OutputConfig struct {
// Required. The destination of output.
//
// Types that are assignable to Destination:
//
// *OutputConfig_GcsDestination
Destination isOutputConfig_Destination `protobuf_oneof:"destination"`
// contains filtered or unexported fields
}
func (*OutputConfig) Descriptor() ([]byte, []int)
Deprecated: Use OutputConfig.ProtoReflect.Descriptor instead.
func (m *OutputConfig) GetDestination() isOutputConfig_Destination
func (x *OutputConfig) GetGcsDestination() *GcsDestination
func (*OutputConfig) ProtoMessage()
func (x *OutputConfig) ProtoReflect() protoreflect.Message
func (x *OutputConfig) Reset()
func (x *OutputConfig) String() string
type OutputConfig_GcsDestination struct {
// 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]
GcsDestination *GcsDestination `protobuf:"bytes,1,opt,name=gcs_destination,json=gcsDestination,proto3,oneof"`
}
A single supported language response corresponds to information related to one supported language.
type SupportedLanguage struct {
// 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')
LanguageCode string `protobuf:"bytes,1,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// Human readable name of the language localized in the display language
// specified in the request.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Can be used as source language.
SupportSource bool `protobuf:"varint,3,opt,name=support_source,json=supportSource,proto3" json:"support_source,omitempty"`
// Can be used as target language.
SupportTarget bool `protobuf:"varint,4,opt,name=support_target,json=supportTarget,proto3" json:"support_target,omitempty"`
// contains filtered or unexported fields
}
func (*SupportedLanguage) Descriptor() ([]byte, []int)
Deprecated: Use SupportedLanguage.ProtoReflect.Descriptor instead.
func (x *SupportedLanguage) GetDisplayName() string
func (x *SupportedLanguage) GetLanguageCode() string
func (x *SupportedLanguage) GetSupportSource() bool
func (x *SupportedLanguage) GetSupportTarget() bool
func (*SupportedLanguage) ProtoMessage()
func (x *SupportedLanguage) ProtoReflect() protoreflect.Message
func (x *SupportedLanguage) Reset()
func (x *SupportedLanguage) String() string
The response message for discovering supported languages.
type SupportedLanguages struct {
// A list of supported language responses. This list contains an entry
// for each language the Translation API supports.
Languages []*SupportedLanguage `protobuf:"bytes,1,rep,name=languages,proto3" json:"languages,omitempty"`
// contains filtered or unexported fields
}
func (*SupportedLanguages) Descriptor() ([]byte, []int)
Deprecated: Use SupportedLanguages.ProtoReflect.Descriptor instead.
func (x *SupportedLanguages) GetLanguages() []*SupportedLanguage
func (*SupportedLanguages) ProtoMessage()
func (x *SupportedLanguages) ProtoReflect() protoreflect.Message
func (x *SupportedLanguages) Reset()
func (x *SupportedLanguages) String() string
A document translation request.
type TranslateDocumentRequest struct {
// 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.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// 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.
SourceLanguageCode string `protobuf:"bytes,2,opt,name=source_language_code,json=sourceLanguageCode,proto3" json:"source_language_code,omitempty"`
// 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.
TargetLanguageCode string `protobuf:"bytes,3,opt,name=target_language_code,json=targetLanguageCode,proto3" json:"target_language_code,omitempty"`
// Required. Input configurations.
DocumentInputConfig *DocumentInputConfig `protobuf:"bytes,4,opt,name=document_input_config,json=documentInputConfig,proto3" json:"document_input_config,omitempty"`
// 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.
DocumentOutputConfig *DocumentOutputConfig `protobuf:"bytes,5,opt,name=document_output_config,json=documentOutputConfig,proto3" json:"document_output_config,omitempty"`
// 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.
Model string `protobuf:"bytes,6,opt,name=model,proto3" json:"model,omitempty"`
// 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.
GlossaryConfig *TranslateTextGlossaryConfig `protobuf:"bytes,7,opt,name=glossary_config,json=glossaryConfig,proto3" json:"glossary_config,omitempty"`
// 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.
Labels map[string]string `protobuf:"bytes,8,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*TranslateDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use TranslateDocumentRequest.ProtoReflect.Descriptor instead.
func (x *TranslateDocumentRequest) GetDocumentInputConfig() *DocumentInputConfig
func (x *TranslateDocumentRequest) GetDocumentOutputConfig() *DocumentOutputConfig
func (x *TranslateDocumentRequest) GetGlossaryConfig() *TranslateTextGlossaryConfig
func (x *TranslateDocumentRequest) GetLabels() map[string]string
func (x *TranslateDocumentRequest) GetModel() string
func (x *TranslateDocumentRequest) GetParent() string
func (x *TranslateDocumentRequest) GetSourceLanguageCode() string
func (x *TranslateDocumentRequest) GetTargetLanguageCode() string
func (*TranslateDocumentRequest) ProtoMessage()
func (x *TranslateDocumentRequest) ProtoReflect() protoreflect.Message
func (x *TranslateDocumentRequest) Reset()
func (x *TranslateDocumentRequest) String() string
A translated document response message.
type TranslateDocumentResponse struct {
// Translated document.
DocumentTranslation *DocumentTranslation `protobuf:"bytes,1,opt,name=document_translation,json=documentTranslation,proto3" json:"document_translation,omitempty"`
// 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.
GlossaryDocumentTranslation *DocumentTranslation `protobuf:"bytes,2,opt,name=glossary_document_translation,json=glossaryDocumentTranslation,proto3" json:"glossary_document_translation,omitempty"`
// 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`.
Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
// The `glossary_config` used for this translation.
GlossaryConfig *TranslateTextGlossaryConfig `protobuf:"bytes,4,opt,name=glossary_config,json=glossaryConfig,proto3" json:"glossary_config,omitempty"`
// contains filtered or unexported fields
}
func (*TranslateDocumentResponse) Descriptor() ([]byte, []int)
Deprecated: Use TranslateDocumentResponse.ProtoReflect.Descriptor instead.
func (x *TranslateDocumentResponse) GetDocumentTranslation() *DocumentTranslation
func (x *TranslateDocumentResponse) GetGlossaryConfig() *TranslateTextGlossaryConfig
func (x *TranslateDocumentResponse) GetGlossaryDocumentTranslation() *DocumentTranslation
func (x *TranslateDocumentResponse) GetModel() string
func (*TranslateDocumentResponse) ProtoMessage()
func (x *TranslateDocumentResponse) ProtoReflect() protoreflect.Message
func (x *TranslateDocumentResponse) Reset()
func (x *TranslateDocumentResponse) String() string
Configures which glossary should be used for a specific target language, and defines options for applying that glossary.
type TranslateTextGlossaryConfig struct {
// Required. Specifies the glossary used for this translation. Use
// this format: projects/*/locations/*/glossaries/*
Glossary string `protobuf:"bytes,1,opt,name=glossary,proto3" json:"glossary,omitempty"`
// Optional. Indicates match is case-insensitive.
// Default value is false if missing.
IgnoreCase bool `protobuf:"varint,2,opt,name=ignore_case,json=ignoreCase,proto3" json:"ignore_case,omitempty"`
// contains filtered or unexported fields
}
func (*TranslateTextGlossaryConfig) Descriptor() ([]byte, []int)
Deprecated: Use TranslateTextGlossaryConfig.ProtoReflect.Descriptor instead.
func (x *TranslateTextGlossaryConfig) GetGlossary() string
func (x *TranslateTextGlossaryConfig) GetIgnoreCase() bool
func (*TranslateTextGlossaryConfig) ProtoMessage()
func (x *TranslateTextGlossaryConfig) ProtoReflect() protoreflect.Message
func (x *TranslateTextGlossaryConfig) Reset()
func (x *TranslateTextGlossaryConfig) String() string
The request message for synchronous translation.
type TranslateTextRequest struct {
// 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.
Contents []string `protobuf:"bytes,1,rep,name=contents,proto3" json:"contents,omitempty"`
// Optional. The format of the source text, for example, "text/html",
//
// "text/plain". If left blank, the MIME type defaults to "text/html".
MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
// 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.
SourceLanguageCode string `protobuf:"bytes,4,opt,name=source_language_code,json=sourceLanguageCode,proto3" json:"source_language_code,omitempty"`
// 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.
TargetLanguageCode string `protobuf:"bytes,5,opt,name=target_language_code,json=targetLanguageCode,proto3" json:"target_language_code,omitempty"`
// 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.
Parent string `protobuf:"bytes,8,opt,name=parent,proto3" json:"parent,omitempty"`
// 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
Model string `protobuf:"bytes,6,opt,name=model,proto3" json:"model,omitempty"`
// 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.
GlossaryConfig *TranslateTextGlossaryConfig `protobuf:"bytes,7,opt,name=glossary_config,json=glossaryConfig,proto3" json:"glossary_config,omitempty"`
// 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.
Labels map[string]string `protobuf:"bytes,10,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*TranslateTextRequest) Descriptor() ([]byte, []int)
Deprecated: Use TranslateTextRequest.ProtoReflect.Descriptor instead.
func (x *TranslateTextRequest) GetContents() []string
func (x *TranslateTextRequest) GetGlossaryConfig() *TranslateTextGlossaryConfig
func (x *TranslateTextRequest) GetLabels() map[string]string
func (x *TranslateTextRequest) GetMimeType() string
func (x *TranslateTextRequest) GetModel() string
func (x *TranslateTextRequest) GetParent() string
func (x *TranslateTextRequest) GetSourceLanguageCode() string
func (x *TranslateTextRequest) GetTargetLanguageCode() string
func (*TranslateTextRequest) ProtoMessage()
func (x *TranslateTextRequest) ProtoReflect() protoreflect.Message
func (x *TranslateTextRequest) Reset()
func (x *TranslateTextRequest) String() string
type TranslateTextResponse struct {
// Text translation responses with no glossary applied.
// This field has the same length as
// [`contents`][google.cloud.translation.v3beta1.TranslateTextRequest.contents].
Translations []*Translation `protobuf:"bytes,1,rep,name=translations,proto3" json:"translations,omitempty"`
// 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].
GlossaryTranslations []*Translation `protobuf:"bytes,3,rep,name=glossary_translations,json=glossaryTranslations,proto3" json:"glossary_translations,omitempty"`
// contains filtered or unexported fields
}
func (*TranslateTextResponse) Descriptor() ([]byte, []int)
Deprecated: Use TranslateTextResponse.ProtoReflect.Descriptor instead.
func (x *TranslateTextResponse) GetGlossaryTranslations() []*Translation
func (x *TranslateTextResponse) GetTranslations() []*Translation
func (*TranslateTextResponse) ProtoMessage()
func (x *TranslateTextResponse) ProtoReflect() protoreflect.Message
func (x *TranslateTextResponse) Reset()
func (x *TranslateTextResponse) String() string
A single translation response.
type Translation struct {
// Text translated into the target language.
// If an error occurs during translation, this field might be excluded from
// the response.
TranslatedText string `protobuf:"bytes,1,opt,name=translated_text,json=translatedText,proto3" json:"translated_text,omitempty"`
// 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`.
Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"`
// 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.
DetectedLanguageCode string `protobuf:"bytes,4,opt,name=detected_language_code,json=detectedLanguageCode,proto3" json:"detected_language_code,omitempty"`
// The `glossary_config` used for this translation.
GlossaryConfig *TranslateTextGlossaryConfig `protobuf:"bytes,3,opt,name=glossary_config,json=glossaryConfig,proto3" json:"glossary_config,omitempty"`
// contains filtered or unexported fields
}
func (*Translation) Descriptor() ([]byte, []int)
Deprecated: Use Translation.ProtoReflect.Descriptor instead.
func (x *Translation) GetDetectedLanguageCode() string
func (x *Translation) GetGlossaryConfig() *TranslateTextGlossaryConfig
func (x *Translation) GetModel() string
func (x *Translation) GetTranslatedText() string
func (*Translation) ProtoMessage()
func (x *Translation) ProtoReflect() protoreflect.Message
func (x *Translation) Reset()
func (x *Translation) String() string
TranslationServiceClient is the client API for TranslationService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type TranslationServiceClient interface {
// Translates input text and returns translated text.
TranslateText(ctx context.Context, in *TranslateTextRequest, opts ...grpc.CallOption) (*TranslateTextResponse, error)
// Detects the language of text within a request.
DetectLanguage(ctx context.Context, in *DetectLanguageRequest, opts ...grpc.CallOption) (*DetectLanguageResponse, error)
// Returns a list of supported languages for translation.
GetSupportedLanguages(ctx context.Context, in *GetSupportedLanguagesRequest, opts ...grpc.CallOption) (*SupportedLanguages, error)
// Translates documents in synchronous mode.
TranslateDocument(ctx context.Context, in *TranslateDocumentRequest, opts ...grpc.CallOption) (*TranslateDocumentResponse, error)
// Translates a large volume of text in asynchronous batch mode.
// This function provides real-time output as the inputs are being processed.
// If caller cancels a request, the partial results (for an input file, it's
// all or nothing) may still be available on the specified output location.
//
// This call returns immediately and you can
// use google.longrunning.Operation.name to poll the status of the call.
BatchTranslateText(ctx context.Context, in *BatchTranslateTextRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Translates a large volume of documents in asynchronous batch mode.
// This function provides real-time output as the inputs are being processed.
// If caller cancels a request, the partial results (for an input file, it's
// all or nothing) may still be available on the specified output location.
//
// This call returns immediately and you can use
// google.longrunning.Operation.name to poll the status of the call.
BatchTranslateDocument(ctx context.Context, in *BatchTranslateDocumentRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Creates a glossary and returns the long-running operation. Returns
// NOT_FOUND, if the project doesn't exist.
CreateGlossary(ctx context.Context, in *CreateGlossaryRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
// Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't
// exist.
ListGlossaries(ctx context.Context, in *ListGlossariesRequest, opts ...grpc.CallOption) (*ListGlossariesResponse, error)
// Gets a glossary. Returns NOT_FOUND, if the glossary doesn't
// exist.
GetGlossary(ctx context.Context, in *GetGlossaryRequest, opts ...grpc.CallOption) (*Glossary, error)
// Deletes a glossary, or cancels glossary construction
// if the glossary isn't created yet.
// Returns NOT_FOUND, if the glossary doesn't exist.
DeleteGlossary(ctx context.Context, in *DeleteGlossaryRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}
func NewTranslationServiceClient(cc grpc.ClientConnInterface) TranslationServiceClient
TranslationServiceServer is the server API for TranslationService service.
type TranslationServiceServer interface {
// Translates input text and returns translated text.
TranslateText(context.Context, *TranslateTextRequest) (*TranslateTextResponse, error)
// Detects the language of text within a request.
DetectLanguage(context.Context, *DetectLanguageRequest) (*DetectLanguageResponse, error)
// Returns a list of supported languages for translation.
GetSupportedLanguages(context.Context, *GetSupportedLanguagesRequest) (*SupportedLanguages, error)
// Translates documents in synchronous mode.
TranslateDocument(context.Context, *TranslateDocumentRequest) (*TranslateDocumentResponse, error)
// Translates a large volume of text in asynchronous batch mode.
// This function provides real-time output as the inputs are being processed.
// If caller cancels a request, the partial results (for an input file, it's
// all or nothing) may still be available on the specified output location.
//
// This call returns immediately and you can
// use google.longrunning.Operation.name to poll the status of the call.
BatchTranslateText(context.Context, *BatchTranslateTextRequest) (*longrunning.Operation, error)
// Translates a large volume of documents in asynchronous batch mode.
// This function provides real-time output as the inputs are being processed.
// If caller cancels a request, the partial results (for an input file, it's
// all or nothing) may still be available on the specified output location.
//
// This call returns immediately and you can use
// google.longrunning.Operation.name to poll the status of the call.
BatchTranslateDocument(context.Context, *BatchTranslateDocumentRequest) (*longrunning.Operation, error)
// Creates a glossary and returns the long-running operation. Returns
// NOT_FOUND, if the project doesn't exist.
CreateGlossary(context.Context, *CreateGlossaryRequest) (*longrunning.Operation, error)
// Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't
// exist.
ListGlossaries(context.Context, *ListGlossariesRequest) (*ListGlossariesResponse, error)
// Gets a glossary. Returns NOT_FOUND, if the glossary doesn't
// exist.
GetGlossary(context.Context, *GetGlossaryRequest) (*Glossary, error)
// Deletes a glossary, or cancels glossary construction
// if the glossary isn't created yet.
// Returns NOT_FOUND, if the glossary doesn't exist.
DeleteGlossary(context.Context, *DeleteGlossaryRequest) (*longrunning.Operation, error)
}
UnimplementedTranslationServiceServer can be embedded to have forward compatible implementations.
type UnimplementedTranslationServiceServer struct {
}
func (*UnimplementedTranslationServiceServer) BatchTranslateDocument(context.Context, *BatchTranslateDocumentRequest) (*longrunning.Operation, error)
func (*UnimplementedTranslationServiceServer) BatchTranslateText(context.Context, *BatchTranslateTextRequest) (*longrunning.Operation, error)
func (*UnimplementedTranslationServiceServer) CreateGlossary(context.Context, *CreateGlossaryRequest) (*longrunning.Operation, error)
func (*UnimplementedTranslationServiceServer) DeleteGlossary(context.Context, *DeleteGlossaryRequest) (*longrunning.Operation, error)
func (*UnimplementedTranslationServiceServer) DetectLanguage(context.Context, *DetectLanguageRequest) (*DetectLanguageResponse, error)
func (*UnimplementedTranslationServiceServer) GetGlossary(context.Context, *GetGlossaryRequest) (*Glossary, error)
func (*UnimplementedTranslationServiceServer) GetSupportedLanguages(context.Context, *GetSupportedLanguagesRequest) (*SupportedLanguages, error)
func (*UnimplementedTranslationServiceServer) ListGlossaries(context.Context, *ListGlossariesRequest) (*ListGlossariesResponse, error)
func (*UnimplementedTranslationServiceServer) TranslateDocument(context.Context, *TranslateDocumentRequest) (*TranslateDocumentResponse, error)
func (*UnimplementedTranslationServiceServer) TranslateText(context.Context, *TranslateTextRequest) (*TranslateTextResponse, error)