修改助手 - Oapi接口文档

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

assistant_id

string

必需

需要修改的助手ID。

Body 参数application/json

model

string

可选

要使用的模型的 ID。您可以使用列表模型API 查看所有可用模型，或查看我们的模型概述以获取它们的描述。

name

string

可选

助理的名字。最大长度为 256 个字符。

description

string

可选

助理的描述。最大长度为 512 个字符。

instructions

string

可选

助手使用的系统指令。最大长度为 32768 个字符。

tools

array [object {1}]

可选

助手上启用的工具列表。每个助手最多可以有 128 个工具。工具的类型可以是code_interpreter、retrieval、或function。

type

string

可选

正在定义的工具类型：code_interpreter

file_ids

array[string]

可选

附加到该助手的文件ID列表。助手最多可以附加 20 个文件。文件按其创建日期升序排列。如果某个文件之前已附加到列表但未显示在列表中，则该文件将从助手中删除。

metadata

object

可选

一组可附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息非常有用。键的最大长度为 64 个字符，值的最大长度为 512 个字符。

示例

{
      "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
      "tools": [{"type": "retrieval"}],
      "model": "gpt-4",
      "file_ids": ["file-abc123", "file-abc456"]
    }

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://oapi.czl.net/v1/assistants/' \
--header 'Content-Type: application/json' \
--data-raw '{
      "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
      "tools": [{"type": "retrieval"}],
      "model": "gpt-4",
      "file_ids": ["file-abc123", "file-abc456"]
    }'

返回响应

🟢200成功

application/json

Body

id

string

必需

object

string

必需

created_at

integer

必需

name

string

必需

description

null

必需

model

string

必需

instructions

string

必需

tools

array [object {1}]

必需

type

string

可选

file_ids

array[string]

必需

metadata

object

必需

示例

{
  "id": "asst_abc123",
  "object": "assistant",
  "created_at": 1699009709,
  "name": "HR Helper",
  "description": null,
  "model": "gpt-4",
  "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
  "tools": [
    {
      "type": "retrieval"
    }
  ],
  "file_ids": [
    "file-abc123",
    "file-abc456"
  ],
  "metadata": {}
}