乐享知识库接口文档 请求URL
GET https://lxapi.lexiangla.com/cgi-bin/v1/kb/entries/{entry_id}/summary
请求头
| 参数 | 是否必须 | 说明 |
|---|---|---|
| Authorization | 是 | 接口调用凭证 access_token 值格式:"Bearer access_token" 示例值:"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJS" |
其他说明
| 事项 | 说明 |
|---|---|
| 权限要求 | AI 助手 |
| 授权范围 | AppKey绑定团队时,入参entry_id知识需在授权的团队下 |
| 频率限制 | 3000次/分钟 |
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| entry_id | 是 | 知识节点 ID |
| lang | 否 | 目标语种代码,最长 20 个字符,可选值见 支持的目标语种。不传时返回原文摘要;传入时的翻译查询生效条件见下方“译文状态说明”。生效后,根据 meta.translation_status 返回当前版本的译文或翻译状态,finished 时返回译文,其他状态不返回原文 |
响应
200 Ok 状态码
{
"data": {
"type": "kb_entry",
"id": "e6b23c8db5d9408dac3c027f22394bef",
"attributes": {
"entry_type": "page",
"summary": "本文介绍腾讯乐享是一站式企业社区平台……",
"summary_status": "success"
}
},
"meta": {
"translation_status": "finished"
}
}
响应字段说明
| 参数 | 说明 |
|---|---|
| data.id | 知识节点 ID |
| data.attributes.entry_type | 节点类型 |
| data.attributes.summary | 知识节点的 AI 摘要正文。翻译查询生效时,finished 返回对应语种译文;untranslated、translating、failed 时为空字符串,不下发原文。翻译查询未生效时按原文摘要查询结果返回;若原文尚未生成或已清空,值为空字符串 |
| data.attributes.summary_status | AI 摘要原文的生成状态:init:初始化;processing:处理中;success:生成成功;failed:生成失败;值为空字符串表示当前节点尚无 AI 摘要生成记录。该字段不是翻译状态 |
| meta.translation_status | 指定语种的翻译状态:finished:译文已就绪;untranslated:从未翻译或原文已变化导致译文过期;translating:翻译中;failed:翻译失败。仅在传入 lang 且翻译查询生效时返回;其他情况不返回 |
译文状态说明
仅当节点为文件型(target_type=kb_file)、能取得当前 revision_id 且存在源摘要时,传入 lang 才会触发翻译查询。非文件型节点或无法取得当前版本时,仍按原文摘要查询结果返回,且不返回 meta.translation_status;无源摘要时也不返回该 meta。
翻译查询生效后,未翻译、译文过期、翻译中和翻译失败均属于正常查询状态,接口返回 HTTP 200 Ok 和 meta.translation_status,不再返回 30021006、30021007、30021010、30021011 业务错误码:
| translation_status | 返回行为与调用建议 |
|---|---|
| finished | data.attributes.summary 返回该语种译文 |
| untranslated | 摘要正文为空;可调用 发起音视频内容翻译 发起翻译 |
| translating | 摘要正文为空;继续轮询,无需重复发起翻译 |
| failed | 摘要正文为空;可重新发起翻译 |
条目不存在、无权限、语种不支持、存储异常等真实错误仍按原错误格式返回。