Package google.cloud.translation.v3

重要事項：如要存取圓括號內的網址，必須連上網際網路。您可以使用這個網址，在與氣隙環境不同的環境中存取。

TranslationService

提供 Natural Language 翻譯作業。

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 一律只會傳回一項結果。

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 這是必要旗標，提供範例，方便您從中建立詞彙表。詞彙表總大小不得超過 1000 萬個 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 語言代碼。所有項目均不得重複。清單至少包含兩項項目。應與 GlossaryTerm.language_code 完全相符。

GlossaryInputConfig

詞彙表的輸入設定。

欄位
s3_source	S3Source 這是必要旗標，詞彙表資料的儲存位置。檔案格式取決於副檔名。如果 URI 和檔案格式不受支援，API 會傳回 google.rpc.Code.INVALID_ARGUMENT。不允許使用萬用字元。必須是單一檔案，且格式為下列其中一種： 單向詞彙表： TSV/CSV (.tsv/.csv)：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」格式指定限制，其中鍵必須為「src」或「tgt」，值則必須是有效的語言代碼。如有多項限制，請以「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] 欄位，即可擷取下一頁結果。

SupportedLanguage

單一支援語言回應對應於與某一支援語言相關的資訊。

欄位
language_code	string 支援的語言代碼，通常由 ISO 639-1 識別碼組成，例如「en」、「ja」。在某些情況下，系統會傳回包含語言和地區 ID 的 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 這是必要旗標，字串格式的輸入內容。建議總內容少於 3 萬個碼位。這個欄位的長度上限為 1024 個半形字元。如要翻譯大量文字，請使用 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。