Method: projects.locations.translateDocument

ドキュメントを同期モードで翻訳します。

HTTP リクエスト

POST https://{TRANSLATION_GDC_ENDPOINT}/v3/{parent}:translateDocument

パスパラメータ

パラメータ
parent

string

必須。リージョン呼び出しを行う場所。

形式: projects/{project-number-or-id}/locations/{location-id}。

グローバル呼び出しには、projects/{project-number-or-id}/locations/global または projects/{project-number-or-id} を使用します。

AutoML モデルまたはカスタム用語集を使用するリクエストには、非グローバル ロケーションが必要です。

モデルと用語集は同じリージョン（同じ location-id）に存在する必要があります。そうでない場合は、INVALID_ARGUMENT（400）エラーが返されます。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "sourceLanguageCode": string,
  "targetLanguageCode": string,
  "documentInputConfig": {
    object (DocumentInputConfig)
  },
  "glossaryConfig": {
    object (TranslateTextGlossaryConfig)
  }
}
フィールド
sourceLanguageCode

string

省略可。入力ドキュメントの ISO-639 言語コード（わかっている場合）。例: 「en-US」、「sr-Latn」。サポートされている言語コードは、言語サポートに記載されています。ソース言語が指定されていない場合、API はソース言語を自動的に特定しようとし、レスポンス内でソース言語を返します。リクエストに用語集またはカスタムモデルが含まれている場合は、ソース言語を指定する必要があります。
targetLanguageCode

string

必須。入力ドキュメントの翻訳に使用する ISO-639 言語コード。言語サポートに記載されている言語コードのいずれかに設定します。
documentInputConfig

object (DocumentInputConfig)

必須。入力構成。
glossaryConfig

object (TranslateTextGlossaryConfig)

省略可。適用する用語集。用語集はモデルと同じリージョン（同じ location-id）に存在する必要があります。そうでない場合は、INVALID_ARGUMENT（400）エラーが返されます。

認可には、指定されたリソース glossaryConfig に対する次の IAM の権限が必要です。

  • cloudtranslate.glossaries.docPredict

レスポンスの本文

翻訳されたドキュメントのレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "documentTranslation": {
    object (DocumentTranslation)
  },
  "glossaryDocumentTranslation": {
    object (DocumentTranslation)
  },
  "glossaryConfig": {
    object (TranslateTextGlossaryConfig)
  }
}
フィールド
documentTranslation

object (DocumentTranslation)

翻訳されたドキュメント。
glossaryDocumentTranslation

object (DocumentTranslation)

リクエストで用語集が指定されている場合、ドキュメントの翻訳出力。用語集の用語が適用されない場合は、[TranslateDocumentResponse.document_translation] と同じになります。
glossaryConfig

object (TranslateTextGlossaryConfig)

この翻訳に使用された glossaryConfig。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-translation
  • https://www.googleapis.com/auth/cloud-platform

DocumentInputConfig

ドキュメント翻訳リクエストの入力構成。

JSON 表現 
{
  "mimeType": string,
  "content": string,
  "S3Source": {
    object (S3Source)
  }
}
フィールド
mimeType

string

入力ドキュメントの mimeType を指定します。

指定しない場合は、S3Source で指定されたファイルの拡張子を使用して決定されます。バイト コンテンツで提供されるファイルの場合、mimeType を指定する必要があります。

現在サポートされている MIME タイプは次のとおりです。

  • application/pdf
  • application/msword
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.ms-powerpoint
  • application/vnd.openxmlformats-officedocument.presentationml.presentation
  • application/vnd.ms-excel
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

サポートされているファイル形式は

  • PDF
  • DOC
  • DOCX
  • PPT
  • PPTX
  • XLS
  • XLSX
content

string (bytes format)

バイト ストリームとして表されるドキュメントのコンテンツ。

Base64 でエンコードされた文字列。
S3Source

object (S3Source)

入力コンテンツの保存場所。

DocumentTranslation

翻訳されたドキュメント メッセージ。

JSON 表現 
{
  "byteStreamOutputs": [
    string
  ],
  "mimeType": string,
  "detectedLanguageCode": string
}
フィールド
byteStreamOutputs[]

string (bytes format)

変換されたドキュメントの配列。現時点ではサイズ 1 になることが想定されています。今後、他の種類のファイル形式についても複数の翻訳ドキュメントが作成される可能性があります。

Base64 でエンコードされた文字列。
mimeType

string

翻訳されたドキュメントの MIME タイプ。
detectedLanguageCode

string

入力ドキュメントで検出された言語。ユーザーが入力ドキュメントのソース言語を指定しなかった場合、このフィールドには自動的に検出された言語コードが設定されます。ソース言語が渡された場合、言語の自動検出は行われず、このフィールドは空になります。