Package google.cloud.translation.v3

重要: 丸かっこ内の URL にアクセスするには、インターネットに接続する必要があります。この URL は、エアギャップ環境外からアクセスするために提供されます。

TranslationService

自然言語の翻訳オペレーションを提供します。

TranslateDocument
rpc TranslateDocument(TranslateDocumentRequest) returns (TranslateDocumentResponse) ドキュメントを同期モードで翻訳します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-translation https://www.googleapis.com/auth/cloud-platform

TranslateDocumentRequest

ドキュメント翻訳リクエスト。

フィールド
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）エラーが返されます。
source_language_code	string 省略可。入力ドキュメントの ISO-639 言語コード（わかっている場合）。例: 「en-US」、「sr-Latn」。サポートされている言語コードは、言語サポートに記載されています。ソース言語が指定されていない場合、API はソース言語を自動的に特定しようとし、レスポンス内でソース言語を返します。リクエストに用語集またはカスタムモデルが含まれている場合は、ソース言語を指定する必要があります。
target_language_code	string 必須。入力ドキュメントの翻訳に使用する ISO-639 言語コード。言語サポートに記載されている言語コードのいずれかに設定します。
document_input_config	DocumentInputConfig 必須。入力構成。
glossary_config	TranslateTextGlossaryConfig 省略可。適用する用語集。用語集はモデルと同じリージョン（同じ location-id）に存在する必要があります。そうでない場合は、INVALID_ARGUMENT（400）エラーが返されます。 認可には、指定されたリソース glossaryConfig に対する次の IAM の権限が必要です。 cloudtranslate.glossaries.docPredict

TranslateDocumentResponse

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

フィールド
document_translation	DocumentTranslation 翻訳されたドキュメント。
glossary_document_translation	DocumentTranslation リクエストで用語集が指定されている場合、ドキュメントの翻訳出力。用語集の用語が適用されない場合は、[TranslateDocumentResponse.document_translation] と同じになります。
glossary_config	TranslateTextGlossaryConfig この翻訳に使用された glossary_config。

CreateGlossary
rpc CreateGlossary(CreateGlossaryRequest) returns (Operation) 用語集を作成し、長時間実行オペレーションを返します。プロジェクトが存在しない場合は NOT_FOUND を返します。

DeleteGlossary
rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation) 用語集が作成されていない場合は、用語集を削除します。用語集が存在しない場合は NOT_FOUND を返します。

DetectLanguage
rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse) リクエストの中でテキストの言語を検出します。

GetGlossary
rpc GetGlossary(GetGlossaryRequest) returns (Glossary) 用語集を取得します。用語集が存在しない場合は NOT_FOUND を返します。

GetSupportedLanguages
rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages) サポートされている翻訳言語のリストを返します。

ListGlossaries
rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse) プロジェクト内の用語集を一覧表示します。プロジェクトが存在しない場合は NOT_FOUND を返します。

TranslateText
rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse) 入力テキストを翻訳し、翻訳されたテキストを返します。

CreateGlossaryMetadata

CreateGlossary によって返される google.longrunning.Operation.metadata フィールドに保存されます。

フィールド
name	string 作成される用語集の名前。
state	State 用語集の作成オペレーションの現在の状態。
submit_time	Timestamp オペレーションがサーバーに送信された時刻。

状態

作成リクエストの状態は、次のいずれかになります。

列挙型
STATE_UNSPECIFIED	無効。
RUNNING	リクエストを処理中です。
SUCCEEDED	用語集が正常に作成されました。
FAILED	用語集を作成できませんでした。

CreateGlossaryRequest

CreateGlossary に対するリクエスト メッセージ。

フィールド
parent	string 必須。プロジェクト名。
glossary	Glossary 必須。作成する用語集。

DeleteGlossaryMetadata

DeleteGlossary から返される google.longrunning.Operation.metadata フィールドに保存されます。

フィールド
name	string 削除される用語集の名前。
state	State 用語集削除オペレーションの現在の状態。
submit_time	Timestamp オペレーションがサーバーに送信された時刻。

状態

作成リクエストの状態は、次のいずれかになります。

列挙型
STATE_UNSPECIFIED	無効。
RUNNING	リクエストを処理中です。
SUCCEEDED	用語集が正常に削除されました。
FAILED	用語集を削除できませんでした。

DeleteGlossaryRequest

DeleteGlossary に対するリクエスト メッセージ。

フィールド
name	string 必須。削除する用語集の名前。

DeleteGlossaryResponse

DeleteGlossary から返される google.longrunning.Operation.response フィールドに保存されます。

フィールド
name	string 削除された用語集の名前。
submit_time	Timestamp オペレーションがサーバーに送信された時刻。
end_time	Timestamp 用語集の削除が完了し、google.longrunning.Operation.done が true に設定された時刻。

DetectLanguageRequest

言語検出に対するリクエスト メッセージ。

フィールド
parent	string 必須。呼び出しを行うプロジェクト。呼び出し元のプロジェクトを参照する必要があります。 形式: projects/{project-id}.
mime_type	string 省略可。ソーステキストの形式（「text/html」、「text/plain」など）。空白のままにすると、MIME タイプはデフォルトで「text/html」になります。
content	string 入力コンテンツ（文字列として保存）。

DetectLanguageResponse

言語検出に対するレスポンス メッセージ。

フィールド
languages[]	DetectedLanguage Translation API によって検出された最も可能性の高い言語。Translation API は、リクエストごとに常に 1 つの結果のみを返します。

DetectedLanguage

言語検出に対するレスポンス メッセージ。

フィールド
language_code	string リクエスト内のソース コンテンツの BCP-47 言語コード。自動的に検出されます。
confidence	float この言語の検出結果の信頼度。

S3Source

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

フィールド
input_uri	string 必須。ソースデータ URI。例: s3://my_bucket/my_object

GetGlossaryRequest

GetGlossary のリクエスト メッセージ。

フィールド
name	string 必須。取得する用語集の名前。

GetSupportedLanguagesRequest

サポートされている言語を確認するためのリクエスト メッセージ。

フィールド
parent	string 必須。呼び出しを行うプロジェクト。呼び出し元のプロジェクトを参照する必要があります。 形式: projects/{project-id}。
display_language_code	string 省略可。サポートされている言語のローカライズされた人間が読める形式の名前を返すために使用する言語。指定しない場合、表示名はレスポンスで返されません。

用語集

ユーザーが提供したデータから構築された用語集を表します。

フィールド
name	string 必須。用語集のリソース名。用語集名の形式は projects/{project-id}/glossaries/{glossary-id} です。
input_config	GlossaryInputConfig 必須。用語集の作成に使用できる例を提供します。用語集の合計は 1,000 万 Unicode コードポイントを超えてはなりません。
entry_count	int32 出力専用。用語集で定義されたエントリの数。
submit_time	Timestamp 出力専用。CreateGlossary が呼び出された日時。
end_time	Timestamp 出力専用。用語集の作成が完了した日時。
display_name	string 省略可。用語集の表示名。
共用体フィールド languages。用語集でサポートされている言語。languages は次のいずれかになります。
language_pair	LanguageCodePair 単一言語ペアの用語集で使用されます。
language_codes_set	LanguageCodesSet 多言語用語セットの用語集で使用されます。

LanguageCodePair

単一言語ペアの用語集で使用されます。

フィールド
source_language_code	string 必須。入力テキストの BCP-47 言語コード（例: 「en-US」）。GlossaryTerm.language_code と完全に一致することが想定されます。
target_language_code	string 必須。翻訳出力の BCP-47 言語コード（「zh-CN」など）。GlossaryTerm.language_code と完全に一致することが想定されます。

LanguageCodesSet

多言語用語セットの用語集で使用されます。

フィールド
language_codes[]	string 用語集で定義されている用語の BCP-47 言語コード。すべてのエントリは一意です。リストに少なくとも 2 つのエントリが含まれている。GlossaryTerm.language_code と完全に一致することが想定されます。

GlossaryInputConfig

用語集の入力構成。

フィールド

s3_source

S3Source 必須。用語集データの保存場所。ファイル形式はファイル名の拡張子に基づいて決定されます。API は、サポートされていない URI とファイル形式に対して google.rpc.Code.INVALID_ARGUMENT を返します。ワイルドカードは使用できません。これは、次のいずれかの形式の単一ファイルである必要があります。 単一言語ペアの用語集の場合: TSV/CSV（.tsv/.csv）: 2 列のファイル。タブまたはカンマで区切ります。最初の列はソーステキストです。2 列目はターゲット テキストです。ファイルにヘッダーを含めることはできません。つまり、最初の行は列名ではなくデータです。 TMX（.tmx）: 原文と訳文の用語ペアを定義する並列データを含む TMX ファイル。 多言語用語セットの用語集の場合: CSV（.csv）: 複数言語で同等の用語を定義する複数列の CSV ファイル。詳細については、用語集をご覧ください。

ListGlossariesRequest

ListGlossaries に対するリクエスト メッセージ。

フィールド
parent	string 必須。すべての用語集を一覧表示するプロジェクトの名前。
page_size	int32 省略可。リクエストされたページサイズ。サーバーは、リクエストされた数よりも少ない用語集を返すことがあります。このパラメータを指定しないと、サーバーは適切なデフォルト値を選択します。
page_token	string 省略可。サーバーが返す必要がある結果のページを特定するトークン。通常、これは ListGlossaries メソッドの前の呼び出しから返された [ListGlossariesResponse.next_page_token] の値です。page_token が空または欠落している場合は、最初のページが返されます。
filter	string 省略可。リスト オペレーションの制約を指定するフィルタ。制約は「key=value」の形式で指定します。ここで、key は「src」または「tgt」にする必要があり、value は有効な言語コードにする必要があります。複数の制限を指定する場合は、「AND」（大文字のみ）で連結します（例: 「src=en-US AND tgt=zh-CN」）。ここでは完全一致が使用されているため、'en-US' と 'en' を使用すると、用語集の作成時に使用した言語コードに応じて異なる結果になることがあります。単一言語ペアの用語集の場合、「src」と「tgt」は、ソース言語コードとターゲット言語コードに個別に制限を追加します。多言語の用語セットの用語集では、「src」または「tgt」によって用語セットに制限が追加されます。たとえば、「src=en-US AND tgt=zh-CN」と指定すると、ソース言語コードが「en-US」でターゲット言語コードが「zh-CN」と完全に一致する単方向の用語集のみが選択されますが、言語セットに「en-US」と「zh-CN」を含む多言語の用語セットの用語集はすべて選択されます。指定されていない場合、フィルタリングは行われません。

ListGlossariesResponse

ListGlossaries に対するレスポンス メッセージ。

フィールド
glossaries[]	Glossary プロジェクトの用語集のリスト。
next_page_token	string 結果のページを取得するためのトークン。この値を次の ListGlossaries メソッド呼び出しの [ListGlossariesRequest.page_token] フィールドで渡して、結果の次ページを取得します。

サポートされている言語

1 つのサポートされる言語のレスポンスは、1 つのサポートされる言語に関連する情報に対応します。

フィールド
language_code	string サポートされている言語コード。通常は ISO 639-1 識別子で構成されます（例: 「en」、「ja」）。言語と地域識別子を含む BCP-47 コードが返される場合もあります（例: 「zh-TW」、「zh-CN」）。
display_name	string リクエストで指定された表示言語にローカライズされた言語の、人が読める形式の名前。
support_source	bool 原文の言語として使用できます。
support_target	bool ターゲット言語として使用できます。

SupportedLanguages

サポートされている言語を確認するためのレスポンス メッセージ。

フィールド
languages[]	SupportedLanguage サポートされている言語のレスポンスのリスト。このリストには、Translation API がサポートする言語ごとにエントリが含まれています。

TranslateTextGlossaryConfig

特定のターゲット言語に使用する用語集を構成し、その用語集を適用するためのオプションを定義します。

フィールド
glossary	string 必須。この変換に適用する glossary。 形式は用語集によって異なります。 ユーザーがカスタム用語集を提供した場合: projects/{project-id}/glossaries/{glossary-id}
ignore_case	bool 省略可。照合で大文字と小文字が区別されないことを示します。省略した場合のデフォルト値は false です。

TranslateTextRequest

同期翻訳のリクエスト メッセージ。

フィールド
contents[]	string 必須。入力コンテンツ（文字列形式）。コンテンツの合計は 30k コードポイント未満にすることをおすすめします。このフィールドの最大長は 1,024 です。大きなテキストには BatchTranslateText を使用します。
mime_type	string 省略可。ソーステキストの形式（「text/html」、「text/plain」など）。空白のままにすると、MIME タイプはデフォルトで「text/html」になります。
source_language_code	string 入力テキストの BCP-47 言語コード（判明している場合）。例: en-US、sr-Latn。サポートされている言語コードは、言語サポートに記載されています。
target_language_code	string 必須。入力テキストの翻訳に使用する BCP-47 言語コード。言語サポートに記載されている言語コードのいずれかに設定します。
parent	string 必須。呼び出しを行うプロジェクト。呼び出し元のプロジェクトを参照する必要があります。 形式: projects/{project-id}
glossary_config	TranslateTextGlossaryConfig 省略可。適用する用語集。

TranslateTextResponse

フィールド
translations[]	Translation 用語集が適用されていないテキスト翻訳レスポンス。このフィールドの長さは contents と同じです。
glossary_translations[]	Translation リクエストで用語集が指定されている場合のテキスト翻訳レスポンス。条件が適用されない場合は、translations と同じでかまいません。このフィールドの長さは contents と同じです。

翻訳

単一の翻訳レスポンス。

フィールド
translated_text	string ターゲット言語に翻訳されたテキスト。変換中にエラーが発生した場合、このフィールドがレスポンスから除外されることがあります。
detected_language_code	string ソース言語が渡された場合、言語の自動検出は行われず、このフィールドは空になります。
glossary_config	TranslateTextGlossaryConfig この翻訳に使用された glossary_config。