文档分段效果预览 - PreviewDocumentSegment
功能介绍
该接口用于文档分段效果预览。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/wise-brain-manager/document-segment/preview
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，获取方法请参考获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
document_id | 是 | String | 文档ID。 |
preview_lines | 否 | Integer | 预览行数。 取值范围： 1~100 默认取值： 10 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization | 否 | String | 使用AK/SK方式认证时必选，携带的鉴权信息。 |
X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选，请求的发生时间。 |
X-Project-Id | 否 | String | 使用AK/SK方式认证时必选，携带项目ID信息。 |
X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
X-Request-Id | String | 请求ID。 |
参数 | 参数类型 | 描述 |
|---|---|---|
[数组元素] | Array of DocumentSegmentInfo objects | 文档分段信息 |
参数 | 参数类型 | 描述 |
|---|---|---|
text_index | Integer | 分段序号 取值范围： 0~65536 |
id | String | 分段文本ID |
title | String | 分段文本标题 |
text | String | 分段文本内容 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
请求示例
GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/wise-brain-manager/document-segment/preview
{
"split_type" : 1,
"chunk_size" : 200,
"chunk_type" : "title,separator",
"separators" : [ "。\n？" ]
} 响应示例
状态码：200
处理成功返回。
[ {
"text_index" : 0,
"id" : "8a2de18a9559f1ce019559f26583002f",
"title" : "杭州文化",
"text" : "杭州历史文化内涵博大精深。"
} ] 状态码：400
请求传参异常，包含错误码及对应描述。
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
} 状态码
状态码 | 描述 |
|---|---|
200 | 处理成功返回。 |
400 | 请求传参异常，包含错误码及对应描述。 |
错误码
请参见错误码。
