检索 Assistants

GET/v1/assistants/retrieve

您可以通过此项操作检索已创建的 assistant。

请求参数

Query 参数

GroupId

string

必需

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

示例值:

${GroupId}

assistant_id

string

必需

示例值:

${Assistant_Id}

Header 参数

Authorization

string

必需

示例值:

Bearer ${API_KEY}

Content-Type

string

必需

示例值:

application/json

Body 参数text/plain

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

string

必需

object

string

对象

必需

created_at

integer

创建时间

必需

name

string

assistant代称

必需

最大长度为 256 个字符

description

string

assistant描述

必需

model

string

调用的算法模型

必需

可选项： abab5.5 finetune model

instructions

string

assistant的指令

必需

长度上限为16384个字符。具体限制需要根据所选模型调整

tools

array [object {2}]

assistant启用的工具列表

必需

默认[] 列表上限为128个

type

string

工具类型

必需

可选项： code_interpreter retrieval function web_search

function

object

仅当工具类型为function时补充

可选

参数 description str name str parameters object

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

错误详情

必需

{
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1703228868,
  "name": "function",
  "description": "代码机器人",
  "model": "my_model",
  "instructions": "Follow the instructions carefully",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "get_weather",
        "description": "get weather",
        "parameters": {
          "type": "object",
          "required": [
            "city"
          ],
          "properties": {
            "city": {
              "type": "string"
            }
          }
        }
      }
    },
    {
      "type": "web_search"
    },
    {
      "type": "retrieval"
    }
  ],
  "file_ids": [
    "file-abc123",
    "file-abc456"
  ],
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "rolemeta": {},
  "status": "available",
  "base_resp": {
    "status_code": 0,
    "status_msg": "success"
  }
}

最后修改时间： 1 年前