Translator 3.0：字典示例

提供演示如何在上下文中使用字典中的术语的示例。 此作与 字典查找结合使用。

请求的 URL

POST将请求发送到：

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

请参阅“虚拟网络支持 翻译器服务”所选网络和专用终结点配置和支持。

请求参数

在查询字符串上传递的请求参数包括：

查询参数	Description
api-version	必需参数。 客户端请求的 API 版本。 值必须是 3.0。
发件人	必需参数。 指定输入文本的语言。 源语言必须是范围中包含的dictionary支持语言之一。
到	必需参数。 指定输出文本的语言。 目标语言必须是范围中包含的dictionary支持语言之一。

请求标头包括：

Headers	Description
身份验证标头	所需的请求标头。 请参阅 身份验证>的可用选项。
Content-Type	所需的请求标头。 指定有效负载的内容类型。 可能的值为： application/json。
Content-Length	可选。 请求正文的长度。
X-ClientTraceId	可选。 用于唯一标识请求的客户端生成的 GUID。 如果使用名为 <a0/> 的查询参数在查询字符串中包含跟踪 ID，则可以省略此标头。

请求主体

请求正文是 JSON 数组。 每个数组元素都是具有以下属性的 JSON 对象：

• Text：指定要查找的术语的字符串。 此属性应是上一normalizedText字典查找请求的后翻译中的字段的值。 它也可以是字段的值 normalizedSource 。

• Translation：一个字符串，指定 字典查找 作之前返回的已翻译文本。 此属性应是字典查找响应列表中字段translations的值normalizedTarget。 该服务返回特定源目标单词对的示例。

例如：

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

以下限制适用：

• 数组最多可以有 10 个元素。
• 数组元素的文本值不能超过 100 个字符，包括空格。

响应体

成功的响应是一个 JSON 数组，输入数组中的每个字符串都有一个结果。 结果对象包含以下属性：

• normalizedSource：一个字符串，它提供源术语的规范化形式。 通常，此属性应与请求正文中匹配列表索引处字段的值 Text 相同。

• normalizedTarget：一个字符串，提供目标术语的规范化形式。 通常，此属性应与请求正文中匹配列表索引处字段的值 Translation 相同。

• examples：（源术语、目标术语）对的示例列表。 列表的每个元素都是具有以下属性的对象：

• sourcePrefix：要在要形成完整示例的值sourceTerm之前连接的字符串。 不要添加空格字符，因为它在应有时就已存在。 此值可以是空字符串。

• sourceTerm：一个等于实际字词的字符串。 添加字符串 sourcePrefix 并 sourceSuffix 构成完整示例。 它的值是分隔的，因此可以通过加粗在用户界面中标记它。

  • sourceSuffix：要在构成完整示例的值sourceTerm后连接的字符串。 不要添加空格字符，因为它在应有时就已存在。 此值可以是空字符串。

  • targetPrefix：与目标类似的 sourcePrefix 字符串。

  • targetTerm：与目标类似的 sourceTerm 字符串。

  • targetSuffix：与目标类似的 sourceSuffix 字符串。

    注释

    如果字典中没有示例，则响应为 200（正常），但 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
            //
        ]
    }
]