OpenAIからの移行 - OpenModex

概要

OpenModexはOpenAI APIと完全互換です。移行には通常、ベースURLとAPIキーの2行のコード変更のみが必要です。

オプション1：OpenAI SDKを使用（最速）

すでにOpenAI SDKを使用している場合は、設定を変更するだけです：

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'omx_sk_YOUR_KEY',                   // ← OpenModex key
  baseURL: 'https://api.openmodex.com/v1',     // ← OpenModex URL
});

// All existing code works unchanged
const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Hello!' }],
});

from openai import OpenAI

client = OpenAI(
    api_key="omx_sk_YOUR_KEY",                   # ← OpenModex key
    base_url="https://api.openmodex.com/v1",     # ← OpenModex URL
)

# All existing code works unchanged
response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello!"}],
)

オプション2：OpenModex SDKを使用

ルーティング、キャッシュ、フォールバック、モデル比較にアクセスするには：

// Before (OpenAI)
import OpenAI from 'openai';
const client = new OpenAI({ apiKey: 'sk-...' });

// After (OpenModex)
import OpenModex from '@openmodex/sdk';
const client = new OpenModex({ apiKey: 'omx_sk_...' });

// API calls are identical
const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Hello!' }],
});

# Before (OpenAI)
from openai import OpenAI
client = OpenAI(api_key="sk-...")

# After (OpenModex)
from openmodex import OpenModex
client = OpenModex(api_key="omx_sk_...")

# API calls are identical
response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Hello!"}],
)

オプション3：環境変数

コード変更なしで移行するには、環境変数を設定するだけです：

# Replace
export OPENAI_API_KEY=sk-...
export OPENAI_BASE_URL=https://api.openai.com/v1

# With
export OPENAI_API_KEY=omx_sk_...
export OPENAI_BASE_URL=https://api.openmodex.com/v1

移行で得られるもの

移行後、以下の機能にアクセスできます：

機能	OpenAI直接	OpenModex
OpenAIモデル	✅	✅
Anthropic、Googleなど	❌	✅
自動フォールバック	❌	✅
スマートルーティング	❌	✅
プロンプトキャッシュ	❌	✅
モデル比較	❌	✅
統合課金	❌	✅
利用分析	基本	✅

互換性に関する注意事項

すべてのOpenAIチャット補完パラメータがサポートされています
ストリーミングは同じ動作をします（SSE形式）
Function calling / Tool Useは完全にサポートされています
レスポンス形式は同一です — パースコードはそのまま使用できます
openmodexメタデータフィールドは追加的なもので、既存のコードを壊しません