乐享知识库接口文档 请求URL
GET https://lxapi.lexiangla.com/cgi-bin/v1/kb/entries/{entry_id}/knowledge-points
请求头
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Authorization | 是 | 接口调用凭证 access_token 值格式:"Bearer access_token" 示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS" |
其他说明
| 事项 | 说明 |
|---|---|
| 权限要求 | AI 助手 |
| 授权范围 | AppKey绑定团队时,入参entry_id所属知识需在授权的团队下 |
| 频率限制 | 3000次/分钟 |
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| entry_id | 是 | 知识节点 ID。仅支持音视频类型的知识节点(entry_type=video/audio),其它类型将返回 400 错误 |
| lang | 否 | 目标语种代码,最长 20 个字符,可选值见 支持的目标语种。不传时返回原文知识点;传入时根据 meta.translation_status 返回当前版本的译文或翻译状态。finished 时返回译文,其他状态 data 为空数组,不下发原文 |
响应
200 Ok 状态码
{
"data": [
{
"type": "ai_knowledge_point",
"id": "1001",
"attributes": {
"title": "什么是知识库",
"illustrate": "知识库定义与使用场景介绍……",
"time_point": "15"
}
},
{
"type": "ai_knowledge_point",
"id": "1002",
"attributes": {
"title": "知识库权限体系",
"illustrate": "介绍知识库中的成员权限……",
"time_point": "128"
}
}
],
"meta": {
"translation_status": "finished"
}
}
响应字段说明
| 参数 | 说明 |
|---|---|
| data | 知识点列表,按时间点(time_point)升序返回;无数据时返回空数组。传入 lang 且译文状态不是 finished 时也返回空数组,不下发原文或部分译文 |
| data[].type | 固定值 ai_knowledge_point |
| data[].id | 知识点 ID |
| data[].attributes.title | 知识点标题,传入 lang 且译文状态为 finished 时为对应语种译文 |
| data[].attributes.illustrate | 知识点说明(详细内容),传入 lang 且译文状态为 finished 时为对应语种译文 |
| data[].attributes.time_point | 时间点,字符串类型,单位:秒;译文沿用原文值 |
| meta.translation_status | 指定语种的翻译状态:finished:译文已就绪;untranslated:从未翻译或原文已变化导致译文过期;translating:翻译中;failed:翻译失败。仅传入 lang 且存在源知识点时返回;未传 lang 或无源知识点时不返回 |
译文状态说明
传入 lang 时,未翻译、译文过期、翻译中和翻译失败均属于正常查询状态,接口返回 HTTP 200 Ok、data: [] 和 meta.translation_status,不再返回 30021006、30021007、30021010、30021011 业务错误码:
| translation_status | 返回行为与调用建议 |
|---|---|
| finished | data 返回该语种知识点译文 |
| untranslated | data 为空数组;可调用 发起音视频内容翻译 发起翻译 |
| translating | data 为空数组;继续轮询,无需重复发起翻译 |
| failed | data 为空数组;可重新发起翻译 |
错误响应
条目类型不为音视频时返回 400 Bad Request;条目不存在、无权限、语种不支持、存储异常等真实错误也仍按原错误格式返回:
{
"errors": [
{
"detail": "entry type is not allowed"
}
]
}