MiniMax
  1. ChatCompletion Pro API 文档
MiniMax
  • 公告通知
  • 产品定价
  • 概述
  • FAQ
  • 大模型介绍
    • 文本大模型
    • 语音大模型
  • 接入说明
    • 新手指南
    • 速率说明
  • 开发指南
    • 快速开始
  • 文本大模型接口
    • ChatCompletion Pro(对话)
      • 概述
      • ChatCompletion Pro API 文档
        • ChatCompletion Pro API
          POST
        • 示例对话功能
          POST
        • 限制返回格式功能(glyph)
          POST
        • 函数调用功能(function calling)
          POST
        • 插件功能(plugins)
          POST
        • 知识库检索功能(retrieval)
          POST
    • ChatCompletion(对话)
      • 概述
      • ChatCompletion 快速接入
      • ChatCompletion 调优指南
      • ChatCompletion API 文档
        • ChatCompletion API
        • 知识库检索功能(retrieval)
  • 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 Pro API 文档

示例对话功能

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
https://api.minimax.chat/v1/text/chatcompletion_pro

4、高阶功能说明#

4.1 功能兼容性#

流式返回示例对话功能限制返回格式功能函数调用内置插件
流式返回
示例对话功能兼容
限制返回格式功能不兼容兼容
函数调用兼容兼容不兼容
内置插件兼容兼容不兼容兼容

4.2 示例对话功能#

4.2.1 功能说明#

该功能可以帮助模型更好地理解用户想要获得的返回信息,包括但不限于信息内容,信息格式,信息回复方式等。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.minimax.chat/v1/text/chatcompletion_pro' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bot_setting": [ 
        {
            "bot_name": "MM智能助理",
            "content": "MM智能助理是一款由MiniMax自研的,没有调用其他产品的接口的大型语言模型。MiniMax是一家中国科技公司,一直致力于进行大模型相关的研究。"
        }
    ],
    "sample_messages": [
        {
            "sender_type": "USER",
            "sender_name": "小明",
            "text": "把A5处理成红色,并修改内容为minimax"
        },
        {
            "sender_type": "BOT",
            "sender_name": "MM智能助理",
            "text": "select A5 color red change minimax"
        }
    ],
    "messages": [ 
        {
            "sender_type": "USER",
            "sender_name": "小明",
            "text": "你会按照如下要求回复我的内容:需要根据以下接口列表,对我给定的内容给出调用接口的顺序和参数。你只需要给出接口的调用顺序和参数,除此之外不要给出任何其他的输出。以下是可用的接口列表:select: 选择具体的表格位置,输入参数使用字母和数字确定,例如B13”;color: 对选定的表格位置染色,输入参数使用颜色的英文名,例如“red”;change: 对选定的表格位置进行修改,输入参数使用字符串。"
        },
        {
    "sender_type": "USER",
    "sender_name": "小明",
    "text": "把B6处理成灰色,修改内容为question"
        }
    ],
    "reply_constraints": { 
        "sender_type": "BOT",
        "sender_name": "MM智能助理"
    },
    "model": "abab5.5-chat", 
    "tokens_to_generate": 1034,
    "temperature": 0.01,
    "top_p": 0.95
}'
响应示例响应示例
{
  "created": 1689748777,
  "model": "abab5.5-chat",
  "reply": "select B6 color gray change question",
  "choices": [
    {
      "finish_reason": "stop",
      "messages": [
        {
          "sender_type": "BOT",
          "sender_name": "MM智能助理",
          "text": "select B6 color gray change question"
        }
      ]
    }
  ],
  "usage": {
    "total_tokens": 530
  },
  "input_sensitive": false,
  "output_sensitive": false,
  "id": "0106b828064f165bc3537a019b35640e",
  "base_resp": {
    "status_code": 0,
    "status_msg": ""
  }
}

请求参数

Header 参数
Authorization
string 
给到的 API密钥
可选
Content-Type
string 
可选
Body 参数application/json
bot_setting
array [object {2}] 
必需
bot_name
string 
可选
content
string 
可选
sample_messages
array [object {3}] 
示例对话内容
可选
sender_type
string 
发送者的类型
必需
sender_name
string 
发送者的名字
必需
text
string 
消息内容
必需
messages
array [object {3}] 
必需
sender_type
string 
必需
sender_name
string 
必需
text
string 
必需
reply_constraints
object 
必需
sender_type
string 
必需
sender_name
string 
必需
model
string 
必需
tokens_to_generate
integer 
必需
temperature
number 
必需
top_p
number 
必需
示例

返回响应

🟢200成功
application/json
Body
created
integer 
请求发起时间
必需
model
string 
请求指定的模型名称
必需
reply
string 
回复内容
必需
choices
array [object {2}] 
所有结果
必需
finish_reason
string 
可选
结束原因,枚举值 stop:接口返回了模型生成完整结果 length:模型生成结果超过配置的tokens_to_generate长度,内容被截断 max_output:输入+模型输出内容超过模型最大能力限制
messages
array [object {3}] 
回复结果的具体内容
可选
usage
object 
必需
tokens数使用情况(流式场景下,增量数据包不含该字段;全量(最后一个)数据包含有该字段)
total_tokens
integer 
必需
消耗tokens总数,包括输入和输出(模型以token为基本单位来理解输入和输出)
input_sensitive
boolean 
输入命中敏感词
必需
output_sensitive
boolean 
输出命中敏感词
必需
id
string 
必需
本次请求的唯一标识,用于排查问题
base_resp
object 
错误状态码和详情
必需
status_code
integer 
必需
状态码(1000,未知错误 1001,超时 1002,触发RPM限流 1004,鉴权失败 1008,余额不足 1013,服务内部错误 1027,输出内容错误 1039,触发TPM限流 2013,输入格式信息不正常)
status_msg
string 
错误详情
必需
上一页
ChatCompletion Pro API
下一页
限制返回格式功能(glyph)
Built with