星芸AI API开发文档
  1. 联网接口
星芸AI API开发文档
  • 文档说明
  • API身份认证
  • API请求
  • API模型接口
    • 模型名称
      • 模型名称获取
    • 对话接口
      • 对话接口
    • 文本补全接口
      • 文本补全接口
    • 图像生成/识别接口
      • 图像生成接口
      • 图像识别接口
    • 向量嵌入接口
      • 向量嵌入接口
    • AI绘图(MJ绘图)接口
      • 任务提交
        • 执行动作
        • 提交Blend任务
        • 提交Describe任务
        • 提交Imagine任务
        • 提交Modal
        • 提交Shorten任务
      • 任务查询
        • 查询所有任务
        • 根据ID列表查询任务
        • 查询任务队列
        • 指定ID获取任务
        • 获取任务图片的seed
    • 开放插件(Plugin)接口
      • 联网接口
        • 联网(增强)接口
          POST
    • 语音/文本接口
      • 文本转语音(TTS)
      • 语音转文本(STT)
  • 常见问题
  • API调用错误码汇总
  1. 联网接口

联网(增强)接口

开发中
正式环境
https://aiapi.xing-yun.cn
正式环境
https://aiapi.xing-yun.cn
POST
https://aiapi.xing-yun.cn
https://aiapi.xing-yun.cn/v1/chat/completions
1.能够自主判断AI是否需要联网查询
2.能够回答用户问题,即使是在联网搜索的条件下
3.AI认为不需要网上搜索时,它依然拥有GPT4特性进行回答
注:本模块将逐步优化联网逻辑,使用时如有任何问题请反馈

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数
Content-Type
string 
必需
Accept
string 
必需
Body 参数application/json
model
string 
必需
必填“gpt-4-web”
messages
array [object {2}] 
上下文信息
必需
role
string 
可选
content
string 
可选
temperature
integer 
可选
使用什么采样温度,介于 0 和 2 之间。较高的值(如 0.8)将使输出更加随机,而较低的值(如 0.2)将使输出更加集中和确定。 我们通常建议改变这个或top_p但不是两者。
top_p
integer 
可选
为每个输入消息生成多少个聊天完成选项。
n
integer 
可选
为每个输入消息生成多少个聊天完成选项。
stream
boolean 
可选
如果设置,将发送部分消息增量,就像在 ChatGPT 中一样。当令牌可用时,令牌将作为纯数据服务器发送事件data: [DONE]发送,流由消息终止。
stop
string 
可选
API 将停止生成更多令牌的最多 4 个序列。
max_tokens
integer 
可选
聊天完成时生成的最大令牌数。 输入标记和生成标记的总长度受模型上下文长度的限制。
presence_penalty
number 
可选
-2.0 和 2.0 之间的数字。正值会根据到目前为止是否出现在文本中来惩罚新标记,从而增加模型谈论新主题的可能性。 查看有关频率和存在惩罚的更多信息。
frequency_penalty
number 
可选
-2.0 和 2.0 之间的数字。正值会根据新标记在文本中的现有频率对其进行惩罚,从而降低模型逐字重复同一行的可能性。 查看有关频率和存在惩罚的更多信息。
logit_bias
null 
可选
修改指定标记出现在完成中的可能性。 接受一个 json 对象,该对象将标记(由标记器中的标记 ID 指定)映射到从 -100 到 100 的关联偏差值。从数学上讲,偏差会在采样之前添加到模型生成的 logits 中。确切的效果因模型而异,但 -1 和 1 之间的值应该会减少或增加选择的可能性;像 -100 或 100 这样的值应该导致相关令牌的禁止或独占选择。
user
string 
可选
代表您的最终用户的唯一标识符,可以帮助 OpenAI 监控和检测滥用行为
示例
{
  "model": "gpt-4-web",
  "messages": [
    {
      "role": "user",
      "content": "今天济南天气怎么样?"
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://aiapi.xing-yun.cn/v1/chat/completions' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-4-web",
  "messages": [
    {
      "role": "user",
      "content": "今天济南天气怎么样?"
    }
  ]
}'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{
  "id": "",
  "model": "",
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  },
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "根据最新的天气预报,今天济南的天气是晴天,最高气温为25℃,风力小于3级。您可以参考[济南天气预报](https://www.tianqi.com/jinan/)获取更多详细信息。"
      },
      "finish_reason": "stop",
      "index": 0
    }
  ]
}
上一页
获取任务图片的seed
下一页
文本转语音(TTS)
Built with