翻译器 3.0：BreakSentence

项目
06/28/2024

标识文本段中的句子边界的位置。

请求 URL

将 POST 请求发送到：

https://api.translator.azure.cn/breaksentence?api-version=3.0

请参阅虚拟网络支持，以了解翻译器服务选择的网络和专用终结点配置与支持。

请求参数

查询字符串上传递的请求参数如下：

查询参数	说明
api-version	必需的查询参数。客户端所请求的 API 的版本。值必须是 `3.0`。
语言	可选查询参数。语言标记，标识输入文本的语言。如果未指定代码，则会应用自动语言检测。
脚本	可选查询参数。脚本标记，标识输入文本使用的脚本。如果未指定脚本，则会采用语言的默认脚本。

请求标头包括：

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

请求正文

请求的正文是一个 JSON 数组。每个数组元素都是一个包含字符串属性名称为 Text 的 JSON 对象。句子边界是针对 Text 属性的值计算的。具有一个文本段的示例请求正文如下所示：

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

以下限制适用：

数组最多可具有 100 个元素。
数组元素的文本值不能超过 50,000 个字符（包括空格）。
包括空格在内，请求中包含的整个文本不能超过 50,000 个字符。
如果指定了 language 查询参数，则所有数组元素必须采用同一语言。否则，将分别向每个数组元素应用语言自动检测。

响应正文

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

sentLen：一组整数，表示文本元素中各个句子的长度。数组的长度是句子的数量，而各个值是每个句子的长度。
detectedLanguage：一个对象，它通过以下属性描述检测到的语言：
- language：已检测语言的代码。
- score：一个浮点值，表示结果的置信度。分数在零 (0) 到一 (1.0) 之间。低分 (<= 0.4) 表示置信度低。

当请求了语言自动检测时，detectedLanguage 属性仅存在于结果对象中。

示例 JSON 响应如下：

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

响应标头

头文件	说明
X-RequestId	服务生成的值，用于标识请求并用于故障排除目的。

响应状态代码

下面是请求可能返回的 HTTP 状态代码。

状态代码	说明
200	成功。
400	查询参数之一缺失或无效。请更正请求参数，然后重试。
401	无法对请求进行身份验证。请确保凭据已指定且有效。
403	请求未授权。请检查详细错误消息。此响应代码通常指示已使用试用版订阅提供的所有免费翻译。
429	由于客户端已超出请求限制，因此服务器拒绝了请求。
500	发生了意外错误。如果错误持续存在，请报告相关信息：发生故障的日期和时间、响应标头 `X-RequestId` 中的请求标识符、请求标头 `X-ClientTraceId` 中的客户端标识符。
503	服务器暂不可用。重试请求。如果错误持续存在，请报告相关信息：发生故障的日期和时间、响应标头 `X-RequestId` 中的请求标识符、请求标头 `X-ClientTraceId` 中的客户端标识符。

如果发生错误，请求会返回 JSON 错误响应。错误代码是一个 6 位数字，包括 3 位数的 HTTP 状态代码，后接用于进一步将错误分类的 3 位数。常见错误代码可在 v3 翻译器参考页上找到。

示例

下面的示例展示了如何获取单个句子的句子边界。该服务会自动检测句子语言。

curl -X POST "https://api.translator.azure.cn/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Ocp-Apim-Subscription-Region: your-region" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"

通过