该接口支持基于自然语言交互生成回复的能力，接口本身为无状态接口，即单次调用时，模型所接收到的信息量仅为接口传入内容，不涉及业务逻辑，同时模型也不存储您传入的数据。

该接口支持基于用户提供的小说文本进行角色以及旁白的拆分

单次请求限制

限制类型	限制内容
模型	仅支持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)

以文件的形式返回信息

请求参数

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

错误详情

必需

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

单次请求限制#

三、完整示例#

1、上传文件#

2、角色识别#

3、查询状态#

4、获取文件#

请求参数

返回响应

单次请求限制

三、完整示例

1、上传文件

2、角色识别

3、查询状态

4、获取文件