创建 Assistant

您可以在此对象下进行对Assistant的操作，包括创建、检索、删除、查看列表等行为。
您可以通过指令选择模型创建一个Assistant。

curl --location -g --request POST 'http://dev-cn.your-api-server.com/v1/assistants/create?GroupId=${GroupId}' \ --header 'Authorization: Bearer ${API_KEY}' \ --header 'Content-Type: application/json' \ --data-raw '{ "model": "my_model", "name": "function", "description": "代码机器人", "instructions": "Follow the instructions carefully", "metadata": { "key1": "value1", "key2": "value2" }, "tools": [ {"type":"code_interpreter"}, {"type":"web_search"} ] }'

{ "id": "asst_abc123", "object": "assistant", "created_at": 1703244578, "name": "function", "description": "代码机器人", "model": "my_model", "instructions": "Follow the instructions carefully\n回答中若参考了函数返回结果中的信息，请在该句末尾用【1†source】【2†source】【3†source】的形式标注信息来源。严禁使用其他的引用格式（如[1],【1】,²等等）。", "tools": [ { "type": "code_interpreter" }, { "type": "web_search" } ], "file_ids": [], "metadata": { "key1": "value1", "key2": "value2" }, "rolemeta": {}, "status": "available", "base_resp": { "status_code": 0, "status_msg": "success" } }

请求参数

Query 参数

GroupId

string

必需

用户所属的组（该值应拼接在调用API的url末尾）

示例值:

${GroupId}

Header 参数

Authorization

string

必需

示例值:

Bearer ${API_KEY}

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

model

string

必需

调用的算法模型（可选项：abab5.5）

name

string

可选

assistant代称（最大长度为 256 个字符）

description

string

可选

assistant描述

instructions

string

可选

assistant的指令（长度上限为16384个字符。具体限制需要根据所选模型调整）

metadata

object

必需

key1

string

必需

key2

string

必需

tools

array [object {1}]

可选

assistant启用的工具列表（默认[] 列表上限为128个）

type

string

可选

工具类型（可选项：

code_interpreter

retrieval

function

web_search）

role_meta

object

对话meta信息

必需

user_name

string

用户代称

必需

bot_name

string

ai代称

必需

示例

返回响应

🟢200成功

application/json

Body

string

必需

assistantID

object

string

对象

必需

created_at

integer

创建时间

必需

name

string

必需

assistant代称（最大长度为 256 个字符）

description

string

必需

assistant描述

model

string

必需

调用的算法模型（可选项：abab5.5）

instructions

string

必需

assistant的指令（长度上限为16384个字符。具体限制需要根据所选模型调整）

tools

array [object {1}]

必需

assistant启用的工具列表（默认[] 列表上限为128个）

type

string

必需

工具类型（可选项：

code_interpreter

retrieval

function

web_search）

file_ids

array[string]

必需

assistant关联的文件（默认[] 最多上传20个）

metadata

object

必需

key1

string

必需

key2

string

必需

rolemeta

object

必需

status

string

必需

assistant状态（available-可用）

base_resp

object

错误状态码和详情

必需

status_code

integer

必需

状态码（1000，未知错误

1001，超时

1002，触发RPM限流

1004，鉴权失败

1008，余额不足

1013，服务内部错误

1027，输出内容错误

1039，触发TPM限流

2013，输入格式信息不正常）

status_msg

string

错误详情

必需