CustomGPT
  1. 对话
CustomGPT
  • 快速入门
  • 错误处理
  • 术语
  • 项目
    • 列出所有项目
      GET
    • 创建一个新项目
      POST
    • 展示某个项目
      GET
    • 更新某个项目
      GET
    • 删除某个项目
      DELETE
    • 获取某个项目的统计数据
      GET
  • 页数
    • 列出属于某个项目的所有页面
      GET
    • 删除属于某个项目的某个页面
      DELETE
    • 重新索引属于某个项目的某个页面
      POST
    • 预览引文中的文件
      GET
  • 页面元数据
    • 获取特定页面的元数据
      GET
    • 更新特定页面的元数据
      PUT
  • 项目设置
    • 获取项目设置
      GET
    • 更新项目设置
      POST
  • 项目插件
    • 显示某个项目插件
      GET
    • 创建一个插件
      POST
    • 更新一个插件
      PUT
  • 对话
    • 列出项目的所有对话
      GET
    • 创建一个新对话
      POST
    • 更新一个对话
      PUT
    • 删除对话
      DELETE
    • 检索对话中已发送的消息
      GET
    • 向对话发送消息
      POST
  • 引文
    • 获取 Open Graph 数据以供引用
  • 来源
    • 列出某个项目的来源
    • 创建一个新的项目源
    • 更新项目源设置
    • 删除项目源
  • 用户
    • 显示用户的个人资料
    • 更新用户的个人资料
  1. 对话

向对话发送消息

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
api/v1/projects/{projectId}/conversations/{sessionId}/messages
将消息发送到由其唯一的projectId和sessionId标识的项目内的对话。此端点使您能够向特定对话发送新消息,从而促进项目内的无缝通信和协作。通过提供projectId和sessionId,您可以定位所需的对话并为正在进行的讨论做出贡献。该 API 端点支持实时流,允许即时消息传递和动态更新,从而实现用户和聊天机器人之间的高效交互式通信。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.comapi/v1/projects//conversations//messages?stream=false&lang=en' \
--header 'authorization;' \
--header 'content-type: application/json' \
--data-raw '{
  "response_source": "default"
}'
响应示例响应示例
200 - 成功示例
{
  "status": "success",
  "data": {
    "id": 1,
    "user_id": 1,
    "user_query": "What is the meaning of life?",
    "openai_response": "The meaning of life is to be happy.",
    "created_at": "2021-01-01 00:00:00",
    "updated_at": "2021-01-01 00:00:00",
    "conversation_id": 1,
    "citations": [
      1,
      2,
      3
    ],
    "metadata": {
      "user_ip": "127.0.0.1",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko)",
      "external_id": "ext_id_1234567890",
      "request_source": "web"
    }
  }
}

请求参数

Path 参数
projectId
string 
必需
要获取消息的项目 ID
sessionId
string 
必需
要获取消息的会话的会话 ID
Query 参数
stream
string 
可选
是否流式传输响应,如果流式传输,则响应将在可用时作为仅数据服务器发送的事件发送,并由消息终止流status: "finish"。Python 代码示例。
示例值:
false
lang
string 
可选
提示所使用的语言
示例值:
en
Header 参数
content-type
string 
必需
示例值:
application/json
authorization
string 
必需
Bearer Your_API_KEY
Body 参数application/json
response_source
string 
必需
示例

返回响应

🟢200成功
application/json
Body
status
string 
必需
data
object 
必需
id
integer 
必需
user_id
integer 
必需
user_query
string 
必需
openai_response
string 
必需
created_at
string 
必需
updated_at
string 
必需
conversation_id
integer 
必需
citations
array[integer]
必需
metadata
object 
必需
🟠400请求有误
🟠401没有权限
🟠404记录不存在
🔴500服务器错误
修改于 2024-02-22 05:47:26
上一页
检索对话中已发送的消息
下一页
获取 Open Graph 数据以供引用
Built with