入门：文档翻译客户端库

项目
09/09/2024

文档翻译是 Azure AI 翻译服务的一项基于云的功能，它以受支持的语言和各种文件格式异步翻译整个文档。在本快速入门中，了解如何使用文档翻译和所选编程语言将源文档翻译为目标语言，同时保留结构和文本格式。

重要

目前，只有翻译（单服务）资源中支持文档翻译，并且 Azure AI 服务（多服务）资源中未包含该功能。
付费层支持文档翻译。 Language Studio 支持 S1 或 D3 实例层。建议选择“标准 S1”以试用文档翻译。请参阅 Azure AI 服务定价 - 翻译器。
文档翻译公共预览版提供对目前正处于开发状态的功能的提前访问。在正式发布 (GA) 之前，根据用户反馈，功能、方法和流程可能会发生更改。
文档翻译客户端库的公共预览版默认使用 REST API 版本 2024-05-01。

先决条件

要开始，需要：

一个有效的 Azure 帐户。如果没有，可以创建一个试用帐户。
单服务翻译资源single-service Translator resource（而不是多服务 Azure AI 服务资源）。如果计划配合使用文档翻译功能与托管标识授权，请选择一个地理区域，例如“中国北部”。选择标准 S1 标准服务计划（即用即付）或 C2、C3、C4 或 D3 批量折扣计划。
一个 Azure Blob 存储帐户。你将在自己的 Azure Blob 存储帐户中为源和目标文件创建容器：
- 源容器。将在此容器中上传要翻译的文件（必需）。
- 目标容器。在此容器中存储已翻译的文件（必需）。

存储容器授权

可以选择以下选项之一来授权访问翻译器资源。

✔️ 托管标识。托管标识是一个服务主体，用于为 Azure 托管资源创建 Microsoft Entra 标识和特定权限。托管标识使你无需在代码中嵌入凭据即可运行翻译器应用程序。托管标识是授予存储数据访问权限的一种更安全的方式，取代了在源和目标 URL 中包含共享访问签名令牌 (SAS) 的要求。

要了解详细信息，请参阅用于文档翻译的托管标识。

托管标识流的屏幕截图 (RBAC)。

✔️ 共享访问签名 (SAS)。共享访问签名是向翻译器服务授予指定时间段内受限访问权限的 URL。若要使用此方法，需要为源容器和目标容器创建共享访问签名 (SAS) 令牌。 sourceUrl 和 targetUrl 必须包含作为查询字符串追加的共享访问签名 (SAS) 令牌。可将该令牌分配到容器或特定的 Blob。

源容器或 Blob 必须指定读取和列出访问权限。
目标容器或 Blob 必须指定写入和列出访问权限。

要了解详细信息，请参阅创建 SAS 令牌。

具有 SAS 令牌的资源 URI 的屏幕截图。

生成应用程序

有多种工具可用于创建、生成和运行翻译器 C#/.NET 应用程序。在这里，我们将指导你使用命令行接口 (CLI) 或 Visual Studio。选择以下选项卡之一以开始使用：

.NET CLI
Visual Studio

设置项目

在控制台窗口（例如 cmd、PowerShell 或 Bash）中，使用 dotnet new 命令创建名为 batch-document-translation 的新控制台应用。此命令将创建包含单个源文件的简单“Hello World”C# 项目：Program.cs。

dotnet new console -n batch-document-translation

将目录更改为新创建的应用文件夹。使用以下命令生成应用程序：

dotnet build

生成输出不应包含警告或错误。

...
Build succeeded.
 0 Warning(s)
 0 Error(s)
...

安装客户端库

在应用程序目录中，安装适用于 .NET 的文档翻译客户端库：

dotnet add package Azure.AI.Translation.Document --version 2.0.0-beta

异步翻译文档

对于此项目，你需要将源文档上传到源容器。可以为此快速入门下载文档翻译示例文档。源语言为英语。
在首选的编辑器或 IDE 中，从项目目录打开 Program.cs 文件。删除现有的代码，包括 Console.WriteLine("Hello World!") 行。
在应用程序的 Program.cs 中，为密钥和自定义终结点创建变量。有关详细信息，请参阅检索密钥和自定义域终结点。
```
private static readonly string endpoint = "<your-document-translation-endpoint>";
private static readonly string key = "<your-key>";
```
调用 StartTranslationAsync 方法，以针对单个 Blob 容器中的一个或多个文档启动翻译操作。

若要调用 StartTranslationAsync，需要初始化包含 sourceUri、targetUri 和 targetLanguageCode 参数的 DocumentTranslationInput 对象：

对于托管标识授权，请创建以下变量：

sourceUri。包含要翻译的文档的源容器的 URL。
targetUri 翻译后的文档要写入到的目标容器的 URL。

targetLanguageCode。翻译后的文档的语言代码。可以在我们的语言支持页上找到语言代码。

若要查找源和目标 URL，请导航到 Azure 门户中的存储帐户。在左侧边栏中的“数据存储”下，选择“容器”，然后按照以下步骤检索源文档和目标容器 URLS。

Source	目标
1. 选中源容器旁边的复选框	1. 选中目标容器旁边的复选框。
2.在主窗口区域中，选择要翻译的文件或文档。	2. 选择右侧的省略号，然后选择“属性”。
3. 源 URL 位于“属性”列表的顶部。	3. 目标 URL 位于“属性”列表的顶部。

对于共享访问签名 (SAS) 授权，请创建以下变量
- sourceUri。包含要翻译的文档的源容器的 SAS URI，其中追加了一个 SAS 令牌作为查询字符串。
- targetUri 要将已翻译文档写入到的目标容器的 SAS URI，其中追加了一个 SAS 令牌作为查询字符串。
- targetLanguageCode。翻译后的文档的语言代码。可以在我们的语言支持页上找到语言代码。

重要

完成后，请记住将密钥从代码中删除，并且永远不要公开发布该密钥。对于生产来说，请使用安全的方式存储和访问凭据，例如 Azure Key Vault。有关详细信息，请参阅 Azure AI 服务安全性。

异步翻译代码示例

在应用程序的 Program.cs 文件中输入以下代码示例：


using Azure;
using Azure.AI.Translation.Document;
using System;
using System.Threading;
using System.Text;

class Program {

  // create variables for your custom endpoint and resource key
  private static readonly string endpoint = "<your-document-translation-endpoint>";
  private static readonly string key = "<your-key>";

  static async Task Main(string[] args) {

    // create variables for your sourceUrl, targetUrl, and targetLanguageCode
    Uri sourceUri = new Uri("<sourceUrl>");
    Uri targetUri = new Uri("<targetUrl>");
    string targetLanguage = "<targetLanguageCode>"

    // initialize a new instance  of the DocumentTranslationClient object to interact with the Document Translation feature
    DocumentTranslationClient client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(key));

    // initialize a new instance of the `DocumentTranslationInput` object to provide the location of input for the translation operation
    DocumentTranslationInput input = new DocumentTranslationInput(sourceUri, targetUri, targetLanguage);

    // initialize a new instance of the DocumentTranslationOperation class to track the status of the translation operation
    DocumentTranslationOperation operation = await client.StartTranslationAsync(input);

    await operation.WaitForCompletionAsync();

    Console.WriteLine($"  Status: {operation.Status}");
    Console.WriteLine($"  Created on: {operation.CreatedOn}");
    Console.WriteLine($"  Last modified: {operation.LastModified}");
    Console.WriteLine($"  Total documents: {operation.DocumentsTotal}");
    Console.WriteLine($"    Succeeded: {operation.DocumentsSucceeded}");
    Console.WriteLine($"    Failed: {operation.DocumentsFailed}");
    Console.WriteLine($"    In Progress: {operation.DocumentsInProgress}");
    Console.WriteLine($"    Not started: {operation.DocumentsNotStarted}");

    await foreach(DocumentStatusResult document in operation.Value) {
      Console.WriteLine($"Document with Id: {document.Id}");
      Console.WriteLine($"  Status:{document.Status}");
      if (document.Status == DocumentTranslationStatus.Succeeded) {
        Console.WriteLine($"  Translated Document Uri: {document.TranslatedDocumentUri}");
        Console.WriteLine($"  Translated to language: {document.TranslatedToLanguageCode}.");
        Console.WriteLine($"  Document source Uri: {document.SourceDocumentUri}");
      } else {
        Console.WriteLine($"  Error Code: {document.Error.Code}");
        Console.WriteLine($"  Message: {document.Error.Message}");
      }
    }
  }
}

运行应用程序

将代码示例添加到应用程序后，通过在终端中键入以下命令，从项目目录运行该应用程序：

  dotnet run

下面是预期输出的代码段：

终端窗口中 Visual Studio Code 输出的屏幕截图。

同步翻译代码示例

可以为此快速入门下载文档翻译示例文档。源语言为英语。



using Azure;
using Azure.AI.Translation.Document;
using System;
using System.Threading;
using System.Text;

class Program {

  string endpoint = "{your-document-translation-endpoint}";
  string apiKey = "{your-api-key}";
  SingleDocumentTranslationClient client = new SingleDocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));

  try
  {
    string filePath = @"C:\{folder}\document.txt"
    using Stream fileStream = File.OpenRead(filePath);

    // MultipartFormFileData (string name, System.IO.Stream content, string contentType);
    var sourceDocument = new MultipartFormFileData(Path.GetFileName(filePath), fileStream, "application/vnd.openxmlformats-officedocument.wordprocessingml.document");

    DocumentTranslateContent content = new DocumentTranslateContent(sourceDocument);

    // DocumentTranslate (string targetLanguage, Azure.AI.Translation.Document.DocumentTranslateContent documentTranslateContent, string sourceLanguage = default, string category = default, bool? allowFallback = default, System.Threading.CancellationToken cancellationToken = default);
    var response = client.DocumentTranslate("de", content);

    Console.WriteLine($"Request string for translation: {requestString}");
    Console.WriteLine($"Response string after translation: {responseString}");
  }
    catch (RequestFailedException exception) {
    Console.WriteLine($"Error Code: {exception.ErrorCode}");
    Console.WriteLine($"Message: {exception.Message}");
  }
}

设置 C#/.NET 环境

对于本快速入门，我们将使用最新版本的 Visual Studio IDE 来生成和运行应用程序。

启动 Visual Studio。
在“开始”页面上，选择“新建项目”。
在“创建新项目”页面上，在搜索框中输入“控制台”。选择“控制台应用程序”模板，然后选择“下一步”。
在“配置新项目”对话框中，在项目名称框中输入 asynchronous-sdk。然后选择“下一步” 。
在“附加信息”对话框窗口中，选择“.NET 6.0 (长期支持)”，然后选择“创建”。

使用 NuGet 安装客户端库

右键单击“Translator-text-sdk”项目并选择“管理 NuGet 包...”
选择“浏览”选项卡，然后键入 Azure.AI.Translation.Document。
在项目中选择并安装包。

运行 C# 应用程序

注意

从 .NET 6 开始，使用 console 模板的新项目将生成与以前版本不同的新程序样式。
新的输出使用最新的 C# 功能，这些功能简化了你需要编写的代码。
使用较新版本时，只需编写 Main 方法的主体。无需包括顶级语句、全局 using 指令或隐式 using 指令。
有关详细信息，请参阅新的 C# 模板生成顶级语句。

打开 Program.cs 文件。
删除现有的代码，包括 Console.WriteLine("Hello World!") 行。
在应用程序的 Program.cs 中，为密钥和自定义终结点创建变量。有关详细信息，请参阅检索密钥和自定义域终结点。

private static readonly string endpoint = "<your-document-translation-endpoint>";
private static readonly string key = "<your-key>";

若要针对单个 Blob 容器中的一个或多个文档启动翻译操作，请调用 StartTranslationAsync 方法。

若要调用 StartTranslationAsync，需要初始化包含 sourceUri 和 targetUri 参数的 DocumentTranslationInput 对象：

对于托管标识授权，请创建以下变量：

sourceUri。包含要翻译的文档的源容器的 URL。
targetUri 翻译后的文档要写入到的目标容器的 URL。

targetLanguageCode。翻译后的文档的语言代码。可以在我们的语言支持页上找到语言代码。

Source	目标
1. 选中源容器旁边的复选框	1. 选中目标容器旁边的复选框。
2.在主窗口区域中，选择要翻译的文件或文档。	2. 选择右侧的省略号，然后选择“属性”。
3. 源 URL 位于“属性”列表的顶部。	3. 目标 URL 位于“属性”列表的顶部。

对于共享访问签名 (SAS) 授权，请创建以下变量
- sourceUri。包含要翻译的文档的源容器的 SAS URI，其中追加了一个 SAS 令牌作为查询字符串。
- targetUri 要将已翻译文档写入到的目标容器的 SAS URI，其中追加了一个 SAS 令牌作为查询字符串。
- targetLanguageCode。翻译后的文档的语言代码。可以在我们的语言支持页上找到语言代码。

异步翻译代码示例

重要

完成后，请记住将密钥从代码中删除，并且永远不要公开发布该密钥。对于生产来说，请使用安全的方式存储和访问凭据，例如 Azure Key Vault。有关详细信息，请参阅 Azure AI 服务安全性。

在应用程序的 Program.cs 文件中输入以下代码示例：


using Azure;
using Azure.AI.Translation.Document;

class Program {

  // create variables for your custom endpoint and resource key
  private static readonly string endpoint = "<your-document-translation-endpoint>";
  private static readonly string key = "<your-key>";

  static async Task Main(string[] args) {

    // create variables for your sourceUrl, targetUrl, and targetLanguageCode
    Uri sourceUri = new Uri("<sourceUrl>");
    Uri targetUri = new Uri("<targetUrl>");
    string targetLanguage = "<targetLanguageCode>";

    // initialize a new instance  of the DocumentTranslationClient object to interact with the Document Translation feature
    DocumentTranslationClient client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(key));

    // initialize a new instance of the `DocumentTranslationInput` object to provide source and target locations and target language for the translation operation
    DocumentTranslationInput input = new DocumentTranslationInput(sourceUri, targetUri, targetLanguage);

    // initialize a new instance of the DocumentTranslationOperation class to track the status of the translation operation
    DocumentTranslationOperation operation = await client.StartTranslationAsync(input);

    await operation.WaitForCompletionAsync();

    Console.WriteLine($"  Status: {operation.Status}");
    Console.WriteLine($"  Created on: {operation.CreatedOn}");
    Console.WriteLine($"  Last modified: {operation.LastModified}");
    Console.WriteLine($"  Total documents: {operation.DocumentsTotal}");
    Console.WriteLine($"    Succeeded: {operation.DocumentsSucceeded}");
    Console.WriteLine($"    Failed: {operation.DocumentsFailed}");
    Console.WriteLine($"    In Progress: {operation.DocumentsInProgress}");
    Console.WriteLine($"    Not started: {operation.DocumentsNotStarted}");

    await foreach(DocumentStatusResult document in operation.Value) {
      Console.WriteLine($"Document with Id: {document.Id}");
      Console.WriteLine($"  Status:{document.Status}");
      if (document.Status == DocumentTranslationStatus.Succeeded) {
        Console.WriteLine($"  Translated Document Uri: {document.TranslatedDocumentUri}");
        Console.WriteLine($"  Translated to language: {document.TranslatedToLanguageCode}.");
        Console.WriteLine($"  Document source Uri: {document.SourceDocumentUri}");
      } else {
        Console.WriteLine($"  Error Code: {document.Error.Code}");
        Console.WriteLine($"  Message: {document.Error.Message}");
      }
    }
  }
}

运行应用程序

将代码示例添加到应用程序后，选择 formRecognizer_quickstart 旁边的绿色“开始”按钮以生成和运行程序，或按 F5。

屏幕截图：运行 Visual Studio 程序。

下面是预期输出的代码段：

终端窗口中 Visual Studio Code 输出的屏幕截图。

同步翻译代码示例

可以为此快速入门下载文档翻译示例文档。源语言为英语。



using Azure;
using Azure.AI.Translation.Document;
using System;
using System.Threading;
using System.Text;

class Program {

  string endpoint = "{your-document-translation-endpoint}";
  string apiKey = "{your-api-key}";
  SingleDocumentTranslationClient client = new SingleDocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));

  try
  {
    string filePath = @"C:\{folder}\document-translation-sample.docx"
    using Stream fileStream = File.OpenRead(filePath);

    // MultipartFormFileData (string name, System.IO.Stream content, string contentType);
    var sourceDocument = new MultipartFormFileData(Path.GetFileName(filePath), fileStream, "application/vnd.openxmlformats-officedocument.wordprocessingml.document");

    DocumentTranslateContent content = new DocumentTranslateContent(sourceDocument);

    // DocumentTranslate (string targetLanguage, Azure.AI.Translation.Document.DocumentTranslateContent documentTranslateContent, string sourceLanguage = default, string category = default, bool? allowFallback = default, System.Threading.CancellationToken cancellationToken = default);
    var response = client.DocumentTranslate("de", content);

    Console.WriteLine($"Request string for translation: {requestString}");
    Console.WriteLine($"Response string after translation: {responseString}");
  }
    catch (RequestFailedException exception) {
    Console.WriteLine($"Error Code: {exception.ErrorCode}");
    Console.WriteLine($"Message: {exception.Message}");
  }
}

就这么简单！你刚才已创建了一个可以使用 .NET 客户端库翻译存储容器中的文档的程序。

设置项目

请确保安装了最新版本的 Python。

安装客户端库

安装最新版本的文档翻译客户端库：

  pip install azure-ai-translation-document==1.1.0b1

翻译批量文件

对于此项目，你需要将源文档上传到源容器。可以为此快速入门下载文档翻译示例文档。源语言为英语。
在 Python 应用程序文件中，为资源密钥和自定义终结点创建变量。有关详细信息，请参阅检索密钥和自定义域终结点。

key = "{your-api-key}"
endpoint = "{your-document-translation-endpoint}"

初始化包含 endpoint 和 key 参数的 DocumentTranslationClient 对象。

调用 begin_translation 方法并传入 sourceUri、targetUri 和 targetLanguageCode 参数。

对于托管标识授权，请创建以下变量：

sourceUri。包含要翻译的文档的源容器的 URL。
targetUri 翻译后的文档要写入到的目标容器的 URL。

targetLanguageCode。翻译后的文档的语言代码。可以在我们的语言支持页上找到语言代码。

Source	目标
1. 选中源容器旁边的复选框	1. 选中目标容器旁边的复选框。
2.在主窗口区域中，选择要翻译的文件或文档。	2. 选择右侧的省略号，然后选择“属性”。
3. 源 URL 位于“属性”列表的顶部。	3. 目标 URL 位于“属性”列表的顶部。

对于共享访问签名 (SAS) 授权，请创建以下变量
- sourceUri。包含要翻译的文档的源容器的 SAS URI，其中追加了一个 SAS 令牌作为查询字符串。
- targetUri 要将已翻译文档写入到的目标容器的 SAS URI，其中追加了一个 SAS 令牌作为查询字符串。
- targetLanguageCode。翻译后的文档的语言代码。可以在我们的语言支持页上找到语言代码。

异步翻译代码示例

重要

在 Python 应用程序中输入以下代码示例：


#  import libraries
from azure.core.credentials import AzureKeyCredential
from azure.ai.translation.document import DocumentTranslationClient

# create variables for your resource key, custom endpoint, sourceUrl, targetUrl, and targetLanguage
key = '{your-api-key}'
endpoint = '{your-document-translation-endpoint}'
sourceUri = '<your-container-sourceUrl>'
targetUri = '<your-container-targetUrl>'
targetLanguage = '<target-language-code>'


# initialize a new instance of the DocumentTranslationClient object to interact with the asynchronous Document Translation feature
client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))

# include source and target locations and target language code for the begin translation operation
poller = client.begin_translation(sourceUri, targetUri, targetLanguage)
result = poller.result()

print('Status: {}'.format(poller.status()))
print('Created on: {}'.format(poller.details.created_on))
print('Last updated on: {}'.format(poller.details.last_updated_on))
print(
    'Total number of translations on documents: {}'.format(
        poller.details.documents_total_count
    )
)

print('\nOf total documents...')
print('{} failed'.format(poller.details.documents_failed_count))
print('{} succeeded'.format(poller.details.documents_succeeded_count))

for document in result:
    print('Document ID: {}'.format(document.id))
    print('Document status: {}'.format(document.status))
    if document.status == 'Succeeded':
        print('Source document location: {}'.format(document.source_document_url))
        print(
            'Translated document location: {}'.format(document.translated_document_url)
        )
        print('Translated to language: {}\n'.format(document.translated_to))
    else:
        print(
            'Error Code: {}, Message: {}\n'.format(
                document.error.code, document.error.message
            )
        )

运行应用程序

将代码示例添加到应用程序后，请在终端中键入以下命令：

python asynchronous-sdk.py

下面是预期输出的片段：

终端窗口中 Python 输出的屏幕截图。

同步翻译代码示例

可以为此快速入门下载文档翻译示例文档。源语言为英语。

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.translation.document import SingleDocumentTranslationClient
from azure.ai.translation.document.models import DocumentTranslateContent


def sample_single_document_translation():

    # create variables for your resource api key, document translation endpoint, and target language
    key = "<your-api-key>"
    endpoint = "<your-document-translation-endpoint>"
    target_language = "{target-language-code}"

    # initialize a new instance of the SingleDocumentTranslationClient object to interact with the synchronous Document Translation feature
    client = SingleDocumentTranslationClient(endpoint, AzureKeyCredential(key))

    # absolute path to your document
    file_path = "C:/{your-file-path}/document-translation-sample.docx"
    file_name = os.path.path.basename(file_path)
    file_type = (
        "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
    )
    print(f"File for translation: {file_name}")

    with open(file_name, "r") as file:
        file_contents = file.read()

    document_content = (file_name, file_contents, file_type)
    document_translate_content = DocumentTranslateContent(document=document_content)

    response_stream = client.document_translate(
        body=document_translate_content, target_language=target_language
    )
    translated_response = response_stream.decode("utf-8-sig")  # type: ignore[attr-defined]
    print(f"Translated response: {translated_response}")


if __name__ == "__main__":
    sample_single_document_translation()

就这么简单！你刚才创建了一个程序来使用 Python 客户端库异步和同步地翻译文档。

下一步

了解有关文档翻译操作的详细信息

通过

入门：文档翻译客户端库

先决条件

存储容器授权

生成应用程序

设置项目

安装客户端库

异步翻译文档

异步翻译代码示例

运行应用程序

同步翻译代码示例

设置项目

安装客户端库

翻译批量文件

异步翻译代码示例

运行应用程序

同步翻译代码示例

下一步

其他资源