ディクショナリ内の用語がコンテキストでどのように使用されるかを示す例を示します。 この操作は、辞書検索と共 に使用されます。
リクエストURL
次の POST 要求を送信します。
https://api.cognitive.microsofttranslator.com/dictionary/examples?api-version=3.0
Translator で選択したネットワークとプライベート エンドポイントの構成とサポートに対する仮想ネットワークのサポートを参照してください。
要求パラメーター
クエリ文字列で渡される要求パラメーターは次のとおりです。
要求ヘッダーには次のものが含まれます。
| Headers | Description |
|---|---|
| 認証ヘッダー |
必須の要求ヘッダー。 認証>使用可能な認証オプションを参照してください。 |
| コンテンツタイプ |
必須の要求ヘッダー。 ペイロードのコンテンツ タイプを指定します。 指定できる値は、 application/jsonです。 |
| コンテンツの長さ |
オプション。 要求本文の長さ。 |
| X-ClientTraceId |
オプション。 要求を一意に識別するためのクライアントによって生成された GUID。 ClientTraceIdという名前のクエリ パラメーターを使用してクエリ文字列にトレース ID を含める場合は、このヘッダーを省略できます。 |
リクエストの本文
要求の本文は JSON 配列です。 各配列要素は、次のプロパティを持つ JSON オブジェクトです。
Text: 検索する用語を指定する文字列。 このプロパティは、前のnormalizedText要求のバックトランスレーションの フィールドの値である必要があります。normalizedSourceフィールドの値にすることもできます。Translation: 辞書検索 操作によって以前に返された翻訳されたテキストを指定する文字列。 このプロパティは、normalizedTarget応答のtranslationsリストの フィールドの値である必要があります。 このサービスは、特定のソースとターゲットの単語ペアの例を返します。
例を次に示します。
[
{"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に似ていますが、ターゲットに対する文字列。注
辞書に例がない場合、応答は 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
//
]
}
]