概要: ドキュメント翻訳クライアント ライブラリ

プロジェクトの設定

コンソール ウィンドウ (cmd、PowerShell、Bash など) で、dotnet new コマンドを使用し、batch-document-translation という名前で新しいコンソール アプリを作成します。 このコマンドにより、1 つのソース ファイルを使用する単純な "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

ドキュメントを非同期で翻訳する

1. このプロジェクトでは、ソース コンテナーにアップロードされたソース ドキュメントが必要です。 このクイックスタートでは、ドキュメント翻訳のサンプル ドキュメントをダウンロードできます。 ソース言語は英語です。

2. プロジェクト ディレクトリから、好みのエディターまたは IDE で Program.cs ファイルを開きます。 行 Console.WriteLine("Hello World!") を含む既存のコードを削除します。

3. アプリケーションの Program.cs で、対象のキーとカスタム エンドポイントの変数を作成します。 詳細については、「キーとカスタム ドメイン エンドポイントを取得する」をご覧ください。

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

4. StartTranslationAsync メソッドを呼び出して、1 つの BLOB コンテナー内の 1 つ以上のドキュメントについて翻訳操作を開始します。

5. StartTranslationAsync を呼び出すには、以下の sourceUri、targetUri、targetLanguageCode パラメーターを含む DocumentTranslationInput オブジェクトを初期化する必要があります。

   • マネージド ID 承認の場合は、次の変数を作成します。

     • sourceUri。 翻訳するドキュメントが含まれるソース コンテナーの URI。

     • targetUri。翻訳されたドキュメントが書き込まれるターゲット コンテナーの URL。

     • targetLanguageCode。 翻訳されるドキュメントの言語コード。 言語コードは、言語サポートに関するページに記載されています。

       ソース URL とターゲット URL を見つけるには、Azure portal のストレージ アカウントに移動します。 左側のサイドバーの [データ ストレージ] で [コンテナー] を選び、以下の手順に従ってソース ドキュメントとターゲット コンテナー URLS を取得します。

       source	移行先
       1. ソース コンテナーの横にあるチェック ボックスをオンにします。	1. ターゲット コンテナーの横にあるチェック ボックスをオンにします。
       2.メイン ウィンドウ領域から、翻訳するファイルまたはドキュメントを選びます。	2. 右側にある省略記号を選択し、[プロパティ] を選択します。
       3. ソース URL は、[プロパティ] リストの上部にあります。	3. ターゲット URL は、[プロパティ] リストの上部にあります。

   • Shared Access Signature (SAS) 承認の場合、これらの変数を作成します

     • sourceUri。 変換するドキュメントを含むソース コンテナーの SAS トークンがクエリ文字列として追加された SAS URI。
     • targetUri 翻訳されたドキュメントの書き込み先のターゲット コンテナーに対応する SAS トークンがクエリ文字列として追加された SAS URI。
     • targetLanguageCode。 翻訳されるドキュメントの言語コード。 言語コードは、言語サポートに関するページに記載されています。

非同期翻訳のコード サンプル

次のコード サンプルを入力して、アプリケーションの 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

予想される出力のスニペットを次に示します。

同期翻訳のコード サンプル

このクイックスタートでは、ドキュメント翻訳のサンプル ドキュメントをダウンロードできます。 ソース言語は英語です。

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 を使用して、アプリケーションをビルドして実行します。

1. Visual Studio を起動します。

2. [概要] ページで、[新しいプロジェクトの作成] を選択します。

   

3. [新しいプロジェクトの作成] ページで、検索ボックスに「コンソール」と入力します。 [コンソール アプリケーション] テンプレートを選択し、 [次へ] を選択します。

   

4. [新しいプロジェクトの構成] ダイアログ ウィンドウの [プロジェクト名] ボックスに「asynchronous-sdk」と入力します。 [次へ] を選びます。

   

5. [追加情報] ダイアログ ウィンドウで、[.NET 6.0 (長期的なサポート)] を選択し、[作成] を選択します。

   

NuGet を使用してクライアント ライブラリをインストールする

1. Translator-text-sdk プロジェクトを右クリックし、[NuGet パッケージの管理...] を選択します。

2. [参照] タブを選択し、「Azure.AI.Translation.Document」と入力します。

   

3. プロジェクトでパッケージを選択してインストールします。

   

C# アプリケーションをビルドする

1. Program.cs ファイルを開きます。

2. 行 Console.WriteLine("Hello World!") を含む既存のコードを削除します。

3. アプリケーションの Program.cs で、対象のキーとカスタム エンドポイントの変数を作成します。 詳細については、「キーとカスタム ドメイン エンドポイントを取得する」をご覧ください。

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

1. 1 つの BLOB コンテナー内の 1 つ以上のドキュメントについて翻訳操作を開始するには、StartTranslationAsync メソッドを呼び出します。

2. StartTranslationAsync を呼び出すには、以下の sourceUri、targetUri パラメーターを含む DocumentTranslationInput オブジェクトを初期化する必要があります。

   • マネージド ID 承認の場合は、次の変数を作成します。

     • sourceUri。 翻訳するドキュメントが含まれるソース コンテナーの URI。

     • targetUri。翻訳されたドキュメントが書き込まれるターゲット コンテナーの URL。

     • targetLanguageCode。 翻訳されるドキュメントの言語コード。 言語コードは、言語サポートに関するページに記載されています。

       ソース URL とターゲット URL を見つけるには、Azure portal のストレージ アカウントに移動します。 左側のサイドバーの [データ ストレージ] で [コンテナー] を選び、以下の手順に従ってソース ドキュメントとターゲット コンテナー URLS を取得します。

       source	移行先
       1. ソース コンテナーの横にあるチェック ボックスをオンにします。	1. ターゲット コンテナーの横にあるチェック ボックスをオンにします。
       2.メイン ウィンドウ領域から、翻訳するファイルまたはドキュメントを選びます。	2. 右側にある省略記号を選択し、[プロパティ] を選択します。
       3. ソース URL は、[プロパティ] リストの上部にあります。	3. ターゲット URL は、[プロパティ] リストの上部にあります。

   • Shared Access Signature (SAS) 承認の場合、これらの変数を作成します

     • sourceUri。 変換するドキュメントを含むソース コンテナーの SAS トークンがクエリ文字列として追加された SAS URI。
     • targetUri 翻訳されたドキュメントの書き込み先のターゲット コンテナーに対応する SAS トークンがクエリ文字列として追加された SAS URI。
     • targetLanguageCode。 翻訳されるドキュメントの言語コード。 言語コードは、言語サポートに関するページに記載されています。

非同期翻訳のコード サンプル

次のコード サンプルを入力して、アプリケーションの 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 キーを押します。

予想される出力のスニペットを次に示します。

同期翻訳のコード サンプル

このクイックスタートでは、ドキュメント翻訳のサンプル ドキュメントをダウンロードできます。 ソース言語は英語です。

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}");
  }
}