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

检索 Chatcompletion

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v1/text/chatcompletion
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://dev-cn.your-api-server.com/v1/text/chatcompletion?GroupId=${group_id}' \
--header 'authorization: Bearer ${api_key}' \
--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": 864543113566273536
    }
}'
响应示例响应示例
{
  "knowledge_base": {
    "knowledge_base_id": "string",
    "chunks": {}
  },
  "chunks": {},
  "content": 0,
  "index": 0,
  "document": "string"
}

请求参数

Query 参数
GroupId
string 
必需
示例值:
${group_id}
Header 参数
authorization
string 
必需
示例值:
Bearer ${api_key}
content-type
string 
必需
示例值:
application/json
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
integer 
知识库ID
必需
示例

返回响应

🟢200成功
application/json
Body
knowledge_base
object 
必需
knowledge_base_id
string 
知识库ID
必需
chunks
object 
片段
必需
chunks
object 
片段
必需
content
integer 
片段内容
必需
index
integer 
片段index
必需
document
string 
片段所属文件ID
必需
上一页
查看知识库文档
下一页
检索 Chatcompletion pro
Built with