OpenAI(ChatGPT)
  1. 助手测试版(AssistantsBeta)
OpenAI(ChatGPT)
  • 介绍
  • 项目说明
  • 导言
  • 身份验证
  • 发出请求
  • 参数详情
  • 音频(Audio)
    • 创建语音
      POST
    • 创建转录
      POST
    • 创建翻译
      POST
  • 聊天(Chat)
    • Chat Completions 对象
    • Chat Completions 对象块
    • 创建 Chat Completions
      POST
  • 自动补全(Completions)
    • Completions 对象
    • 创建 Completions
      POST
  • 嵌入(Embeddings)
    • 嵌入对象
    • 创建嵌入
      POST
  • 微调(Fine-tuning)
    • 微调作业对象
    • 微调作业事件对象
    • 创建微调作业
    • 列出微调作业
    • 检索微调作业
    • 取消微调
    • 列出微调事件
  • 文件(Files)
    • README
    • 文件对象
    • 列出文件
    • 上传文件
    • 删除文件
    • 检索文件
    • 检索文件内容
  • 图像(Images)
    • README
    • 图像对象
    • 创建图像
    • 创建图片编辑
    • 创建图像变体
  • 模型(Models)
    • 模型对象
    • 列出模型
    • 检索模型
    • 删除微调模型
  • 审查(Moderations)
    • 调节对象
    • 创建内容审核
  • 助手测试版(AssistantsBeta)
    • 辅助对象
    • 辅助文件对象
    • 创建助手
      POST
    • 检索助手
      GET
    • 修改助手
      POST
    • 删除助手
      DELETE
    • 列出助手
      GET
    • 创建辅助文件
      POST
    • 检索助手文件
      GET
    • 删除辅助文件
      DELETE
    • 列出助手文件
      GET
  • 线程数(Threads)
    • 线程对象
    • 创建线程
    • 检索线程
    • 修改线程
    • 删除话题
  • 留言(Messages)
    • 消息对象
    • 消息文件对象
    • 创建消息
    • 检索消息
    • 修改留言
    • 列出消息
    • 检索消息文件
    • 列出消息文件
  • 运行(Runs)
    • 运行对象
    • 运行步骤对象
    • 创建运行
    • 检索运行
    • 修改运行
    • 列表运行
    • 提交工具输出以运行
    • 取消运行
    • 创建线程并运行
    • 检索运行步骤
    • 列出运行步骤
  • 已弃用-音频(Audio)
    • 创建转录
    • 创建翻译
  1. 助手测试版(AssistantsBeta)

修改助手

POST
https://api.openai.com/v1/assistants/{assistant_id }
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/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"]
    }'
响应示例响应示例
{
  "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": {}
}

请求参数

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 个字符。
示例

返回响应

🟢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 
必需

扫码加入 Open AI(ChatGPT)微信交流群

欢迎加入 Open AI(ChatGPT) 交流群!让大家可以分享和讨论有关 Open AI(ChatGPT)API 的开发和使用等相关话题。

扫码加入交流群
修改于 2023-11-09 10:33:10
上一页
检索助手
下一页
删除助手
Built with