Translator Text API 3.0: 辞書の例Translator Text API 3.0: Dictionary Examples

辞書内の用語がコンテキストで使用される方法を示す例を提供します。Provides examples that show how terms in the dictionary are used in context. この操作は、辞書検索と一緒に使用されます。This operation is used in tandem with Dictionary lookup.

要求 URLRequest URL

POST 要求の送信先は次のとおりです。Send a POST request to:

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

要求パラメーターRequest parameters

クエリ文字列に渡される要求パラメーターを次に示します。Request parameters passed on the query string are:

Query parameter (クエリ パラメーター)Query parameter 説明Description
api-versionapi-version "*必須のパラメーター*"。*Required parameter*.
クライアントによって要求される API のバージョン。Version of the API requested by the client. 値は `3.0` とする必要があります。Value must be `3.0`.
fromfrom "*必須のパラメーター*"。*Required parameter*.
入力テキストの言語を指定します。Specifies the language of the input text. ソース言語は、`dictionary` スコープに含まれている[サポートされている言語](./v3-0-languages.md)のいずれかとする必要があります。The source language must be one of the [supported languages](./v3-0-languages.md) included in the `dictionary` scope.
toto "*必須のパラメーター*"。*Required parameter*.
出力テキストの言語を指定します。Specifies the language of the output text. ターゲット言語は、`dictionary` スコープに含まれている[サポートされている言語](./v3-0-languages.md)のいずれかとする必要があります。The target language must be one of the [supported languages](./v3-0-languages.md) included in the `dictionary` scope.

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

headersHeaders 説明Description
認証ヘッダーAuthentication header(s) "必須の要求ヘッダー" です。Required request header.
認証に使用できるオプションに関するページをご覧ください。See available options for authentication.
Content-TypeContent-Type "*必須の要求ヘッダー*" です。*Required request header*.
ペイロードのコンテンツ タイプを指定します。Specifies the content type of the payload. 次のいずれかの値になります。`application/json`Possible values are: `application/json`.
Content-LengthContent-Length "*必須の要求ヘッダー*" です。*Required request header*.
要求本文の長さです。The length of the request body.
X-ClientTraceIdX-ClientTraceId *省略可能*。*Optional*.
要求を一意に識別する、クライアントで生成された GUID。A client-generated GUID to uniquely identify the request. `ClientTraceId` という名前のクエリ パラメーターを使用してクエリ文字列内にトレース ID を含める場合、このヘッダーは省略できます。You can omit this header if you include the trace ID in the query string using a query parameter named `ClientTraceId`.

要求本文Request body

要求の本文は JSON 配列です。The body of the request is a JSON array. 各配列要素は、次のプロパティを持つ JSON オブジェクトです。Each array element is a JSON object with the following properties:

  • Text:検索する用語を指定する文字列。Text: A string specifying the term to lookup. これは、前のnormalizedText辞書検索要求の逆翻訳からの フィールドの値とする必要があります。This should be the value of a normalizedText field from the back-translations of a previous Dictionary lookup request. これは、normalizedSource フィールドの値にもなります。It can also be the value of the normalizedSource field.

  • Translation:辞書検索操作によって既に返されている翻訳済みテキストを指定する文字列。Translation: A string specifying the translated text previously returned by the Dictionary lookup operation. これは、辞書検索応答の translations リストにある normalizedTarget フィールドの値とする必要があります。This should be the value from the normalizedTarget field in the translations list of the Dictionary lookup response. サービスからは、ソースとターゲットの特定の単語ペアの例が返されます。The service will return examples for the specific source-target word-pair.

例を示します。An example is:

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

次の制限事項が適用されます。The following limitations apply:

  • 配列に含めることができる要素は、最大でも 10 個です。The array can have at most 10 elements.
  • 配列要素のテキスト値は、スペースも含めて 100 文字を超えてはなりません。The text value of an array element cannot exceed 100 characters including spaces.

応答本文Response body

正常な応答は、入力配列内の文字列ごとに 1 つの結果が含まれる JSON 配列となります。A successful response is a JSON array with one result for each string in the input array. 結果オブジェクトには次のプロパティが含まれています。A result object includes the following properties:

  • normalizedSource:ソース用語の正規化された形式を与える文字列。normalizedSource: A string giving the normalized form of the source term. 通常、これは、要求本文内の一致するリスト インデックスの Text フィールドの値と同一である必要があります。Generally, this should be identical to the value of the Text field at the matching list index in the body of the request.

  • normalizedTarget:ターゲット用語の正規化形式を与える文字列。normalizedTarget: A string giving the normalized form of the target term. 通常、これは、要求本文内の一致するリスト インデックスの Translation フィールドの値と同一である必要があります。Generally, this should be identical to the value of the Translation field at the matching list index in the body of the request.

  • examples:(ソース用語、ターゲット用語) ペアの例のリスト。examples: A list of examples for the (source term, target term) pair. リストの各要素は、次のプロパティを持つオブジェクトです。Each element of the list is an object with the following properties:

    • sourcePrefix:完全な例を形成するために sourceTerm の値の "" に連結する文字列。sourcePrefix: The string to concatenate before the value of sourceTerm to form a complete example. 空白文字は、必要なときは既にそこに存在するので追加しないでください。Do not add a space character, since it is already there when it should be. この値は空の文字列でもかまいません。This value may be an empty string.

    • sourceTerm:実際の用語検索に等しい文字列。sourceTerm: A string equal to the actual term looked up. 完全な例を形成するために、この文字列は sourcePrefix および sourceSuffix を伴って追加されます。The string is added with sourcePrefix and sourceSuffix to form the complete example. その値は区別されており、ユーザー インターフェイス内で、太字にするなど、マークすることができます。Its value is separated so it can be marked in a user interface, e.g., by bolding it.

    • sourceSuffix:完全な例を形成するために sourceTerm の値の "" に連結する文字列。sourceSuffix: The string to concatenate after the value of sourceTerm to form a complete example. 空白文字は、必要なときは既にそこに存在するので追加しないでください。Do not add a space character, since it is already there when it should be. この値は空の文字列でもかまいません。This value may be an empty string.

    • targetPrefix:ターゲットを除けば、sourcePrefix に類似する文字列です。targetPrefix: A string similar to sourcePrefix but for the target.

    • targetTerm:ターゲットを除けば、sourceTerm に類似する文字列です。targetTerm: A string similar to sourceTerm but for the target.

    • targetSuffix:ターゲットを除けば、sourceSuffix に類似する文字列です。targetSuffix: A string similar to sourceSuffix but for the target.

    注意

    辞書に例が存在しない場合、応答は 200 (OK) になりますが、examples リストは空のリストとなります。If there are no examples in the dictionary, the response is 200 (OK) but the examples list is an empty list.

Examples

この例では、英語の用語 fly とそのスペイン語翻訳 volar で構成されるペアの例を検索する方法を示します。This example shows how to lookup examples for the pair made up of the English term fly and its Spanish translation 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'}]"

応答本文 (わかりやすくするために短縮) は次のとおりです。The response body (abbreviated for clarity) is:

[
    {
        "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
            //
        ]
    }
]