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

创建消息

POST
https://api.openai.com/v1/threads/{thread_id}/messages
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/v1/threads//messages' \
--header 'Content-Type: application/json' \
--data-raw '{
      "role": "user",
      "content": "How does AI work? Explain it in simple terms."
    }'
响应示例响应示例
{
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1699017614,
  "thread_id": "thread_abc123",
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "How does AI work? Explain it in simple terms.",
        "annotations": []
      }
    }
  ],
  "file_ids": [],
  "assistant_id": null,
  "run_id": null,
  "metadata": {}
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
thread_id
string 
必需
要为其创建消息的线程的 ID 。
Body 参数application/json
role
string 
必需
创建消息的实体的角色。目前仅user支持。
content
string 
消息的内容。
必需
file_ids
array[string]
可选
消息应使用的文件ID列表。一条消息最多可以附加 10 个文件。retrieval对于code_interpreter可以访问和使用文件的工具非常有用。
metadata
object 
可选
一组可附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息非常有用。键的最大长度为 64 个字符,值的最大长度为 512 个字符。
示例

返回响应

🟢200成功
application/json
Body
id
string 
必需
标识符,可以在 API 端点中引用。
object
string 
必需
对象类型,始终为thread.message。
created_at
integer 
必需
创建消息时的 Unix 时间戳(以秒为单位)。
thread_id
string 
必需
该消息所属的线程ID 。
role
string 
必需
产生消息的实体。user或之一assistant。
content
array [object {2}] 
必需
文本和/或图像数组中的消息内容。
type
string 
可选
总是image_file。
text
object 
可选
作为消息一部分的文本内容。
file_ids
array[string]
必需
助手应使用的文件ID列表。对于可访问文件的检索和 code_interpreter 等工具很有用。一条消息最多可以附加 10 个文件。
assistant_id
null 
必需
如果适用,则为创作此消息的助理的 ID 。
run_id
null 
必需
如果适用,与此消息的创作关联的运行的 ID 。
metadata
object 
必需
一组可附加到对象的 16 个键值对。这对于以结构化格式存储有关对象的附加信息非常有用。键的最大长度为 64 个字符,值的最大长度为 512 个字符。

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

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

扫码加入交流群
修改于 2023-11-09 10:34:05
上一页
消息文件对象
下一页
检索消息
Built with