OpenAI SDK

概览

要使用 AI Sonar，官方 OpenAI SDK 客户端只需将客户端的 base URL 指向 https://api.aisonar.dev/v1。对于大多数新项目，建议将 Chat Completions 作为默认的 OpenAI 兼容路径。仅在明确需要 Responses 特定行为时才使用 Responses API。 Responses 特定字段并不能保证在每个模型和路由路径上表现一致。

Python、JavaScript 和 Go 有官方的 OpenAI SDK。PHP 与兼容 OpenAI 的社区客户端配合良好，但它并不是官方 OpenAI SDK。

类型: Native SDK主要路径: OpenAI 兼容 / Chat Completions支持情况: 核心支持路径

安装

pip install openai

npm install openai

go get github.com/openai/openai-go/v3

仅在明确需要 Responses 特定行为时使用 POST /v1/responses。某些仅限 Responses 的字段仍可能依赖于所选模型和路由路径。

配置客户端

from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key",
    base_url="https://api.aisonar.dev/v1",
)

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'sk-your-api-key',
  baseURL: 'https://api.aisonar.dev/v1',
});

package main

import (
    openai "github.com/openai/openai-go/v3"
    "github.com/openai/openai-go/v3/option"
)

func main() {
    client := openai.NewClient(
        option.WithAPIKey("sk-your-api-key"),
        option.WithBaseURL("https://api.aisonar.dev/v1"),
    )

    _ = client
}

推荐：Chat Completions

response = client.chat.completions.create(
    model="gpt-5.4",
    messages=[{"role": "user", "content": "Explain what AI Sonar does in one sentence."}]
)

print(response.choices[0].message.content)

const response = await client.chat.completions.create({
  model: 'gpt-5.4',
  messages: [{ role: 'user', content: 'Explain what AI Sonar does in one sentence.' }],
});

console.log(response.choices[0].message.content);

curl https://api.aisonar.dev/v1/chat/completions \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [
      {"role": "user", "content": "Explain what AI Sonar does in one sentence."}
    ]
  }'

高级：Responses API

仅当您的工具或工作流明确依赖 OpenAI Responses 语义时才使用此路径。

使用 Responses 的流式传输

stream = client.responses.create(
    model="gpt-5.4",
    input="Write a short poem about coding.",
    stream=True,
)

for event in stream:
    if event.type == "response.output_text.delta":
        print(event.delta, end="")

const stream = await client.responses.create({
  model: 'gpt-5.4',
  input: 'Write a short poem about coding.',
  stream: true,
});

for await (const event of stream) {
  if (event.type === 'response.output_text.delta') {
    process.stdout.write(event.delta);
  }
}

工具 / 函数调用

response = client.responses.create(
    model="gpt-5.4",
    input="What's the weather in Tokyo?",
    tools=[{
        "type": "function",
        "name": "get_weather",
        "description": "Get weather for a location",
        "parameters": {
            "type": "object",
            "properties": {
                "location": {"type": "string"}
            },
            "required": ["location"]
        }
    }]
)

for item in response.output:
    if item.type == "function_call":
        print(item.name)
        print(item.arguments)

使用 Responses 的视觉功能

response = client.responses.create(
    model="gpt-4o",
    input=[{
        "role": "user",
        "content": [
            {"type": "input_text", "text": "What's in this image?"},
            {"type": "input_image", "image_url": "https://example.com/image.jpg"}
        ]
    }]
)

print(response.output_text)

Embeddings（嵌入）

response = client.embeddings.create(
    model="text-embedding-3-small",
    input="Hello world"
)

print(response.data[0].embedding[:5])

Chat Completions

Chat Completions 是 AI Sonar 的默认 OpenAI 兼容路径：

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello!"}
    ]
)

print(response.choices[0].message.content)

故障排查

连接错误

确认 base URL 精确为 https://api.aisonar.dev/v1
检查是否有网络转发配置干扰或自定义 HTTP 客户端覆盖
在调试提供商行为之前，确保您的 SDK 版本是最新的

身份验证失败

检查您的 API 密钥是否以 sk- 开头
确认该密钥在 AI Sonar 控制面板中处于激活状态
确认 SDK 正在发送 Authorization: Bearer ...

错误的 API 路径

responses.create(...) 会向 /v1/responses 发送请求
chat.completions.create(...) 会向 /v1/chat/completions 发送请求
默认使用 Chat Completions，除非您明确需要 Responses 特定行为

兼容性矩阵

编码工具

原生 SDK

框架与平台

聊天应用

概览

安装

配置客户端

推荐：Chat Completions

高级：Responses API

使用 Responses 的流式传输

工具 / 函数调用

使用 Responses 的视觉功能

Embeddings（嵌入）

Chat Completions

故障排查

​概览

​安装

​配置客户端

​推荐：Chat Completions

​高级：Responses API

​使用 Responses 的流式传输

​工具 / 函数调用

​使用 Responses 的视觉功能

​Embeddings（嵌入）

​Chat Completions

​故障排查

概览

安装

配置客户端

推荐：Chat Completions

高级：Responses API

使用 Responses 的流式传输

工具 / 函数调用

使用 Responses 的视觉功能

Embeddings（嵌入）

Chat Completions

故障排查