通过 API KEY 进行对话
MaxKB 创建的应用支持通过 OpenAI SDK 格式以及提供系统 SDK 接入,专业版在社区版本基础上提供平台级别的完整 SDK,详细情况见:系统API。
1 标准OpenAI API格式
MaxKB 应用兼容 OpenAI API 格式,在 OpenAI API 原有调用方式的基础上替换为 MaxKB 应用提供的 Base URL 以及 API Key 即可。
图 1 api示例
注意:
-
openai url 的格式为: Base URL/chat/completions
-
openai Authorization 的格式为:Bearer API Key
2 系统 API
2.1 打开 API 文档
在应用【概览】中,点击访问 MaxKB API 地址,在 API Key 中创建 API Key。
图 2 打开 API 文档入口
图 3 打开 API 文档详情
2.2 API Key 认证
点击【Authorize】,输入已创建的 API Key。
图 4 API 认证
2.3 获取会话信息
通过调用 open 接口,可以生成会话 id。
图 5 会话ID
2.4 进行会话
调用对话接口,填入已获取的会话 id,输入问题等参数信息,即可进行对话。
图 6 调用对话接口
图 7 对话请求响应示例
