朔风

Appearance

章节导航

云模型调试 ​

OpenAI API 接口规范 ​

RESTful API ​

  • 基于 HTTPS 的 RESTful 架构。

资源导向： 核心资源 ​

  • ChatCompletion
  • Completion
  • Embedding 等

JSON格式 ​

不同的模型，请求体和响应体不一样，这里以阿里百炼为例， 阿里百炼 API 参考地址：
https://bailian.console.aliyun.com/cn-beijing/?tab=api#/api

请求体 ​

shell
curl -X POST https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "qwen-plus",
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful assistant."
        },
        {
            "role": "user",
            "content": "你是谁？"
        }
    ]
}'

响应体 ​

shell
{
    "choices": [
        {
            "message": {
                "role": "assistant",
                "content": "我是阿里云开发的一款超大规模语言模型，我叫通义千问。"
            },
            "finish_reason": "stop",
            "index": 0,
            "logprobs": null
        }
    ],
    "object": "chat.completion",
    "usage": {
        "prompt_tokens": 3019,
        "completion_tokens": 104,
        "total_tokens": 3123,
        "prompt_tokens_details": {
            "cached_tokens": 2048
        }
    },
    "created": 1735120033,
    "system_fingerprint": null,
    "model": "qwen-plus",
    "id": "chatcmpl-6ada9ed2-7f33-9de2-8bb0-78bd4035025a"
}

流式支持 ​

对文本生成类接口支持服务器发送事件流式传输

函数调用 ​

原生支持模型决定调用用户定义函数的能力

API 基础 URL ​

POST https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions

认证方式 ​

Bearer Token，使用在 OpenAI 平台获取的 API 密钥

shell
Authorization: Bearer sk-xxx...xxx