创建 message

POST/v1/threads/messages/add

您可以在此object下进行对message的操作，包括创建、检索、列出列表等行为，object如下：

参数	类型	含义
id	string	messageid
object	string	对象：message
created_at	int64	创建时间戳
thread_id	string	threadid
role	string	发送者
content	list	message内容
file_ids	list	对话需要参考的文件
assistant_id	string	assistantid
run_id	string	运行实体id
metadata	map<string,string>	元信息

Content数据结构

参数	类型	含义
type	string	类型
text	TextContent	文本内容
image_file	ImageFile	图像文件

TextContent数据结构

参数	类型	含义
value	string	message文本内容
annotations	list	message引文列表

ImageFile数据结构

参数	类型	含义
file_id	string	文件id

Annotation数据结构

参数	类型	含义
type	string	类型
text	string	引用的文字内容
start_index	int64	引用文字在message中的起始位置
end_index	int64	引用文字在message中的终止位置
file_citation	FileCitation	assistant message中的引用，当assistant使用检索工具时生成。用于指向与assistant的message相关联的文件片段
web_citation	WebCitation	assistant message中的引用，当assistant使用网页搜索时生成。用于指向与assistant的message相关联的网页信息

FileCitation 检索工具注释

参数	类型	含义
file_id	string	文件ID
quote	string	引用

WebCitation 网页搜索工具注释

参数	类型	含义
url	string	网址
quote	string	引用

您可以通过此项操作创建一个message。

请求参数

Query 参数

GroupId

string

必需

示例值:

${GroupId}

Header 参数

Authorization

string

必需

示例值:

Bearer ${API_KEY}

Content-Type

string

必需

示例值:

application/json

thread_id

string

必需

role

string

必需

content

string

必需

metadata

object

可选

key1

string

必需

key2

string

必需

{
  "thread_id": "$Thread_Id",
  "role": "user",
  "content": "用python写一个贪吃蛇小游戏",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

string

messageid

必需

object

string

必需

对象：message

created_at

integer

创建时间戳

必需

thread_id

string

threadid

必需

role

string

发送者

必需

content

array [object {2}]

message内容

必需

type

string

类型

可选

text

object

文本内容

可选

file_ids

null

对话需要参考的文件

必需

assistant_id

string

必需

assistantid

run_id

string

运行实体id

必需

metadata

object

元信息

必需

key1

string

必需

key2

string

必需

base_resp

object

必需

status_code

integer

必需

status_msg

string

必需

{
  "id": "msg_abc123",
  "object": "message",
  "created_at": 1703245281,
  "thread_id": "thread_abc123",
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "用python写一个贪吃蛇小游戏",
        "annotations": []
      }
    }
  ],
  "file_ids": null,
  "assistant_id": "",
  "run_id": "",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "base_resp": {
    "status_code": 0,
    "status_msg": "success"
  }
}

最后修改时间： 10 个月前