知识库知识库外部开放接口
保存文档元数据
批量保存文档元数据,docMetaSimpleVOs 数量不能超过 100。spaceId 可不传,服务端将以 docId 所属空间为准;传入时必须一致。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| spaceId | int64 | 否 | 知识库空间 ID;可不传,服务端以文档所属空间为准;传入时必须与文档所属空间一致。 | 123456 |
| docId | int64 | 是 | 文档 ID。 | 987654 |
| docMetaSimpleVOs | object[] | 是 | 待保存的元数据列表,最多 100 个。 | |
| └metaId | int64 | 否 | 元数据 ID。 | 123456 |
| └metaValue | string | 否 | 文本类型属性值;标签类型属性兼容单个标签 ID。 | 产品文档 |
| └metaValues | string[] | 否 | 标签类型属性的标签 ID 列表;空数组表示清空该属性标签。 | ["123","456"] |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | int64 | 资源 ID。 | 987654 |
错误码
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误。常见业务码:402 MISS_PARAM、403 ERR_PARAM。 |
| 401 | OPENAPI_AUTH 鉴权失败。常见业务码:405 AUTH_FAILED。 |
| 404 | 资源不存在。常见业务码:404 NOT_FOUND、408 SPACE_NOT_EXISTS。 |
| 500 | 服务内部异常。常见业务码:500 ERROR。 |
postEndpoint
/api/athena/openApi/external/saveDocMetaInfoscurl -X POST "https://b.163.com/api/athena/openApi/external/saveDocMetaInfos" \ -H "Content-Type: application/json" \ -d '{ "docId": 987654, "docMetaSimpleVOs": [ {} ] }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": 987654
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?