# OpenAI SDK 迁移到 OfoxAI 指南

Source: https://ofox.io/zh/docs/integrations/openai-sdk

OfoxAI 完全兼容 OpenAI SDK，从 OpenAI 直连迁移只需修改两个参数：`base_url` 和 `api_key`。

## 迁移步骤

### 只需修改两行代码

**Python**

```python
from openai import OpenAI

# 之前：直连 OpenAI
# client = OpenAI(api_key="sk-openai-xxx")

# 现在：通过 OfoxAI
client = OpenAI(
    base_url="https://api.ofox.io/v1",    # 新增
    api_key="<你的 OFOXAI_API_KEY>"       # 替换
)

# 其他代码完全不变！
response = client.chat.completions.create(
    model="openai/gpt-6.1-sol",  # 添加 provider 前缀
    messages=[{"role": "user", "content": "Hello!"}]
)
```

**TypeScript**

```typescript
import OpenAI from 'openai'

// 之前：直连 OpenAI
// const client = new OpenAI({ apiKey: 'sk-openai-xxx' })

// 现在：通过 OfoxAI
const client = new OpenAI({
  baseURL: 'https://api.ofox.io/v1',      // 新增
  apiKey: '<你的 OFOXAI_API_KEY>'         // 替换
})

// 其他代码完全不变！
```

## 模型命名

OfoxAI 使用 `provider/model-name` 格式标识模型：

| OpenAI 原始名称 | OfoxAI 模型 ID |
|----------------|---------------|
| `gpt-6.1-sol` | `openai/gpt-6.1-sol` |
| `gpt-6-luna` | `openai/gpt-6-luna` |
| `gpt-5.5` | `openai/gpt-5.5` |
| `text-embedding-3-small` | `openai/text-embedding-3-small` |

通过 OfoxAI，你还可以使用其他厂商的模型，推荐模型请参考 [OfoxAI 模型广场](https://ofox.io/zh/models)。

## 兼容性

OfoxAI 支持 OpenAI API 的以下功能：

| 功能 | 状态 |
|------|------|
| Chat Completions | ✅ 完全兼容 |
| Streaming | ✅ 完全兼容 |
| Function Calling | ✅ 完全兼容 |
| JSON Mode | ✅ 完全兼容 |
| Vision (图像输入) | ✅ 完全兼容 |
| Embeddings | ✅ 完全兼容 |
| Models List | ✅ 完全兼容 |
| Images Generation | ✅ 完全兼容 |

## 框架集成

### LangChain

```python
from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    base_url="https://api.ofox.io/v1",
    api_key="<你的 OFOXAI_API_KEY>",
    model="openai/gpt-6.1-sol"
)
```

### LlamaIndex

```python
from llama_index.llms.openai import OpenAI

llm = OpenAI(
    api_base="https://api.ofox.io/v1",
    api_key="<你的 OFOXAI_API_KEY>",
    model="openai/gpt-6.1-sol"
)
```

### Vercel AI SDK

```typescript
import { createOpenAI } from '@ai-sdk/openai'

const ofoxai = createOpenAI({
  baseURL: 'https://api.ofox.io/v1',
  apiKey: '<你的 OFOXAI_API_KEY>'
})

const model = ofoxai('openai/gpt-6.1-sol')
```

任何支持 OpenAI SDK 的框架和工具，都可以通过修改 `base_url` 接入 OfoxAI。