资讯 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

Thread

本文档描述 Assistants API 中 与 Thread 相关的接口。

Thread对象

参数名称 类型 是否必须 备注
messages array[Message] 本次对话追加的messages
metadata map<string, string> 一组可以附加到对象的16个键值对。这对于以结构化格式存储关于对象的附加信息非常有用。键的长度最多为64个字符,值的长度最多可为512个字符

1. 创建Thread

功能介绍

创建Thread,返回对应的thread_id

请求说明

基本信息

请求地址:https://appbuilder.baidu.com/v2/threads

请求方式:POST

请求参数

请参考 公共类型定义中,公共请求头的定义

Body

请参考Thread 对象的定义

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/threads' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "messages": [
        {
            "role": "user",
            "content": "地球是圆的吗?"
        }
    ]
}'

响应说明

响应参数

Header

请参考 公共类型定义中,公共响应头的定义

Body
参数 类型 描述
id string Thread ID, 创建的Thread对象的id
object string 结构类型,值固定为 thread.message
created_at integer 创建的时间戳
metadata map<string, string> metadata的内容

响应示例

{
    "id": "thread_aab1710f13f1496d9fe29c03ca4e4d3e",
    "object": "thread.message",
    "created_at": 1708660019145,
    "metadata": {}
}

2. 查询Thread

功能介绍

根据thread_id查询Thread对象的信息

请求说明

基本信息

请求地址:https://appbuilder.baidu.com/v2/threads/query

请求方式:POST

请求参数

Header

请参考 公共类型定义中,公共请求头的定义

Body
参数 语义 是否必填 取值/类型 备注
thread_id Thread对象的id string

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/threads/query' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "thread_id": "thread_aab1710f13f1496d9fe29c03ca4e4d3e"
}'

响应说明

响应参数

Header

请参考 公共类型定义中,公共响应头的定义

Body
参数 类型 描述
id string Thread ID, 创建的Thread对象的id
object string 结构类型,值固定为 thread.message
created_at integer 创建的时间戳
metadata map<string, string> metadata的内容

响应示例

{
    "id": "thread_aab1710f13f1496d9fe29c03ca4e4d3e",
    "object": "thread.message",
    "created_at": 1708660019145,
    "metadata": {}
}

3. 删除Thread

功能介绍

根据thread_id删除Thread对象

请求说明

基本信息

请求地址:https://appbuilder.baidu.com/v2/threads/delete

请求方式:POST

请求参数

Header

请参考 公共类型定义中,公共请求头的定义

Body
参数 语义 是否必填 取值/类型 备注
thread_id Thread对象的id string

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/threads/delete' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "thread_id": "thread_aab1710f13f1496d9fe29c03ca4e4d3e"
}'

响应说明

响应参数

Header

请参考 公共类型定义中,公共响应头的定义

Body
参数 类型 描述
id string Thread对象的id
object string 结构类型,值固定为 thread.deleted
deleted bool 是否删除成功

响应示例

{
    "id": "thread_aab1710f13f1496d9fe29c03ca4e4d3e",
    "object": "thread.deleted",
    "deleted": true
}

4. 修改Thread

功能介绍

根据thread_id,对thread进行修改。

当前Thread 仅可以修改metadata字段

请求说明

基本信息

请求地址:https://appbuilder.baidu.com/v2/threads/update

请求方式:POST

请求参数

Header

请参考 公共类型定义中,公共请求头的定义

Body
参数 语义 是否必填 取值/类型 备注
thread_id Thread对象的id string
metadata metadata字典 map<string, string> 一组可以附加到对象的16个键值对。这对于以结构化格式存储关于对象的附加信息非常有用。键的长度最多为64个字符,值的长度最多可为512个字符

请求示例

curl -X POST 'https://appbuilder.baidu.com/v2/threads/update' \
-H "Authorization: Bearer $APPBUILDER_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "thread_id": "thread_aab1710f13f1496d9fe29c03ca4e4d3e",
    "metadata": {"key": "value"}
}'

响应说明

响应参数

Header

请参考 公共类型定义中,公共响应头的定义

Body
参数 类型 描述
id string Thread对象的id
object string 结构类型,值固定为 thread
created_at integer 创建时间戳
metadata map<string, string> 本次更新的metadata内容

响应示例

{
    "id": "thread_76fdc609a5fa4bb0b54c1ad2a19dac13",
    "object": "thread",
    "metadata": {
        "key": "value"
    },
    "created_at": 1713768559642
}