流响应

开发环境

http://dev-cn.your-api-server.com

POST

/v1/chat/completions

也称为实时模式，JinaChat API 的流式传输功能在生成每个响应时立即将其发送给用户，非常适合需要快速和持续回复的场景。这种模式提供了无缝和即时的对话体验。要建立流连接，请确保在请求中将“接受”标头设置为“文本/事件流”，以向服务器发出所需响应类型的信号。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v1/chat/completions' \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "messages": [
      {
        "role": "user",
        "content": "Tell me a good joke about dog"
      }
    ],
    "stream": true
  }'

响应示例

{}

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization

string

必需

示例值:

Bearer $API_KEY

Body 参数application/json

messages

array [object {2}]

必需

到目前为止描述对话的消息列表。

role

string

可选

此消息作者的角色。允许值: user assistant

content

string

消息的内容。

可选

stream

boolean

必需

是否回流部分进度。如果设置，词元将在可用时作为纯数据服务器发送事件发送，流由数据终止：[DONE] 消息。

示例

返回响应

🟢200成功

application/json

Body

object {0}

修改于 2023-12-13 07:42:34

API 访问