创建助手
POST
https://api.openai.com/v1/assistants创建一个带有模型和说明的助手。
请求参数
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 a personal math tutor. When asked a question, write and run Python code to answer the question.",
"name": "Math Tutor"
"tools": [{"type": "code_interpreter"}],
"model": "gpt-4"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
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": 1698984975,
"name": "Math Tutor",
"description": null,
"model": "gpt-4",
"instructions": "You are a personal math tutor. When asked a question, write and run Python code to answer the question.",
"tools": [
{
"type": "code_interpreter"
}
],
"file_ids": [],
"metadata": {}
}
最后修改时间: 1 年前