Method: googleapis.translate.v3.projects.locations.translateText

Translates input text and returns translated text.

Arguments

Parameters
parent

string

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.

body

object (TranslateTextRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of TranslateTextResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- translateText:
    call: googleapis.translate.v3.projects.locations.translateText
    args:
        parent: ...
        body:
            contents: ...
            glossaryConfig:
                glossary: ...
                ignoreCase: ...
            labels: ...
            mimeType: ...
            model: ...
            sourceLanguageCode: ...
            targetLanguageCode: ...
    result: translateTextResult

JSON

[
  {
    "translateText": {
      "call": "googleapis.translate.v3.projects.locations.translateText",
      "args": {
        "parent": "...",
        "body": {
          "contents": "...",
          "glossaryConfig": {
            "glossary": "...",
            "ignoreCase": "..."
          },
          "labels": "...",
          "mimeType": "...",
          "model": "...",
          "sourceLanguageCode": "...",
          "targetLanguageCode": "..."
        }
      },
      "result": "translateTextResult"
    }
  }
]