本文为您介绍KnowledgeSummary-总结生成接口,基于输入的知识库内容,通过 LLM大语言模型生成简洁且准确的摘要,适用于需要快速提取关键信息或生成内容摘要的场景。
前提条件
接口信息
请求方法 | 请求协议 | 请求数据格式 |
POST | HTTP | JSON |
请求URL
{host}/v3/openapi/apps/[app_group_identity]/actions/knowledge-summary
{host}
:调用服务的地址,支持通过公网和VPC两种方式调用API服务,可参见获取服务调用地址。{app_group_identity}
:应用名称,需要登录OpenSearch-LLM智能问答版控制台,在实例管理中查看对应实例的应用名称。
请求参数
Header参数
参数 | 类型 | 是否必填 | 描述 | 示例值 |
Content-Type | string | 是 | 请求的数据格式,目前仅支持JSON格式,固定填写"application/json"。 | application/json |
Authorization | string | 是 | 请求鉴权的API Key,Bearer开头。 | Bearer OS-d1**2a |
Body参数
参数 | 类型 | 是否必填 | 描述 | 示例值 |
doc_id | string | 是 | 文档id。 | 06*************b8d2 |
请求体示例
{
"doc_id": "文档id"
}
返回参数
参数 | 类型 | 描述 |
request_id | string | 请求ID。 |
latency | double | 延迟时间。 |
summary | string | 总结内容。 |
code | string | 错误码。 |
message | string | 错误信息。 |
响应体示例
{
"request_id": "abc123-ABC",
"status":"OK",
"latency": 10.0, #单位s
"result": {
"summary": "总结内容"
},
"errors": [
{
"code": "如果有错误,返回错误码",
"message": "如果有错误,这里填错误信息"
}
]
}
该文章对您有帮助吗?