对话生成 JSON回复模式

POSThttps://yewu.bcwhkj.cn/api/v2.Gptliu/search

冰橙API提供与OPENAI官方的API兼容的接口方式，方便国内开发者进行与OPENAI的CHATGPT的接口对接服务

:::highlight purple 💡
此方法可强制规定返回内容必须符合json类型，这样可更有效的生成符合更为预期的数据结果，来实现与现有系统软件的有效结合
:::

启用限定Json格式的回复，必须注意两点，一个是提交的Messages里必须包含json示例，以及必须设定max_tokens。
若不设定max_tokens，则模型可能会生成无休止的空格流，并且请求可能会持续运行，直到达到令牌限制。
JSON 模式不保证输出与任何特定架构匹配，只保证它是有效的并且解析没有错误。
当前只有新版模型支持此模式：gpt-4o、gpt-4-turbo、gpt-3.5-turbo
如果模型返回的消息中的 JSON 可能是部分的（即截断），这表示超出了生成次数或会话超出了令牌限制。若要防止这种情况，请在分析响应之前进行检查。finish_reasonlength、max_tokens、finish_reason 这三项值是否对应匹配完整度

token获取方式：

访问公众号《冰橙云》进入菜单冰橙AI助手后，访问右上角 / API密钥可查看 token
访问：https://yewu.bcwhkj.cn 》个人》API密钥》Token令牌

请求参数

messages

array [object {2}]

必需

role

string

可选

content

string

可选

model

enum<string>

模型名

必需

枚举值:

gpt-4ogpt-3.5-turbo

response_format

object

返回格式，固定值

必需

type

string

必需

max_tokens

integer

返回令牌限制数

必需

{
  "messages": [
    {
      "role": "user",
      "content": "三国里哪个武将的武力值最高，是多少?json:{武将:武将名;武力值:数字}"
    }
  ],
  "model": "gpt-3.5-turbo",
  "response_format": {
    "type": "json_object"
  },
  "max_tokens": 2000
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

string

必需

object

string

必需

created

integer

必需

model

string

必需

choices

array [object {3}]

必需

index

integer

可选

message

object

可选

finish_reason

string

可选

usage

object

必需

prompt_tokens

integer

必需

completion_tokens

integer

必需

total_tokens

integer

必需

system_fingerprint

string

必需

{
  "id": "chatcmpl-8KTtjVPGpfrvNjXCklSnCGvxTCDsT",
  "object": "chat.completion",
  "created": 1699892179,
  "model": "gpt-3.5-turbo-1106",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "{\"武将\":\"关羽\",\"武力值\":100}"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 46,
    "completion_tokens": 16,
    "total_tokens": 62
  },
  "system_fingerprint": "fp_eeff13170a"
}

最后修改时间： 6 个月前