Package google.cloud.translation.v3

重要提示：如需访问圆括号中列出的网址，您必须连接到互联网。该网址用于在气隙环境之外进行访问。

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 模型或自定义术语库的请求，必须指定非全局位置。 模型和词汇表必须位于同一区域（具有相同的位置 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 可选。要应用的术语表。词汇表必须与模型位于同一区域（具有相同的位置 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”格式指定限制，其中 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] 字段，以检索下一页结果。

SupportedLanguage

一个受支持语言响应对应于一种受支持语言的相关信息。

字段
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 必需。输入的内容（字符串格式）。 我们建议总内容量不超过 30,000 个码点。此字段的最大长度为 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。