Ecovai

聊天接口

POST

https://api.ecovai.cn/v1/chat/completions

本接口与模型公司的接口保持一致，当模型公司变更调用参数时，本接口也会跟随变更。
启动流式输出，需要本地代码做响应承接处理。

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

Content-Type

string

必需

示例值:

application/json

string

必需

示例值:

application/json

Authorization

string

可选

示例值:

Bearer {{YOUR_API_KEY}}

Body 参数application/json

model

enum<string>

讯飞模型名称

必需

枚举值:

spark-v2spark-v3

messages

array [object {2}]

对话消息列表

必需

role

enum<string>

消息角色

必需

枚举值:

systemuserassistant

content

string

消息内容

必需

temperature

number

可选

温度参数，控制输出的随机性

>= 0<= 1

默认值:

0.7

top_k

integer

可选

从概率分布中采样的候选集大小

>= 1

max_tokens

integer

可选

生成的最大token数量

>= 1

stream

boolean

是否启用流式输出

可选

默认值:

false

示例

{
  "model": "SparkDesk-v4.0",
  "messages": [
    {
      "role": "system",
      "content": "你是一个有帮助的助手"
    },
    {
      "role": "user",
      "content": "你好，请介绍一下你自己"
    }
  ],
  "temperature": 0.7,
  "top_k": 4,
  "max_tokens": 2048,
  "stream": false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ecovai.cn/v1/chat/completions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "SparkDesk-v4.0",
    "messages": [
        {
            "role": "system",
            "content": "你是一个有帮助的助手"
        },
        {
            "role": "user",
            "content": "你好，请介绍一下你自己"
        }
    ],
    "temperature": 0.7,
    "top_k": 4,
    "max_tokens": 2048,
    "stream": false
}'

返回响应

🟢200OK

application/json

Body

string

必需

model

string

必需

object

string

必需

created

integer

必需

choices

array [object {3}]

必需

index

integer

可选

message

object

可选

finish_reason

string

可选

usage

object

必需

prompt_tokens

integer

必需

completion_tokens

integer

必需

total_tokens

integer

必需

示例

{
  "id": "",
  "model": "",
  "object": "chat.completion",
  "created": 1730952862,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "您好，我是科大讯飞研发的认知智能大模型，我的名字叫讯飞星火认知大模型。我可以和人类进行自然交流，解答问题，高效完成各领域认知智能需求。"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 11,
    "completion_tokens": 40,
    "total_tokens": 51
  }
}

修改于 2024-11-07 04:13:43

聊天接口