MiniMax
  1. ChatCompletion API 文档
MiniMax
  • 公告通知
  • 产品定价
  • 概述
  • FAQ
  • 大模型介绍
    • 文本大模型
    • 语音大模型
  • 接入说明
    • 新手指南
    • 速率说明
  • 开发指南
    • 快速开始
  • 文本大模型接口
    • ChatCompletion Pro(对话)
      • 概述
      • ChatCompletion Pro API 文档
        • ChatCompletion Pro API
        • 示例对话功能
        • 限制返回格式功能(glyph)
        • 函数调用功能(function calling)
        • 插件功能(plugins)
        • 知识库检索功能(retrieval)
    • ChatCompletion(对话)
      • 概述
      • ChatCompletion 快速接入
      • ChatCompletion 调优指南
      • ChatCompletion API 文档
        • ChatCompletion API
          POST
        • 知识库检索功能(retrieval)
          POST
  • Assistants 接口
    • Assistants 操作指南
    • Assistans API 文档
      • Assistant
        • 创建 Assistant
        • 检索 Assistants
        • 删除 assistant
        • 查看 assistant 列表
      • Assistant File
        • 创建 assistant 文件
        • 检索 assistant 关联的文件
        • 列出 assistant 文件
      • Thread
        • 创建 thread
        • 检索 thread
      • Message
        • 创建 message
        • 检索 message
        • message 列表
      • Run
        • 创建 run
        • 检索 run
        • 列表 run
        • Submit tool outputs to run
      • Run Step
        • 检索 run step
        • 列表 run step
  • File(文档)
    • File(文档)
      GET
    • Upload 接口
      GET
    • Retrieve 接口
      GET
    • Delete 接口
      POST
    • RetrieveContent 接口
      GET
  • Retrieval(知识库检索)
    • 新建知识库
    • 删除知识库
    • 查看知识库详情
    • 查看知识库列表
    • 增加知识库文档
    • 删除知识库文档
    • 修改知识库文档
    • 查看知识库文档
    • 检索 Chatcompletion
    • 检索 Chatcompletion pro
  • 微调
    • Finetune 操作指南
    • Finetune API文档
      • 创建微调任务
      • 列出微调任务
      • 检索微调任务
      • 删除微调任务
      • 列出微调事件
      • 列举微调模型
      • 查询微调模型
      • 删除微调模型
  • 向量化
    • Embeddings(向量化)
  • 语音大模型接口
    • T2A (语音生成)
      • T2A 快速接入
      • T2A API 接口
        • T2A API接口
        • 字典功能(Dictionary)
    • T2A pro(长文本语音生成)
      • T2A Pro 快速接入
      • T2A Pro API 接口
      • 字典功能(Dictionary)
    • T2A large(异步超长文本语音生成)
      • T2A Large 快速接入
      • T2A Large API 接口
        • T2A Large API 接口
        • 字典功能(Dictionary)
    • T2A Stream(流式语音生成)
      • T2A Stream(流式语音生成)
      • 字典功能(Dictionary)
    • 快速复刻(Voice Cloning)
      • 上传文件
      • 音频复刻
  • 有声内容创作
    • Role Classification (文本角色分类)
      • 创建并异步运行角色识别任务
      • 查询角色识别任务
    • Role Audio Generation (角色音频生成)
      • 角色音频生成
  1. ChatCompletion API 文档

知识库检索功能(retrieval)

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://api.minimax.chat/v1/text/chatcompletion
为了更好的配合Retrieval接口的使用,我们新增了请求体的参数,以便支持高效检索文档信息,准确回答专业问题,为大模型补充领域知识。
知识库检索相关操作流程如下:
1.
文档上传file,得到file_id:File(文档)
2.
新建知识库时关联上传好的file_id,并得到knowledge_base_id:Retrieval(知识库检索)
3.
调用Chatcompletion或者Chatcompletion pro时配置knowledge_base_id,使用query检索到的knowledge_base_id分片信息回答问题
python示例
import requests
group_id = "请填写您的group_id"
api_key = "请填写您的api_key"
url = f"https://api.minimax.chat/v1/text/chatcompletion?GroupId={group_id}"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
}
payload = {
"model": "abab5-chat",
"prompt": "你是一个擅长发现故事中蕴含道理的专家,你很善于基于我给定的故事发现其中蕴含的道理。",
"role_meta": {
"user_name": "我",
"bot_name": "专家"
},
"messages": [
{
"sender_type": "USER",
"text": "我给定的故事:从前,在森林里有只叫聪聪的小猪,他既勤劳,又乐于助人,小动物们都很喜欢他。有一次,小兔子放风筝不小心将风筝挂在了树上,那是小兔子最喜欢的东西呀!他“呜呜”地哭了起来。这时,正巧聪聪路过。他见了,连忙问:“怎么了? 你怎么哭了呀?”“我,我的风筝被挂在树上了。”小兔子抽噎着说。聪聪听了,不假思索地说:“你先回去吧,放心,我一定帮你。”“真的吗?太好了!”小兔子高兴地回家去了。聪聪尝试了几次,都没能把风筝摘下来,这可把他愁坏了。聪聪想了又想,突然灵机一动,想到一个好办法。他委托小猴弄到风筝线,又找到风筝纸,他要给小兔子重新做一个风筝。风筝做好了,聪聪将它送给了小兔子,小兔子十分感动,聪聪却说:“这是应该的。聪聪的生日到了,可他全心全意地为小动物们解决问题,连自己的生日都忘记了。小动物们商量着,给聪聪过一个生日,可送什么礼物好呢?小动物们思索着。“有了!”小猴子说,“聪聪的愿望就是像一只美丽的蝴蝶,在天空飞翔。我们可以吹一个大大的泡泡,让小猪站在里面,就可以飞了!”“对呀!”“太好了!”动物们高兴极了,七嘴八舌地议论起来。聪聪的生日到了,他忙了一天,推开家门准备休息。可一推开门,小动物就拥了上去:“生日快乐!”聪聪反应过来了,高兴地说:“谢谢,谢谢!”小猴子说:“我们还有礼物给你呢!”说着,几个小动物吹出一个大大的泡泡,罩住聪聪,能飞起来吗? 小动物们屏气凝神地看着。慢慢地,泡泡一点点升起,带着聪聪飞了起来!聪聪激动得热泪盈眶,大声喊着:“我飞起来了!我飞起来了!”泡泡掉了,聪聪却在天上自由地飞翔,聪聪真的变成了一只美丽的蝴蝶!请你仔细阅读我给定的故事,然后给出蕴含的道理,道理控制在100字以内。"
}
],
"knowledge_base_param": {
"knowledge_base_id": ${knowledge_base_id}
}
}
response = requests.post(url, headers=headers, json=payload)
print(response.status_code)
print(response.text)
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api.minimax.chat/v1/text/chatcompletion?GroupId=${group_id}' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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": [
        "plugin_web_search"
    ],
    "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}
    }
}'
响应示例响应示例
{
  "knowledge_base": {
    "knowledge_base_id": 0,
    "chunks": {}
  },
  "chunks": {},
  "content": 0,
  "index": 0,
  "document": "string"
}

请求参数

Query 参数
GroupId
string 
可选
示例值:
${group_id}
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
必需
示例

返回响应

🟢200成功
application/json
Body
knowledge_base
object 
必需
knowledge_base_id
integer 
知识库ID
必需
chunks
object 
片段
必需
chunks
object 
片段
必需
content
integer 
片段内容
必需
index
integer 
片段index
必需
document
string 
片段所属文件ID
必需
上一页
ChatCompletion API
下一页
Assistants 操作指南
Built with