REST API をプログラムで使用する

[アーティクル]
10/16/2024

ドキュメント翻訳は、Azure AI 翻訳サービスのクラウドベースの機能です。ドキュメント翻訳 API を使用すると、ソースドキュメントの構造とテキストの書式設定を維持しながら、サポートされている言語とさまざまなファイル形式でドキュメント全体を非同期的に翻訳できます。この攻略ガイドでは、任意のプログラミング言語と HTTP REST API でドキュメント翻訳 API を使用する方法について説明します。

前提条件

Note

通常、Azure portal で Azure AI リソースを作成するときは、マルチサービスのキーまたは単一サービスのキーを作成するという選択肢があります。ただし、ドキュメント翻訳は現在 Translator (単一サービス) リソースでのみサポートされているため、Azure AI サービス (マルチサービス) リソースには含まれていません。
ドキュメント翻訳は、S1 Standard サービスプラン (従量課金制) および C2、C3、C4、D3 ボリューム割引プランでサポートされています。「Azure AI 翻訳の価格」を "参照してください"。

開始するには、以下が必要です。

アクティブな Azure アカウント。アカウントがない場合は、無料アカウントを作成できます
Azure Blob Storage アカウント。 Azure Blob Storage アカウント内に、ソースとターゲットの各ファイル用のコンテナーを作成する必要があります。
- ソースのコンテナー。このコンテナーは、翻訳対象のファイルをアップロードする場所です (必須)。
- ターゲットのコンテナー。このコンテナーは、翻訳されたファイルを格納する場所です (必須)。
単一サービス Translator リソース (マルチサービス Azure AI サービスリソースとは異なる):

次のように、Translator プロジェクトとインスタンスの詳細フィールドを入力します。
1. [サブスクリプション]。使用できる Azure サブスクリプションのいずれかを選択します。
2. [リソースグループ]。新しいリソースグループを作成するか、同じライフサイクル、アクセス許可、ポリシーを共有する既存のリソースグループにリソースを追加することができます。
3. [リソースリージョン] . ご自身のビジネスまたはアプリケーションが特定のリージョンを必要としない限り、 [グローバル] を選択します。認証にシステム割り当てマネージド ID を使用する場合は、米国西部などの地理的リージョンを選択します。
4. 名前。リソースに選んだ名前を入力します。選択した名前は Azure 内で一意である必要があります。
  
  Note
  
  ドキュメント翻訳には、カスタムドメインエンドポイントが必要です。名前フィールドに入力する値は、エンドポイントのカスタムドメイン名となります。
5. 価格レベル。ドキュメント翻訳は、Free レベルではサポートされません。このサービスを試すには、Standard S1 を選択してください。
6. [確認および作成] を選択します。
7. サービス条件を確認し、 [作成] を選択してリソースをデプロイします。
8. リソースが正常にデプロイされたら、[リソースに移動] を選択してキーとエンドポイントを取得します。

キーとカスタムドメインエンドポイントを取得する

Translator サービスへの要求では、アクセスを認証するために読み取り専用キーとカスタムエンドポイントが必要です。カスタムドメインエンドポイントは、リソース名、ホスト名、Translator サブディレクトリを指定した形式の URL であり、Azure portal で使用できます。

新しいリソースを作成した場合は、そのデプロイ後に [リソースに移動] を選びます。既存のドキュメント翻訳リソースがある場合は、リソースページに直接移動します。
左側のレールの [リソース管理] で、 [キーとエンドポイント] を選択します。
自分の key と document translation endpoint をコピーして、使いやすい場所 ("Microsoft メモ帳" など) に貼り付けます。 API 呼び出しを行うために必要なキーは 1 つだけです。
key と document translation endpoint を、ドキュメント翻訳サービスへの要求の認証のためのコードサンプルに貼り付けます。

キーを取得する

Translator サービスへの要求には、アクセス認証を受けるための読み取り専用キーが必要です。

新しいリソースを作成した場合は、そのデプロイ後に [リソースに移動] を選びます。既存のドキュメント翻訳リソースがある場合は、リソースページに直接移動します。
左側のレールの [リソース管理] で、 [キーとエンドポイント] を選択します。
自分のキーをコピーして、使いやすい場所 ("Microsoft メモ帳" など) に貼り付けます。
それを、ドキュメント翻訳サービスへの要求の認証のための次のコードサンプルに貼り付けます。

Azure portal のキーを取得するフィールドを示す画像。

Azure Blob Storage コンテナーを作成する

Azure Blob Storage アカウント内に、ソースおよびターゲットの各ファイル用のコンテナーを作成する必要があります。

ソースのコンテナー。このコンテナーは、翻訳対象のファイルをアップロードする場所です (必須)。
ターゲットのコンテナー。このコンテナーは、翻訳されたファイルを格納する場所です (必須)。

Note

ドキュメント翻訳では、用語集は、個別の用語集コンテナーではなく、ターゲットコンテナー内の BLOB としてサポートされます。カスタム用語集を含める場合は、それをターゲットコンテナーに追加し、要求に glossaryUrl を含める必要があります。翻訳言語のペアが用語集に存在しない場合、それは適用されません。「カスタム用語集を使用してドキュメントを翻訳する」を "参照してください"

ドキュメント翻訳用の SAS アクセストークンを作成する

sourceUrl、targetUrl、省略可能な glossaryUrl には Shared Access Signature (SAS) トークンを含める必要があり、クエリ文字列として追加します。トークンは、コンテナーまたは特定の BLOB に割り当てることができます。「ドキュメント翻訳プロセスの SAS トークンを作成する」を "参照してください"。

ソースのコンテナーまたは BLOB には、読み取りと一覧表示のアクセス権が指定されている必要があります。
ターゲットのコンテナーまたは BLOB には、書き込みと一覧表示のアクセス権が指定されている必要があります。
用語集の BLOB には、読み取りと一覧表示のアクセス権が指定されている必要があります。

ヒント

操作で複数のファイル (BLOB) を翻訳する場合は、コンテナーレベルで SAS アクセス権を委任します。
操作で 1 つ のファイル (BLOB) を翻訳する場合は、BLOB レベルで SAS アクセス権を委任します。
SAS トークンの代わりに、システム割り当てマネージド ID を認証に使用することができます。

HTTP 要求

非同期バッチ翻訳要求は、POST 要求を通じて Translator サービスエンドポイントに送信されます。成功した場合、POST メソッドから 202 Accepted 応答コードが返され、サービスによってバッチ要求が作成されます。翻訳されたドキュメントがターゲットコンテナーに一覧表示されます。

Azure AI 翻訳サービスの要求の制限について詳しくは、ドキュメント翻訳要求の制限に関する記事を参照してください。

HTTP ヘッダー

各 Document Translation API 要求には、次のヘッダーが含まれています。

HTTP ヘッダー	説明
Ocp-Apim-Subscription-Key	必須: 値は、Translator または Azure AI サービスリソースの Azure キーです。
Content-Type	必須: ペイロードのコンテンツタイプを指定します。許容される値は、application/json または charset=UTF-8 です。

POST 要求本文のプロパティ

Post 要求の URL は POST https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches です。
POST 要求本文は、inputs という名前の JSON オブジェクトです。
inputs オブジェクトには、ソースとターゲットの言語ペア用の sourceURL と targetURL のコンテナーアドレスが両方とも含まれています。
prefix と suffix は、翻訳対象のソースパス内のドキュメントをフィルター処理するための、大文字と小文字を区別する文字列です。 prefix フィールドは、翻訳用のサブフォルダーを表現するためによく使われます。 suffix フィールドは、ファイルの拡張子に最もよく使われます。
glossaries フィールド (省略可能) の値は、ドキュメントが翻訳されるときに適用されます。
各ターゲット言語の targetUrl は一意でなければなりません。

Note

同じ名前のファイルが宛先に既に存在する場合、ジョブは失敗します。

コンテナー内のすべてのドキュメントを翻訳する

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "{sourceSASUrl}"
            },
            "targets": [
                {
                    "targetUrl": "{targetSASUrl}",
                    "language": "fr"
                }
            ]
        }
    ]
}

コンテナー内の特定のドキュメントを翻訳する

"storageType": "File" を指定します。
システム割り当てマネージド ID を認証に使っていない場合は、(コンテナーではなく) 特定の BLOB またはドキュメントに対して、ソース URL と SAS トークンが作成されていることを確認してください。
ターゲット URL の一部としてターゲットファイル名が指定されていることを確認してください (ただし、SAS トークンはコンテナー用のままです)。
サンプル要求では、1 つのドキュメントが 2 つのターゲット言語に翻訳されたものが返されます。

{
    "inputs": [
        {
            "storageType": "File",
            "source": {
                "sourceUrl": "{sourceSASUrl}"
            },
            "targets": [
                {
                    "targetUrl": "{targetSASUrl}",
                    "language": "es"
                },
                {
                    "targetUrl": "{targetSASUrl}",
                    "language": "de"
                }
            ]
        }
    ]
}

カスタム用語集を使用してドキュメントを翻訳する

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "{sourceSASUrl}"
             },
            "targets": [
                {
                    "targetUrl": "{targetSASUrl}",
                    "language": "es",
                    "glossaries": [
                        {
                            "glossaryUrl": "{glossaryUrl/en-es.xlf}",
                            "format": "xliff"
                        }
                    ]
                }
            ]
        }
    ]
}

コードを使用してドキュメント翻訳要求を送信する

コーディングプラットフォームを設定する

新しいプロジェクトを作成します。
Program.cs を C# コードサンプルで置き換えます。
エンドポイント、キー、コンテナー URL の値を Program.cs に設定します。
JSON データを処理するために、.NET CLI を使用して Newtonsoft.Json パッケージを追加します。
プロジェクトディレクトリからプログラムを実行します。

自分のプロジェクト用に作業ディレクトリを作成します次に例を示します。

mkdir sample-project

プロジェクトディレクトリで、次のサブディレクトリ構造を作成します。

src
└ main
└ java

mkdir -p src/main/java/

注: Java ソースファイル (たとえば、sample.java) は src/main/java にあります。

ルートディレクトリ (たとえば、sample-project) で、Gradle を使用してプロジェクトを初期化します。

gradle init --type basic

DSL を選択するよう求められたら、Kotlin を選択します。

build.gradle.kts ファイルを更新します。サンプルに応じて mainClassName を更新する必要があることに注意してください。

plugins {
  java
  application
}
application {
  mainClassName = "{NAME OF YOUR CLASS}"
}
repositories {
  mavenCentral()
}
dependencies {
  compile("com.squareup.okhttp:okhttp:2.5.0")
}

java ディレクトリで Java ファイルを作成し、提供されたサンプルからコードをコピー/貼り付けします。忘れずに自分のキーとエンドポイントを追加してください。
ルートディレクトリからサンプルをビルドして実行します。
```
gradle build
gradle run
```

新しい Go プロジェクトを作成します。
提供された Go コードサンプルを追加します。
エンドポイント、キー、コンテナー URL の値を設定します。
.go という拡張子でファイルを保存します。
Go がインストールされているコンピューターのコマンドプロンプトを開きます。
ファイルをビルドします。たとえば、go build example-code.go のように指定します。
ファイルを実行します (例: example-code)。

重要

コードサンプルでは、示されている場所に Shared Access Signature (SAS) URL をハードコーディングします。終了したら、コードから SAS の URL を削除し、決して公開しないようにしてください。本番環境では、Azure マネージド ID のような、資格情報を安全に保存してアクセスできる方法を使用してください。詳細については、「Azure Storage のセキュリティ」を参照してください。

操作によっては、次のフィールドの更新が必要になる場合があります。

endpoint

basePath

key

sourceURL

targetURL

glossaryURL

id (ジョブ ID)

`id` 値の検索

ジョブ id は、POST start-batch-translation メソッドの応答ヘッダー Operation-Location の URL 値で確認します。 /document/ パラメーターの後に続く英数字の文字列は、操作のジョブ id です。

応答ヘッダー	応答 URL
Operation-Location	{document-translation-endpoint}/translator/document/`9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec`?api-version={date}

また、get-translations-status 要求を使用して、翻訳 "ジョブ" とその id の一覧を取得することもできます。

非同期バッチ翻訳を開始する


    using System;
    using System.Net.Http;
    using System.Threading.Tasks;
    using System.Text;


    class Program
    {

        static readonly string route = "?api-version={date}";

        private static readonly string basePath = "{your-document-translation-endpoint}/translator/document/batches";

        private static readonly string key = "{your-api-key}";

        static readonly string json = ("{\"inputs\": [{\"source\": {\"sourceUrl\": \"https://YOUR-SOURCE-URL-WITH-READ-LIST-ACCESS-SAS\",\"storageSource\": \"AzureBlob\",\"language\": \"en\"}, \"targets\": [{\"targetUrl\": \"https://YOUR-TARGET-URL-WITH-WRITE-LIST-ACCESS-SAS\",\"storageSource\": \"AzureBlob\",\"category\": \"general\",\"language\": \"es\"}]}]}");

        static async Task Main(string[] args)
        {
            using HttpClient client = new HttpClient();
            using HttpRequestMessage request = new HttpRequestMessage();
            {

                StringContent content = new StringContent(json, Encoding.UTF8, "application/json");

                request.Method = HttpMethod.Post;
                request.RequestUri = new Uri(basePath + route);
                request.Headers.Add("Ocp-Apim-Subscription-Key", key);
                request.Content = content;

                HttpResponseMessage  response = await client.SendAsync(request);
                string result = response.Content.ReadAsStringAsync().Result;
                if (response.IsSuccessStatusCode)
                {
                    Console.WriteLine($"Status code: {response.StatusCode}");
                    Console.WriteLine();
                    Console.WriteLine($"Response Headers:");
                    Console.WriteLine(response.Headers);
                }
                else
                    Console.Write("Error");

            }

        }

    }


const axios = require('axios').default;

let basePath = '{your-document-translation-endpoint}/translator/document/batches';
let route = '?api-version={date}';
let key = '{your-api-key}';

let data = JSON.stringify({"inputs": [
  {
      "source": {
          "sourceUrl": "https://YOUR-SOURCE-URL-WITH-READ-LIST-ACCESS-SAS",
          "storageSource": "AzureBlob",
          "language": "en"
          }
      },
      "targets": [
          {
              "targetUrl": "https://YOUR-TARGET-URL-WITH-WRITE-LIST-ACCESS-SAS",
              "storageSource": "AzureBlob",
              "category": "general",
              "language": "es"}]});

let config = {
  method: 'post',
  baseURL: basePath,
  url: route,
  headers: {
    'Ocp-Apim-Subscription-Key': key,
    'Content-Type': 'application/json'
  },
  data: data
};

axios(config)
.then(function (response) {
  let result = { statusText: response.statusText, statusCode: response.status, headers: response.headers };
  console.log()
  console.log(JSON.stringify(result));
})
.catch(function (error) {
  console.log(error);
});


import requests

base_path = '{your-document-translation-endpoint}/translator/document/batches'
key =  '{your-api-key}'
route = '?api-version={date}'
constructed_url = base_path + route

payload= {
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://YOUR-SOURCE-URL-WITH-READ-LIST-ACCESS-SAS",
                "storageSource": "AzureBlob",
                "language": "en"
            },
            "targets": [
                {
                    "targetUrl": "https://YOUR-TARGET-URL-WITH-WRITE-LIST-ACCESS-SAS",
                    "storageSource": "AzureBlob",
                    "category": "general",
                    "language": "es"
                }
            ]
        }
    ]
}
headers = {
  'Ocp-Apim-Subscription-Key': key,
  'Content-Type': 'application/json'
}

response = requests.post(constructed_url, headers=headers, json=payload)

print(f'response status code: {response.status_code}\nresponse status: {response.reason}\nresponse headers: {response.headers}')


import java.io.*;
import java.net.*;
import java.util.*;
import com.squareup.okhttp.*;

public class DocumentTranslation {
    String key = "{your-api-key}";
    String basePath = "{your-document-translation-endpoint}/translator/document/batches";
    String route = basePath + "?api-version={date}";

    OkHttpClient client = new OkHttpClient();

    public void post() throws IOException {
        MediaType mediaType = MediaType.parse("application/json");
        RequestBody body = RequestBody.create(mediaType,  "{\n \"inputs\": [\n {\n \"source\": {\n \"sourceUrl\": \"https://YOUR-SOURCE-URL-WITH-READ-LIST-ACCESS-SAS\",\n  },\n  \"language\": \"en\",\n \"storageSource\": \"AzureBlob\"\n  },\n \"targets\": [\n {\n \"targetUrl\": \"https://YOUR-TARGET-URL-WITH-WRITE-LIST-ACCESS-SAS\",\n \"category\": \"general\",\n\"language\": \"fr\",\n\"storageSource\": \"AzureBlob\"\n }\n ],\n \"storageType\": \"Folder\"\n }\n  ]\n}");
        Request request = new Request.Builder()
                .url(route).post(body)
                .addHeader("Ocp-Apim-Subscription-Key", key)
                .addHeader("Content-type", "application/json")
                .build();
        Response response = client.newCall(request).execute();
        System.out.println(response.code());
        System.out.println(response.headers());
    }

  public static void main(String[] args) {
        try {
            DocumentTranslation sampleRequest = new DocumentTranslation();
            sampleRequest.post();
        } catch (Exception e) {
            System.out.println(e);
        }
    }
}


package main

import (
 "bytes"
 "fmt"
"net/http"
)

func main() {
basePath := "{your-document-translation-endpoint}/translator/document/batches"
key := "{your-api-key}"
uri := basePath + "?api-version={date}"
method := "POST"

var jsonStr = []byte(`{"inputs":[{"source":{"sourceUrl":"https://YOUR-SOURCE-URL-WITH-READ-LIST-ACCESS-SAS","storageSource":"AzureBlob","language":"en"},"targets":[{"targetUrl":"https://YOUR-TARGET-URL-WITH-WRITE-LIST-ACCESS-SAS","storageSource":"AzureBlob","category":"general","language":"es"}]}]}`)

req, err := http.NewRequest(method, uri, bytes.NewBuffer(jsonStr))
req.Header.Add("Ocp-Apim-Subscription-Key", key)
req.Header.Add("Content-Type", "application/json")

client := &http.Client{}

if err != nil {
    fmt.Println(err)
    return
  }
  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()
  fmt.Println("response status:",  res.Status)
  fmt.Println("response headers",  res.Header)
}

サポートされるドキュメントの形式の取得

サポートされているファイル形式の一覧を取得します。成功した場合、このメソッドから 200 OK 応答コードが返されます。


using System;
using System.Net.Http;
using System.Threading.Tasks;


class Program
{


    private static readonly string basePath = "{your-document-translation-endpoint}/translator/document/formats";

    static readonly string route = "?api-version={date}&type=document";

    private static readonly string key = "{your-api-key}";

    static async Task Main(string[] args)
    {

        HttpClient client = new HttpClient();
            using HttpRequestMessage request = new HttpRequestMessage();
            {
                request.Method = HttpMethod.Get;
                request.RequestUri = new Uri(basePath + route);
                request.Headers.Add("Ocp-Apim-Subscription-Key", key);


                HttpResponseMessage response = await client.SendAsync(request);
                string result = response.Content.ReadAsStringAsync().Result;

                Console.WriteLine($"Status code: {response.StatusCode}");
                Console.WriteLine($"Response Headers: {response.Headers}");
                Console.WriteLine();
                Console.WriteLine(result);
            }
}


const axios = require('axios');

let basePath = '{your-document-translation-endpoint}/translator/document/formats}';
let key = '{your-api-key}';
let route = '?api-version={date}&type=document';

let config = {
  method: 'get',
  url: basePath + route,
  headers: {
    'Ocp-Apim-Subscription-Key': key
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

import java.io.*;
import java.net.*;
import java.util.*;
import com.squareup.okhttp.*;

public class GetFileFormats {

    String key = "{your-api-key}";
    String basePath = "{your-document-translation-endpoint}/translator/document/formats";
    String url = basePath + "?api-version={date}&type=document";
    OkHttpClient client = new OkHttpClient();

    public void get() throws IOException {
        Request request = new Request.Builder().url(
                url).method("GET", null).addHeader("Ocp-Apim-Subscription-Key", key).build();
        Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        }

    public static void main(String[] args) throws IOException {
        try{
            GetJobs jobs = new GetJobs();
            jobs.get();
        } catch (Exception e) {
            System.out.println(e);
        }
    }
}


import http.client

host = '{your-document-translation-endpoint}/translator/document/formats'
parameters = '?api-version={date}&type=document'
key =  '{your-api-key}'
conn = http.client.HTTPSConnection(host)
payload = ''
headers = {
  'Ocp-Apim-Subscription-Key': key
}
conn.request("GET", parameters , payload, headers)
res = conn.getresponse()
data = res.read()
print(res.status)
print()
print(data.decode("utf-8"))


package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  basePath := "https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1{your-document-translation-endpoint}/translator/document/formats"
  key := "{your-api-key}"
  uri := basePath + "?api-version={date}&type=document"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, uri, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Ocp-Apim-Subscription-Key", key)

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(res.StatusCode)
  fmt.Println(string(body))
}

翻訳ジョブの状態を取得する

1 つのジョブの現在の状態と、ドキュメント翻訳要求に含まれるすべてのジョブの概要を取得します。成功した場合、このメソッドから 200 OK 応答コードが返されます。


using System;
using System.Net.Http;
using System.Threading.Tasks;


class Program
{


    private static readonly string basePath = "{your-document-translation-endpoint}/translator/document/batches/{id}";

    static readonly string route = "?api-version={date}";

    private static readonly string key = "{your-api-key}";

    static async Task Main(string[] args)
    {

        HttpClient client = new HttpClient();
            using HttpRequestMessage request = new HttpRequestMessage();
            {
                request.Method = HttpMethod.Get;
                request.RequestUri = new Uri(basePath + route);
                request.Headers.Add("Ocp-Apim-Subscription-Key", key);


                HttpResponseMessage response = await client.SendAsync(request);
                string result = response.Content.ReadAsStringAsync().Result;

                Console.WriteLine($"Status code: {response.StatusCode}");
                Console.WriteLine($"Response Headers: {response.Headers}");
                Console.WriteLine();
                Console.WriteLine(result);
            }
    }
}


const axios = require('axios');

let basePath = '{your-document-translation-endpoint}/translator/document/batches/{id}';
let key = '{your-api-key}';
let route = '?api-version={date}';

let config = {
  method: 'get',
  url: endpoint + route,
  headers: {
    'Ocp-Apim-Subscription-Key': key
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});


import java.io.*;
import java.net.*;
import java.util.*;
import com.squareup.okhttp.*;

public class GetJobStatus {

    String key = "{your-api-key}";
    String basePath = "{your-document-translation-endpoint}/translator/document/batches/{id}";
    String url = basePath + "?api-version={date}";
    OkHttpClient client = new OkHttpClient();

    public void get() throws IOException {
        Request request = new Request.Builder().url(
                url).method("GET", null).addHeader("Ocp-Apim-Subscription-Key", key).build();
        Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        }

    public static void main(String[] args) throws IOException {
        try{
            GetJobs jobs = new GetJobs();
            jobs.get();
        } catch (Exception e) {
            System.out.println(e);
        }
    }
}


import http.client

host = '{your-document-translation-endpoint}/translator/document/batches/{id}'
parameters = '?api-version={date}'
key =  '{your-api-key}'
conn = http.client.HTTPSConnection(host)
payload = ''
headers = {
  'Ocp-Apim-Subscription-Key': key
}
conn.request("GET", parameters , payload, headers)
res = conn.getresponse()
data = res.read()
print(res.status)
print()
print(data.decode("utf-8"))


package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  basePath := "{your-document-translation-endpoint}/translator/document/batches/{id}"
  key := "{your-api-key}"
  uri := basePath + "?api-version={date}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, uri, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Ocp-Apim-Subscription-Key", key)

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(res.StatusCode)
  fmt.Println(string(body))
}

特定のドキュメントの状態を取得する

概要

ドキュメント翻訳要求内の特定のドキュメントの状態を取得します。成功した場合、このメソッドから 200 OK 応答コードが返されます。


using System;
using System.Net.Http;
using System.Threading.Tasks;


class Program
{


    private static readonly string basePath = "{document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}";

    static readonly string route = "?api-version={date}";

    private static readonly string key = "{your-api-key}";

    static async Task Main(string[] args)
    {

        HttpClient client = new HttpClient();
            using HttpRequestMessage request = new HttpRequestMessage();
            {
                request.Method = HttpMethod.Get;
                request.RequestUri = new Uri(basePath + route);
                request.Headers.Add("Ocp-Apim-Subscription-Key", key);


                HttpResponseMessage response = await client.SendAsync(request);
                string result = response.Content.ReadAsStringAsync().Result;

                Console.WriteLine($"Status code: {response.StatusCode}");
                Console.WriteLine($"Response Headers: {response.Headers}");
                Console.WriteLine();
                Console.WriteLine(result);
            }
}


const axios = require('axios');

let basePath = '{your-document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}';
let key = '{your-api-key}';
let route = '?api-version={date}';

let config = {
  method: 'get',
  url: basePath + route,
  headers: {
    'Ocp-Apim-Subscription-Key': key
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});


import java.io.*;
import java.net.*;
import java.util.*;
import com.squareup.okhttp.*;

public class GetDocumentStatus {

    String key = "{your-api-key}";
    String basePath = "{your-document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}";
    String url = endpoint + "?api-version={date}";
    OkHttpClient client = new OkHttpClient();

    public void get() throws IOException {
        Request request = new Request.Builder().url(
                url).method("GET", null).addHeader("Ocp-Apim-Subscription-Key", key).build();
        Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        }

    public static void main(String[] args) throws IOException {
        try{
            GetJobs jobs = new GetJobs();
            jobs.get();
        } catch (Exception e) {
            System.out.println(e);
        }
    }
}


import http.client

host = '{your-document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}'
parameters = '?api-version={date}'
key =  '{your-api-key}'
conn = http.client.HTTPSConnection(host)
payload = ''
headers = {
  'Ocp-Apim-Subscription-Key': key
}
conn.request("GET", parameters , payload, headers)
res = conn.getresponse()
data = res.read()
print(res.status)
print()
print(data.decode("utf-8"))


package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  basePath := "{your-document-translation-endpoint}/translator/document/batches/{id}/documents/{documentId}"
  key := "{your-api-key}"
  uri := basePath + "?api-version={date}"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, uri, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Ocp-Apim-Subscription-Key", key)

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(res.StatusCode)
  fmt.Println(string(body))
}

ジョブを削除する

概要

現在処理中またはキューに入っているジョブをキャンセルします。翻訳が開始されていないドキュメントだけがキャンセルされます。


using System;
using System.Net.Http;
using System.Threading.Tasks;


class Program
{


    private static readonly string basePath = "{your-document-translation-endpoint}/translator/document/batches/{id}";

    static readonly string route = "?api-version={date}";

    private static readonly string key = "{your-api-key}";

    static async Task Main(string[] args)
    {

        HttpClient client = new HttpClient();
            using HttpRequestMessage request = new HttpRequestMessage();
            {
                request.Method = HttpMethod.Delete;
                request.RequestUri = new Uri(basePath + route);
                request.Headers.Add("Ocp-Apim-Subscription-Key", key);


                HttpResponseMessage response = await client.SendAsync(request);
                string result = response.Content.ReadAsStringAsync().Result;

                Console.WriteLine($"Status code: {response.StatusCode}");
                Console.WriteLine($"Response Headers: {response.Headers}");
                Console.WriteLine();
                Console.WriteLine(result);
            }
}


const axios = require('axios');

let basePath = '{your-document-translation-endpoint}/translator/document/batches/{id}';
let key = '{your-api-key}';
let route = '?api-version={date}';

let config = {
  method: 'delete',
  url: basePath + route,
  headers: {
    'Ocp-Apim-Subscription-Key': key
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});


import java.io.*;
import java.net.*;
import java.util.*;
import com.squareup.okhttp.*;

public class DeleteJob {

    String key = "{your-api-key}";
    String basePath = "{your-document-translation-endpoint}/translator/document/batches/{id}";
    String url = basePath + "?api-version={date}";
    OkHttpClient client = new OkHttpClient();

    public void get() throws IOException {
        Request request = new Request.Builder().url(
                url).method("DELETE", null).addHeader("Ocp-Apim-Subscription-Key", key).build();
        Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        }

    public static void main(String[] args) throws IOException {
        try{
            GetJobs jobs = new GetJobs();
            jobs.get();
        } catch (Exception e) {
            System.out.println(e);
        }
    }
}


import http.client

host = '{your-document-translation-endpoint}/translator/document/batches/{id}'
parameters = '?api-version={date}'
key =  '{your-api-key}'
conn = http.client.HTTPSConnection(host)
payload = ''
headers = {
  'Ocp-Apim-Subscription-Key': key
}
conn.request("DELETE", parameters , payload, headers)
res = conn.getresponse()
data = res.read()
print(res.status)
print()
print(data.decode("utf-8"))


package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  basePath := "{your-document-translation-endpoint}/translator/document/batches/{id}"
  key := "{your-api-key}"
  uri := basePath + "?api-version={date}"
  method := "DELETE"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, uri, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Ocp-Apim-Subscription-Key", key)

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(res.StatusCode)
  fmt.Println(string(body))
}

一般的な HTTP 状態コード

HTTP 状態コード	説明	考えられる理由
200	OK	要求は成功しました。
400	正しくない要求	必須パラメーターが指定されていない、空、または null です。または、必須またはオプションのパラメーターに渡された値が無効です。よくある問題はヘッダーが長すぎることです。
401	権限がありません	要求は承認されません。キーまたはトークンが有効であり、正しいリージョンにあることを確認してください。 Azure portal でサブスクリプションを管理する場合、Azure AI サービスマルチサービスリソースではなく、Translator 単一サービスリソースを使用していることを確認してください。
429	要求が多すぎます	使用中のサブスクリプションで許可されている要求のクォータまたは速度を超えています。
502	無効なゲートウェイ	ネットワークまたはサーバー側の問題です。無効なヘッダーを示す場合もあります。

詳細情報

次のステップ

カスタム翻訳ツールを使用してカスタマイズされた言語システムを作成する

次の方法で共有

REST API をプログラムで使用する

前提条件

キーとカスタムドメインエンドポイントを取得する

キーを取得する

Azure Blob Storage コンテナーを作成する

ドキュメント翻訳用の SAS アクセストークンを作成する

HTTP 要求

HTTP ヘッダー

POST 要求本文のプロパティ

コンテナー内のすべてのドキュメントを翻訳する

コンテナー内の特定のドキュメントを翻訳する

カスタム用語集を使用してドキュメントを翻訳する

コードを使用してドキュメント翻訳要求を送信する

コーディングプラットフォームを設定する

`id` 値の検索

非同期バッチ翻訳を開始する

サポートされるドキュメントの形式の取得

翻訳ジョブの状態を取得する

特定のドキュメントの状態を取得する

概要

ジョブを削除する

概要

一般的な HTTP 状態コード

詳細情報

次のステップ

フィードバック

その他のリソース

次の方法で共有

REST API をプログラムで使用する

前提条件

キーとカスタム ドメイン エンドポイントを取得する

キーを取得する

Azure Blob Storage コンテナーを作成する

ドキュメント翻訳用の SAS アクセス トークンを作成する

HTTP 要求

HTTP ヘッダー

POST 要求本文のプロパティ

コンテナー内のすべてのドキュメントを翻訳する

コンテナー内の特定のドキュメントを翻訳する

カスタム用語集を使用してドキュメントを翻訳する

コードを使用してドキュメント翻訳要求を送信する

コーディング プラットフォームを設定する

id 値の検索

非同期バッチ翻訳を開始する

サポートされるドキュメントの形式の取得

翻訳ジョブの状態を取得する

特定のドキュメントの状態を取得する

概要

ジョブを削除する

概要

一般的な HTTP 状態コード

詳細情報

次のステップ

フィードバック

その他のリソース

キーとカスタムドメインエンドポイントを取得する

ドキュメント翻訳用の SAS アクセストークンを作成する

コーディングプラットフォームを設定する

`id` 値の検索