对话接口 - 星芸AI API开发文档

提示

这里仅显示“对话”接口，其他图片解析等多模态接口请查看对应接口内容

模型名称	调用名称	备注
GPT-3.5系列	gpt-3.5-turbo	上下文4K Token
	gpt-3.5-turbo-0613	上下文4K Token
	gpt-3.5-turbo-16k	上下文16K Token
	gpt-3.5-turbo-16k-0613	上下文16K Token
GPT-4.0系列	gpt-4	上下文8K Token
	gpt-4-0314	上下文8K Token
	gpt-4-0613	上下文8K Token
	gpt-4-1106-preview	最大输入128K Token，最大输出4KToken，该模型是最新的GPT-4-turbo模型
	gpt-4-turbo	最大输入128K Token，最大输出4KToken，该模型是最新的GPT-4-turbo模型
国内大模型(小程序等审查专用)	qwen-turbo	上下文8K Token

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Header 参数

Body 参数application/json

示例

//  历史记录和用户新提出的问题通过插入messages中的[{},{},{}...]形式传参数，这样AI才会有记忆能力，通过不同的role分为用户，AI以及系统预设三部分，各个部分使用说明如下：
{
  "messages": [
    {
      "role": "system", // system表示系统预设角色，权重最高，适合做Prompt，例如：你叫小芸，你具有写作，聊天，和回答问题的能力
      "content": "你叫小芸，你具有写作，聊天，和回答问题的能力"
    },
    {
      "role": "user",  // user表示用户提问的内容，例如：你好
      "content": "你好"
    },
    {
      "role": "assistant",  // assistant表示AI回复的内容
      "content": "你好！有什么我可以帮助你的吗？"
    },
    {
      "role": "user",
      "content": "简单说一下你会做什么？"
    },
    {
      "role": "assistant",
      "content": "作为一个语言模型，我可以帮助你完成各种任务，包括但不限于：\n\n1. 回答常见问题：我可以回答关于历史、科学、地理、文化等各个领域的问题。\n\n2. 提供解释和定义：如果你需要解释某个概念或术语的含义，我可以帮你提供相关的定义和解释。\n\n3. 进行翻译：我可以翻译英文、中文和其他一些常见语言之间的文本。\n\n4. 撰写文章和段落：如果你需要帮助写作，我可以提供文章、段落或句子的写作建议和指导。\n\n5. 创意和灵感：如果你需要一些创意或灵感，我可以提供关于写作、绘画、设计等方面的建议。\n\n请记住，我是一个语言模型，虽然我尽力提供准确和有用的信息，但有时候可能会出现错误或不准确的回答。在使用我的回答时，请自行判断和核实信息的准确性。"
    },
    {
      "role": "user",  // 注意：请求的时候，最后一个一定是user，也就是用户提问，这样AI才能回答这个问题
      "content": "我上面问的你什么问题？"
    }
  ],
  "stream": false,  // 是否流式响应
  "model": "gpt-3.5-turbo",  // 模型定义在这里，其中，需要审查的国内模型可定义为：qwen-turbo,审查过后可更换
  "temperature": 0.5,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "top_p": 1
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aiapi.xing-yun.cn/v1/chat/completions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '//  历史记录和用户新提出的问题通过插入messages中的[{},{},{}...]形式传参数，这样AI才会有记忆能力，通过不同的role分为用户，AI以及系统预设三部分，各个部分使用说明如下：
{
  "messages": [
    {
      "role": "system", // system表示系统预设角色，权重最高，适合做Prompt，例如：你叫小芸，你具有写作，聊天，和回答问题的能力
      "content": "你叫小芸，你具有写作，聊天，和回答问题的能力"
    },
    {
      "role": "user",  // user表示用户提问的内容，例如：你好
      "content": "你好"
    },
    {
      "role": "assistant",  // assistant表示AI回复的内容
      "content": "你好！有什么我可以帮助你的吗？"
    },
    {
      "role": "user",
      "content": "简单说一下你会做什么？"
    },
    {
      "role": "assistant",
      "content": "作为一个语言模型，我可以帮助你完成各种任务，包括但不限于：\n\n1. 回答常见问题：我可以回答关于历史、科学、地理、文化等各个领域的问题。\n\n2. 提供解释和定义：如果你需要解释某个概念或术语的含义，我可以帮你提供相关的定义和解释。\n\n3. 进行翻译：我可以翻译英文、中文和其他一些常见语言之间的文本。\n\n4. 撰写文章和段落：如果你需要帮助写作，我可以提供文章、段落或句子的写作建议和指导。\n\n5. 创意和灵感：如果你需要一些创意或灵感，我可以提供关于写作、绘画、设计等方面的建议。\n\n请记住，我是一个语言模型，虽然我尽力提供准确和有用的信息，但有时候可能会出现错误或不准确的回答。在使用我的回答时，请自行判断和核实信息的准确性。"
    },
    {
      "role": "user",  // 注意：请求的时候，最后一个一定是user，也就是用户提问，这样AI才能回答这个问题
      "content": "我上面问的你什么问题？"
    }
  ],
  "stream": false,  // 是否流式响应
  "model": "gpt-3.5-turbo",  // 模型定义在这里，其中，需要审查的国内模型可定义为：qwen-turbo,审查过后可更换
  "temperature": 0.5,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "top_p": 1
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "id": "chatcmpl-8eD4KviOzJPZxTFF8Pze9PYvoaSaN",
    "object": "chat.completion",
    "created": 1704594048,
    "model": "gpt-3.5-turbo-0613",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "你上面问的问题是：简单说一下你会做什么？"
            },
            "logprobs": null,
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 406,
        "completion_tokens": 21,
        "total_tokens": 427
    },
    "system_fingerprint": null
}