跳转到主要内容
POST
/
chat-messages
Error
A valid request URL is required to generate request examples
{
  "event": "message",
  "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "chat",
  "answer": "<string>",
  "metadata": {
    "usage": {
      "prompt_tokens": 123,
      "prompt_unit_price": "<string>",
      "prompt_price_unit": "<string>",
      "prompt_price": "<string>",
      "completion_tokens": 123,
      "completion_unit_price": "<string>",
      "completion_price_unit": "<string>",
      "completion_price": "<string>",
      "total_tokens": 123,
      "total_price": "<string>",
      "currency": "<string>",
      "latency": 123
    },
    "retriever_resources": [
      {
        "position": 123,
        "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dataset_name": "<string>",
        "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "document_name": "<string>",
        "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "score": 123,
        "content": "<string>"
      }
    ]
  },
  "created_at": 123
}

授权

​
Authorization
string
header
必填

API Key 认证。

请求体

application/json

发送高级对话消息的请求体。

​
query
string
必填

用户输入/问题内容。

​
user
string
必填

用户标识符。注意：Service API 不与 WebApp 共享会话。通过 API 创建的会话与在 WebApp 界面中创建的会话是隔离的。

​
inputs
object

应用变量的键值对。对于文件类型变量，值应为 InputFileObject。

​
response_mode
enum<string>
默认值:streaming

响应模式。Cloudflare 对阻塞模式的超时时间为 100 秒。

可用选项:
streaming,
blocking
​
conversation_id
string

要继续的会话 ID。

​
files
object[]

用于支持视觉功能的模型或通用文件输入的文件列表。

示例:
{
  "type": "image",
  "transfer_method": "remote_url",
  "url": "https://example.com/image.png"
}
​
auto_generate_name
boolean
默认值:true

自动生成会话标题。

响应

成功响应。内容类型和结构取决于 response_mode。

  • blocking：返回 application/json 格式的 ChatCompletionResponse。
  • streaming：返回 text/event-stream 格式的 ChunkAdvancedChatEvent 流。

阻塞模式对话的响应。

​
event
string
示例:

"message"

​
task_id
string<uuid>
​
id
string<uuid>

此响应事件的唯一 ID。

​
message_id
string<uuid>
​
conversation_id
string<uuid>
​
mode
string
示例:

"chat"

​
answer
string
​
metadata
object
​
created_at
integer<int64>