你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
标识句子边界在一段文本中的位置。
请求的 URL
POST将请求发送到:
https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0
请参阅“虚拟网络支持 翻译器服务”所选网络和专用终结点配置和支持。
请求参数
在查询字符串上传递的请求参数包括:
| 查询参数 | Description |
|---|---|
| api-version |
所需的查询参数。 客户端请求的 API 版本。 值必须是 3.0。 |
| 语言 |
可选查询参数。 标识输入文本语言的语言标记。 如果未指定代码,则应用自动语言检测。 |
| 脚本 |
可选查询参数。 标识输入文本使用的脚本的脚本标记。 如果未指定脚本,则假定语言的默认脚本。 |
请求标头包括:
| Headers | Description |
|---|---|
| 身份验证标头 |
所需的请求标头。 请参阅 可用的身份验证选项。 |
| Content-Type |
所需的请求标头。 指定有效负载的内容类型。 可能的值为: application/json。 |
| Content-Length |
可选。 请求正文的长度。 |
| X-ClientTraceId |
可选。 用于唯一标识请求的客户端生成的 GUID。 如果使用名为 < |
请求主体
请求正文是 JSON 数组。 每个数组元素都是一个 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 (1.0) 之间。 低分(<= 0.4)表示置信度较低。
仅当请求语言自动检测时,该 detectedLanguage 属性才存在于结果对象中。
JSON 响应示例为:
[
{
"detectedLanguage": {
"language": "en",
"score": 1.0
},
"sentLen": [
13,
11,
22
]
}
]
响应标头
| Headers | Description |
|---|---|
| X-RequestId | 服务生成的值用于标识请求,并用于故障排除目的。 |
响应状态代码
以下是请求返回的可能 HTTP 状态代码。
| 状态代码 | Description |
|---|---|
| 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.cognitive.microsofttranslator.com/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"