聊天接口 /v1/chat/completions

OpenAI 对话模型接口，兼容文心一言(ernie-bot,ernie-bot-4,ernie-turbo)，讯飞星火(spark-v1.5，spark-v2.0，spark-v3.0)

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

model

enum<string> <string>

模型

必需

枚举值:

gpt-4gpt-4-0314gpt-3.5-turbogpt-3.5-turbo-0301gpt-3.5-turbo-16kgpt-3.5-turbo-16k-0613gpt-4-0613ernie-boternie-bot-turbospark-v1.5spark-v2.0gpt-4-32kernie-bot-4gpt-3.5-turbo-0613spark-v3.0gpt-3.5-turbo-1106gpt-4-1106-previewclaude-2claude-instant-1

messages

array[object (aigc2d.openai.ChatCompletionMessage) {4}]

消息

必需

role

string <string>

可选

消息作者的角色。 system 、 user 、 assistant 或 function 之一。

content

string <string>

可选

消息的内容。除具有函数调用的助手消息外，所有消息都需要 content 。

name

string <string>

可选

此消息的作者的姓名。如果角色为 function ，则 name 是必需的，它应该是响应在 content 中的函数的名称。可以包含 a-z、A-Z、0-9 和下划线，最大长度为 64 个字符。

function_call

object (aigc2d.openai.ChatCompletion.FunctionCall)

可选

应调用的函数的名称和参数，由模型生成。

max_tokens

integer

可选

最大的 tokens, 如果不指定默认是按最大的来，gpt-3.5-turbo 最大是 4k tokens, gpt-3.5-turbo-16k 是 16k tokens，gpt-4 是 8k tokens 。请求时会根据这个冻结Point点数

temperature

number <float32>

可选

使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使其更加集中和确定。

top_p

number <float32>

可选

使用温度采样的替代方法称为核心采样，其中模型考虑具有top_p概率质量的令牌的结果。因此，0.1 意味着只考虑包含前 10% 概率质量的代币。

integer

返回结果的条数

可选

stream

boolean

可选

是否流数据返回，为true则已 sse 流返回数据，sse 请查看：https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event_stream_format

stop

array[string <string>]

可选

最多 4 个序列，其中 API 将停止生成更多令牌。

presence_penalty

number <float32>

可选

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止是否出现在文本中来惩罚它们，从而增加模型讨论新主题的可能性。

frequency_penalty

number <float32>

可选

介于 -2.0 和 2.0 之间的数字。正值会根据新标记到目前为止在文本中的现有频率来惩罚新标记，从而降低模型逐字重复同一行的可能性。

logit_bias

object

可选

修改完成中出现指定令牌的可能性。

额外字段

integer

可选

user

string <string>

可选

代表最终用户的唯一标识符，可帮助 OpenAI 监控和检测滥用行为。了解更多信息。

functions

array[object (aigc2d.openai.ChatCompletion.FunctionDefine) {3}]

可选

模型可能为其生成 JSON 输入的函数列表。

name

string <string>

可选

description

string <string>

可选

parameters

object (aigc2d.openai.ChatCompletion.FunctionParams)

可选

function_call

string <string>

可选

控制模型如何响应函数调用。“none”表示模型不调用函数，并响应最终用户。“auto”表示模型可以在最终用户或调用函数之间进行选择。通过 {"name":\ "my_function"} 指定特定函数会强制模型调用该函数。“none”是不存在函数时的默认值。如果存在函数，则“auto”是默认值。

示例

{
  "model": "ernie-bot",
  "messages": [
    {
      "role": "user",
      "content": "你好,你会干什么呢"
    }
  ],
  "max_tokens": 1000,
  "stream": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

string

必需

object

string

必需

created

integer

必需

choices

array [object {3}]

必需

index

integer

可选

message

object

消息

可选

finish_reason

string

可选

usage

object

消耗

必需

prompt_tokens

integer

输入 tokens

必需

completion_tokens

integer

响应 tokens

必需

total_tokens

integer

必需

总消耗 tokens, prompt+completion

示例

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?",
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

🟠400请求有误