Translator 3.0:辞書の例

[アーティクル]
09/22/2023

辞書内の用語がコンテキストで使用される方法を示す例を提供します。この操作は、辞書検索と一緒に使用されます。

要求 URL

POST 要求の送信先は次のとおりです。

https://api.cognitive.microsofttranslator.com/dictionary/examples?api-version=3.0

Translator サービスで選択されているネットワークとプライベートエンドポイントの構成とサポートについては、仮想ネットワークのサポートを参照してください。

要求パラメーター

クエリ文字列に渡される要求パラメーターを次に示します。

クエリパラメーター	説明
api-version	"必須のパラメーター"。クライアントによって要求される API のバージョン。値は `3.0` とする必要があります。
from	"必須のパラメーター"。入力テキストの言語を指定します。ソース言語は、`dictionary` スコープに含まれているサポートされている言語のいずれかとする必要があります。
to	"必須のパラメーター"。出力テキストの言語を指定します。ターゲット言語は、`dictionary` スコープに含まれているサポートされている言語のいずれかとする必要があります。

要求ヘッダーには次のものがあります。

ヘッダー	説明
認証ヘッダー	"必須の要求ヘッダー" です。認証>に使用可能な認証オプションをご覧ください。
Content-Type	"必須の要求ヘッダー" です。ペイロードのコンテンツタイプを指定します。次のいずれかの値になります。`application/json`
Content-Length	"必須の要求ヘッダー" です。要求本文の長さです。
X-ClientTraceId	オプション。要求を一意に識別する、クライアントで生成された GUID。 `ClientTraceId` という名前のクエリパラメーターを使用してクエリ文字列内にトレース ID を含める場合、このヘッダーは省略できます。

要求本文

要求の本文は JSON 配列です。各配列要素は、次のプロパティを持つ JSON オブジェクトです。

Text: 検索する用語を指定する文字列。このプロパティは、前の辞書検索要求の逆翻訳からの normalizedText フィールドの値である必要があります。これは、normalizedSource フィールドの値にもなります。
Translation:辞書検索操作によって既に返されている翻訳済みテキストを指定する文字列。これは、辞書検索応答の translations リストにある normalizedTarget フィールドの値とする必要があります。サービスからは、ソースとターゲットの特定の単語ペアの例が返されます。

例を示します。

[
    {"Text":"fly", "Translation":"volar"}
]

次の制限事項が適用されます。

配列に含めることができる要素は、最大でも 10 個です。
配列要素のテキスト値は、スペースも含めて 100 文字以下にする必要があります。

応答本文

正常な応答は、入力配列内の文字列ごとに 1 つの結果が含まれる JSON 配列となります。結果オブジェクトには次のプロパティが含まれています。

normalizedSource:ソース用語の正規化された形式を与える文字列。通常、これは、要求本文内の一致するリストインデックスの Text フィールドの値と同一である必要があります。
normalizedTarget:ターゲット用語の正規化形式を与える文字列。通常、これは、要求本文内の一致するリストインデックスの Translation フィールドの値と同一である必要があります。
examples:(ソース用語、ターゲット用語) ペアの例のリスト。リストの各要素は、次のプロパティを持つオブジェクトです。
sourcePrefix:完全な例を形成するために sourceTerm の値の "前" に連結する文字列。空白文字は、必要なときは既にそこに存在するので追加しないでください。この値は空の文字列でもかまいません。
sourceTerm:実際の用語検索に等しい文字列。完全な例を形成するために、この文字列は sourcePrefix および sourceSuffix を伴って追加されます。その値は区別されており、ユーザーインターフェイス内で、太字にするなど、マークすることができます。
- sourceSuffix:完全な例を形成するために sourceTerm の値の "後" に連結する文字列。空白文字は、必要なときは既にそこに存在するので追加しないでください。この値は空の文字列でもかまいません。
- targetPrefix:ターゲットを除けば、sourcePrefix に類似する文字列です。
- targetTerm:ターゲットを除けば、sourceTerm に類似する文字列です。
- targetSuffix:ターゲットを除けば、sourceSuffix に類似する文字列です。
  
  Note
  
  辞書に例が存在しない場合、応答は 200 (OK) になりますが、examples リストは空のリストとなります。

例

この例では、英語の用語 fly とそのスペイン語翻訳 volar で構成されるペアの例を検索する方法を示します。

curl -X POST "https://api.cognitive.microsofttranslator.com/dictionary/examples?api-version=3.0&from=en&to=es" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'fly', 'Translation':'volar'}]"

応答本文 (わかりやすくするために短縮) は次のとおりです。

[
    {
        "normalizedSource":"fly",
        "normalizedTarget":"volar",
        "examples":[
            {
                "sourcePrefix":"They need machines to ",
                "sourceTerm":"fly",
                "sourceSuffix":".",
                "targetPrefix":"Necesitan máquinas para ",
                "targetTerm":"volar",
                "targetSuffix":"."
            },
            {
                "sourcePrefix":"That should really ",
                "sourceTerm":"fly",
                "sourceSuffix":".",
                "targetPrefix":"Eso realmente debe ",
                "targetTerm":"volar",
                "targetSuffix":"."
            },
            //
            // ...list abbreviated for documentation clarity
            //
        ]
    }
]

Translator 3.0:辞書の例

要求 URL

要求パラメーター

要求本文

応答本文

例

その他のリソース