知识库知识库外部开放接口
批量获取文档元数据
按 docIds 批量查询文档元数据,docIds 数量不能超过 100。
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| tenantGuid | string | 否 | 兼容字段,租户以鉴权结果为准。 | tenantGuid |
| docIds | int64[] | 是 | 文档 ID 列表,最多 100 个。 | [987654] |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务响应码。200 表示成功;失败时为 RetCode 中定义的业务码。 | 200 |
| msg | string | 响应说明。成功通常为 ok;失败时为错误原因。 | ok |
| message | string | 兼容字段,部分异常场景可能返回错误说明。 | |
| data | object[] | 文档属性列表。 | |
| └docId | int64 | 文档 ID。 | 987654 |
| └metaId | int64 | 属性定义 ID;独立标签汇总记录没有所属属性,因此为空。 | 10001 |
| └metaName | string | 属性名称;独立标签汇总记录固定为“标签”。 | 分类 |
| └metaValue | string | 属性值;文本直接返回,数字返回普通数字字符串,日期返回 epoch millis 字符串。 | 售后 |
| └metaValues | string[] | 文档关联的有效独立标签名称列表。 | ["售后","退款"] |
| └metaType | int32 | 数据类型:1-文本,2-标签,3-数字,4-日期。 | 2 |
错误码
| 状态码 | 描述 |
|---|---|
| 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/docMetaListcurl -X POST "https://b.163.com/api/athena/openApi/external/docMetaList" \ -H "Content-Type: application/json" \ -d '{ "docIds": [ 987654 ] }'{
"code": 200,
"msg": "ok",
"message": "string",
"data": [
{
"docId": 987654,
"metaId": 10001,
"metaName": "分类",
"metaValue": "售后",
"metaValues": [
"售后",
"退款"
],
"metaType": 2
}
]
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}{
"code": 200,
"msg": "ok",
"message": "string"
}这篇文档有帮助吗?