MiniMax
  1. Role Classification (文本角色分类)
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 (文本角色分类)
      • 创建并异步运行角色识别任务
        POST
      • 查询角色识别任务
        GET
    • Role Audio Generation (角色音频生成)
      • 角色音频生成
  1. Role Classification (文本角色分类)

创建并异步运行角色识别任务

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v1/role_recognition/task/async/crun
该接口支持基于自然语言交互生成回复的能力,接口本身为无状态接口,即单次调用时,模型所接收到的信息量仅为接口传入内容,不涉及业务逻辑,同时模型也不存储您传入的数据。
该接口支持基于用户提供的小说文本进行角色以及旁白的拆分

单次请求限制#

限制类型限制内容
模型仅支持abab-recognition
文件字符数不超过30k

三、完整示例#

1、上传文件#

支持上传角色识别任务输入文件,获得该文件的id,即file_id
关于上传文件的其他具体信息可以查看File文档中的Upload接口
请求示例:
import requests

url = 'https://api.minimax.chat/v1/files/upload?GroupId=${group_id}'

headers = {
    'Authorization': 'Bearer ${api_key}'
}

data = {
    'purpose': 'role-recognition'
}

files = {
    'file': open('/Users/minimax/Downloads/95877396765539463.json', 'rb')
}

response = requests.post(url, headers=headers, data=data, files=files)
print(response.text)
返回示例:
{
    "file":
    {
        "file_id": ${file_id},
        "bytes": 6700,
        "created_at": 1702899963,
        "filename": "test1234.json",
        "purpose": "role-recognition"
    },
    "base_resp":
    {
        "status_code": 0,
        "status_msg": "success"
    }
}

2、角色识别#

上传文件后,根据所获得的file_id,创建并异步运行角色识别任务,获得任务id,即task_id
请求示例:
import requests

url = 'https://api.minimax.chat/v1/role_recognition/task/async/crun?GroupId=${group_id}&file_id=87402838655042'

headers = {
    'Authorization': 'Bearer ${api_key}'
}

response = requests.post(url, headers=headers)
print(response.text)
返回示例:
{
    "task":
    {
        "task_id": 87402877308993,
        "status": 2
    },
    "base_resp":
    {
        "status_code": 0,
        "status_msg": "success"
    }
}

3、查询状态#

创建任务成功后,根据所获得的task_id,可以查询角色识别的任务状态
请求:
import requests

url = 'https://api.minimax.chat/v1/role_recognition/task/retrieve?GroupId=${group_id}&task_id=87402877308993'

headers = {
    'Authorization': 'Bearer ${api_key}'
}

response = requests.get(url, headers=headers)
print(response.text)
返回:
{
    "task":
    {
        "task_id": ${task_id},
        "status": 4,
        "file_id": ${file_id},
        "input_token": 3148,
        "output_token": 2843,
        "token": 5991
    },
    "base_resp":
    {
        "status_code": 0,
        "status_msg": "success"
    }
}

4、获取文件#

当角色识别任务完成后,获取最终的结果文件
详细具体情况可以查看File的RetrieveContent接口
请求示例:
import requests
import json

url = "https://api.minimax.chat/v1/files/retrieve_content?GroupId={group_id}&file_id=87402838655043"

headers = {
  'content-type': 'application/json',
  'Authorization': 'Bearer ${api_key}'
}

response = requests.get(url, headers=headers)
print(response.text)
返回:
以文件的形式返回信息
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://dev-cn.your-api-server.com/v1/role_recognition/task/async/crun?GroupId=${group_id}&file_id=${file_id}' \
--header 'Authorization: Bearer ${api_key}'
响应示例响应示例
{
    "task": {
        "task_id": ${task_id},
        "status": 2
    },
    "base_resp": {
        "status_code": 0,
        "status_msg": "success"
    }
}

请求参数

Query 参数
GroupId
string 
用户所属的组
必需
示例值:
${group_id}
file_id
string 
必需
调用文件上传接口获取到的文件id(文件上传时选择的purpose必须为role-recognition)
示例值:
${file_id}
Header 参数
Authorization
string 
必需
示例值:
Bearer ${api_key}

返回响应

🟢200成功
application/json
Body
task
object 
任务信息
必需
当请求出错时,不返回该项
task_id
object 
任务id
必需
status
integer 
任务状态
必需
1-待运行 2-队列中 3-运行中 4-成功 5-失败
base_resp
object 
错误状态码和详情
必需
status_code
integer 
错误码
必需
status_msg
string 
错误详情
必需
上一页
音频复刻
下一页
查询角色识别任务
Built with