Azure 翻译器 3.0:BreakSentence

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

请求网址

POST 请求发送到:

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

请参阅虚拟网络支持 ,了解所选网络和专用终结点配置和支持。

请求参数

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

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

请求标头包括:

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

请求主体

请求的正文是一个 JSON 数组。 每个数组元素都是一个 JSON 对象,其中包含名为 <a0/> 的字符串属性。 为属性的值 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 说明
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 "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"