ソース言語の文字または文字を、ターゲット言語の対応する文字または文字に変換します。
要求 URL
POST 依頼:
POST http://localhost:{port}/transliterate?api-version=3.0&language={language}&fromScript={fromScript}&toScript={toScript}
Translator サービスの選択したネットワークとプライベート エンドポイントの構成とサポートについてはVirtual ネットワーク サポート を参照してください。
要求パラメーター
クエリ文字列に渡される要求パラメーターを次に示します。
| Query parameter (クエリ パラメーター) | 説明 | 条件 |
|---|---|---|
| APIバージョン | クライアントによって要求される API のバージョン。 値は 3.0 とする必要があります。 |
必須パラメーター |
| 言語 | スクリプト間で変換するテキストのソース言語を指定します。 | 必須パラメーター |
| fromScript | 入力テキストによって使用されるスクリプトを指定します。 | 必須パラメーター |
| toScript | 出力スクリプトを指定します。 | 必須パラメーター |
- サポートされている言語スコープ
transliterationサービスに対してクエリを実行できます。 - 表記変換Language のサポートも参照してください。
要求ヘッダー
| ヘッダー | 説明 | 条件 |
|---|---|---|
| 認証ヘッダー | 認証使用可能なオプションを参照してください | 必要な要求ヘッダー |
| コンテンツタイプ | ペイロードのコンテンツ タイプを指定します。 指定できる値: application/json |
必要な要求ヘッダー |
| Content-Length (コンテンツの長さ) | 要求本文の長さ。 | オプション |
| X-ClientTraceId | 要求を一意に識別する、クライアントで生成された GUID。
ClientTraceIdという名前のクエリ パラメーターを使用してクエリ文字列にトレース ID を含める場合は、この省略可能なヘッダーを省略できます。 |
オプション |
応答の本文
正常な応答は、入力配列内の要素ごとに 1 つの結果が含まれる JSON 配列となります。 結果オブジェクトには次のプロパティが含まれています。
text: 入力文字列を出力スクリプトに変換した結果の文字列。script:出力で使用されるスクリプトを指定する文字列。
応答ヘッダー
| ヘッダー | 説明 |
|---|---|
| X-RequestId | 要求を識別するためにサービスによって生成される値。 トラブルシューティングの目的で使用できます。 |
要求のサンプル
curl -X POST "http://localhost:5000/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latin"
サンプル要求本文
要求の本文は JSON 配列です。 各配列要素は、Text という名前の文字列プロパティ (変換する文字列を表す) を持つ JSON オブジェクトです。
[
{"Text":"こんにちは"},
{"Text":"さようなら"}
]
次の制限事項が適用されます。
- 配列には最大 10 個の要素を含めることができます。
- 配列要素のテキスト値は、スペースも含めて 1,000 文字以下にする必要があります。
- 要求に含めるテキスト全体は、スペースも含めて 5,000 文字以下にする必要があります。
JSON 応答の例:
[
{
"text": "Kon'nichiwa",
"script": "Latin"
},
{
"text": "sayonara",
"script": "Latin"
}
]
注
- 各サンプルは、
localhostコマンドで指定したdocker runで実行されます。 - コンテナーの実行中、
localhostはコンテナー自体を指します。 -
localhost:5000を使用する必要はありません。 ホスト環境でまだ使用されていない任意のポートを使用できます。
REST API を使用した表記変換
curl -X POST "http://localhost:5000/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latin" -H "Content-Type: application/json" -d "[{'Text':'こんにちは'},{'Text':'さようなら'}]"