GoogleApi.Translate.V3.Model.TranslateDocumentRequest (google_api_translate v0.13.0) View Source

A document translation request.

Attributes

  • documentInputConfig (type: GoogleApi.Translate.V3.Model.DocumentInputConfig.t, default: nil) - Required. Input configurations.
  • documentOutputConfig (type: GoogleApi.Translate.V3.Model.DocumentOutputConfig.t, default: nil) - 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.
  • glossaryConfig (type: GoogleApi.Translate.V3.Model.TranslateTextGlossaryConfig.t, default: nil) - Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned.
  • labels (type: map(), default: nil) - 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.
  • model (type: String.t, default: nil) - 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.
  • sourceLanguageCode (type: String.t, default: nil) - 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.
  • targetLanguageCode (type: String.t, default: nil) - 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Translate.V3.Model.TranslateDocumentRequest{
  documentInputConfig:
    GoogleApi.Translate.V3.Model.DocumentInputConfig.t() | nil,
  documentOutputConfig:
    GoogleApi.Translate.V3.Model.DocumentOutputConfig.t() | nil,
  glossaryConfig:
    GoogleApi.Translate.V3.Model.TranslateTextGlossaryConfig.t() | nil,
  labels: map() | nil,
  model: String.t() | nil,
  sourceLanguageCode: String.t() | nil,
  targetLanguageCode: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.