知识库检索功能(retrieval)
POST
https://api.minimax.chat/v1/text/chatcompletion_pro为了更好的配合Retrieval接口的使用,我们新增了请求体的参数,以便支持高效检索文档信息,准确回答专业问题,为大模型补充领域知识。
知识库检索相关操作流程如下:
- 文档上传file,得到file_id:File(文档)
- 新建知识库时关联上传好的file_id,并得到knowledge_base_id:Retrieval(知识库检索)
- 调用Chatcompletion或者Chatcompletion pro时配置knowledge_base_id,使用query检索到的knowledge_base_id分片信息回答问题
python示例
import requests
group_id="请填写您的group_id"
api_key="请填写您的api_key"
url = "https://api.minimax.chat/v1/text/chatcompletion_pro?GroupId=" + group_id
payload = {
"bot_setting": [
{
"bot_name": "MM智能助理",
"content": "MM智能助理是一款由MiniMax自研的,没有调用其他产品的接口的大型语言模型。MiniMax是一家中国科技公司,一直致力于进行大模型相关的研究。",
}
],
"messages": [{"sender_type": "USER", "sender_name": "小明", "text": "帮我用英文翻译下面这句话:我是谁"}],
"reply_constraints": {"sender_type": "BOT", "sender_name": "MM智能助理"},
"model": "abab5.5-chat",
"tokens_to_generate": 1034,
"temperature": 0.01,
"top_p": 0.95,
"knowledge_base_param": {
"knowledge_base_id": ${knowledge_base_id}
}
}
headers = {"Content-Type": "application/json", "Authorization": "Bearer " + api_key}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.status_code)
print(response.text)
请求参数
Header 参数
Authorization
string
可选
Content-Type
string
可选
Body 参数application/json
model
string
必需
tokens_to_generate
integer
必需
temperature
number
必需
top_p
number
必需
stream
boolean
必需
beam_width
integer
必需
reply_constraints
object
必需
sender_type
string
必需
sender_name
string
必需
sample_messages
array[string]
必需
plugins
array[string]
必需
messages
array [object {3}]
必需
sender_type
string
可选
sender_name
string
可选
text
string
可选
bot_setting
array [object {2}]
必需
bot_name
string
可选
content
string
可选
knowledge_base_param
object
知识库参数
knowledge_base_id
object
知识库ID
示例
{
"model": "abab5.5-chat",
"tokens_to_generate": 1024,
"temperature": 0.9,
"top_p": 0.95,
"stream": false,
"beam_width": 1,
"reply_constraints": {
"sender_type": "BOT",
"sender_name": "MM智能助理"
},
"sample_messages": [],
"plugins": [],
"messages": [
{
"sender_type": "USER",
"sender_name": "用户",
"text": "齐天是谁"
}
],
"bot_setting": [
{
"bot_name": "MM智能助理",
"content": "MM智能助理是一款由MiniMax自研的,没有调用其他产品的接口的大型语言模型。MiniMax是一家中国科技公司,一直致力于进行大模型相关的研究。"
}
],
"knowledge_base_param": {
"knowledge_base_id": ${knowledge_base_id}
}
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
knowledge_base
object
必需
knowledge_base_id
object
知识库ID
chunks
object
片段
chunks
object
必需
content
integer
必需
index
integer
必需
document
string
必需
示例
{
"knowledge_base": {
"knowledge_base_id": {},
"chunks": {}
},
"chunks": {},
"content": 0,
"index": 0,
"document": "string"
}
最后修改时间: 1 年前