Skip to content

Latest commit

 

History

History
462 lines (337 loc) · 18.1 KB

README.ja.md

File metadata and controls

462 lines (337 loc) · 18.1 KB

new-api

New API

🍥 次世代大規模モデルゲートウェイとAI資産管理システム

中文 | English | Français | 日本語

license release docker docker GoReportCard

Calcium-Ion%2Fnew-api | Trendshift

クイックスタート • 主な機能 • デプロイ • ドキュメント • ヘルプ

📝 プロジェクト説明

Note

本プロジェクトは、One APIをベースに二次開発されたオープンソースプロジェクトです

Important

  • 本プロジェクトは個人学習用のみであり、安定性の保証や技術サポートは提供しません。
  • ユーザーは、OpenAIの利用規約および法律法規を遵守する必要があり、違法な目的で使用してはいけません。
  • 《生成式人工智能服务管理暂行办法》の要求に従い、中国地域の公衆に未登録の生成式AI サービスを提供しないでください。

🤝 信頼できるパートナー

順不同

Cherry Studio 北京大学 UCloud 優刻得 Alibaba Cloud IO.NET

🙏 特別な感謝

JetBrains Logo

感謝 JetBrains が本プロジェクトに無料のオープンソース開発ライセンスを提供してくれたことに感謝します

🚀 クイックスタート

Docker Composeを使用（推奨）

# プロジェクトをクローン
git clone https://github.com/QuantumNous/new-api.git
cd new-api

# docker-compose.yml 設定を編集
nano docker-compose.yml

# サービスを起動
docker-compose up -d
Dockerコマンドを使用 
# 最新のイメージをプル
docker pull calciumion/new-api:latest

# SQLiteを使用（デフォルト）
docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e TZ=Asia/Shanghai \
  -v ./data:/data \
  calciumion/new-api:latest

# MySQLを使用
docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \
  -e TZ=Asia/Shanghai \
  -v ./data:/data \
  calciumion/new-api:latest

💡 ヒント: -v ./data:/data は現在のディレクトリの data フォルダにデータを保存します。絶対パスに変更することもできます：-v /your/custom/path:/data

🎉 デプロイが完了したら、http://localhost:3000 にアクセスして使用を開始してください！

📖 その他のデプロイ方法についてはデプロイガイドを参照してください。

📚 ドキュメント

クイックナビゲーション:

カテゴリ リンク
🚀 デプロイガイド インストールドキュメント
⚙️ 環境設定 環境変数
📡 APIドキュメント APIドキュメント
❓ よくある質問 FAQ
💬 コミュニティ交流 交流チャネル

✨ 主な機能

詳細な機能については機能説明を参照してください。

🎨 コア機能

機能 説明
🎨 新しいUI モダンなユーザーインターフェースデザイン
🌍 多言語 中国語、英語、フランス語、日本語をサポート
🔄 データ互換性 オリジナルのOne APIデータベースと完全に互換性あり
📈 データダッシュボード ビジュアルコンソールと統計分析
🔒 権限管理 トークングループ化、モデル制限、ユーザー管理

💰 支払いと課金

  • ✅ オンライン充電（EPay、Stripe）
  • ✅ モデルの従量課金
  • ✅ キャッシュ課金サポート（OpenAI、Azure、DeepSeek、Claude、Qwenなどすべてのサポートされているモデル）
  • ✅ 柔軟な課金ポリシー設定

🔐 認証とセキュリティ

  • 🤖 LinuxDO認証ログイン
  • 📱 Telegram認証ログイン
  • 🔑 OIDC統一認証

🚀 高度な機能

APIフォーマットサポート:

インテリジェントルーティング:

  • ⚖️ チャネル重み付けランダム
  • 🔄 失敗自動リトライ
  • 🚦 ユーザーレベルモデルレート制限

フォーマット変換:

  • 🔄 OpenAI Compatible ⇄ Claude Messages
  • 🔄 OpenAI Compatible → Google Gemini
  • 🔄 Google Gemini → OpenAI Compatible - テキストのみ、関数呼び出しはまだサポートされていません
  • 🚧 OpenAI Compatible ⇄ OpenAI Responses - 開発中
  • 🔄 思考からコンテンツへの機能

Reasoning Effort サポート:

詳細設定を表示

OpenAIシリーズモデル:

  • o3-mini-high - 高思考努力
  • o3-mini-medium - 中思考努力
  • o3-mini-low - 低思考努力
  • gpt-5-high - 高思考努力
  • gpt-5-medium - 中思考努力
  • gpt-5-low - 低思考努力

Claude思考モデル:

  • claude-3-7-sonnet-20250219-thinking - 思考モードを有効にする

Google Geminiシリーズモデル:

  • gemini-2.5-flash-thinking - 思考モードを有効にする
  • gemini-2.5-flash-nothinking - 思考モードを無効にする
  • gemini-2.5-pro-thinking - 思考モードを有効にする
  • gemini-2.5-pro-thinking-128 - 思考モードを有効にし、思考予算を128トークンに設定する
  • Gemini モデル名の末尾に -low / -medium / -high を付けることで推論強度を直接指定できます（追加の思考予算サフィックスは不要です）。

🤖 モデルサポート

詳細についてはAPIドキュメント - 中継インターフェース

モデルタイプ 説明 ドキュメント
🤖 OpenAI GPTs gpt-4-gizmo-* シリーズ -
🎨 Midjourney-Proxy Midjourney-Proxy(Plus) ドキュメント
🎵 Suno-API Suno API ドキュメント
🔄 Rerank Cohere、Jina ドキュメント
💬 Claude Messagesフォーマット ドキュメント
🌐 Gemini Google Geminiフォーマット ドキュメント
🔧 Dify ChatFlowモード -
🎯 カスタム 完全な呼び出しアドレスの入力をサポート -

📡 サポートされているインターフェース

完全なインターフェースリストを表示

🚢 デプロイ

Tip

最新のDockerイメージ: calciumion/new-api:latest

📋 デプロイ要件

コンポーネント 要件
ローカルデータベース SQLite（Dockerは /data ディレクトリをマウントする必要があります）
リモートデータベース MySQL ≥ 5.7.8 または PostgreSQL ≥ 9.6
コンテナエンジン Docker / Docker Compose

⚙️ 環境変数設定

一般的な環境変数設定
変数名 説明 デフォルト値
SESSION_SECRET セッションシークレット（マルチマシンデプロイに必須） -
CRYPTO_SECRET 暗号化シークレット（Redisに必須） -
`SQL_DSN** データベース接続文字列 -
REDIS_CONN_STRING Redis接続文字列 -
STREAMING_TIMEOUT ストリーミング応答のタイムアウト時間（秒） 300
STREAM_SCANNER_MAX_BUFFER_MB ストリームスキャナの1行あたりバッファ上限（MB）。4K画像など巨大なbase64 data: ペイロードを扱う場合は値を増加させてください 64
MAX_REQUEST_BODY_MB リクエストボディ最大サイズ（MB、解凍後に計測。巨大リクエスト/zip bomb によるメモリ枯渇を防止）。超過時は 413 32
AZURE_DEFAULT_API_VERSION Azure APIバージョン 2025-04-01-preview
ERROR_LOG_ENABLED エラーログスイッチ false
PYROSCOPE_URL Pyroscopeサーバーのアドレス -
PYROSCOPE_APP_NAME Pyroscopeアプリ名 new-api
PYROSCOPE_BASIC_AUTH_USER Pyroscope Basic Authユーザー -
PYROSCOPE_BASIC_AUTH_PASSWORD Pyroscope Basic Authパスワード -
PYROSCOPE_MUTEX_RATE Pyroscope mutexサンプリング率 5
PYROSCOPE_BLOCK_RATE Pyroscope blockサンプリング率 5
HOSTNAME Pyroscope用のホスト名タグ new-api

📖 完全な設定: 環境変数ドキュメント

🔧 デプロイ方法

方法 1: Docker Compose（推奨） 
# プロジェクトをクローン
git clone https://github.com/QuantumNous/new-api.git
cd new-api

# 設定を編集
nano docker-compose.yml

# サービスを起動
docker-compose up -d
方法 2: Dockerコマンド

SQLiteを使用:

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e TZ=Asia/Shanghai \
  -v ./data:/data \
  calciumion/new-api:latest

MySQLを使用:

docker run --name new-api -d --restart always \
  -p 3000:3000 \
  -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \
  -e TZ=Asia/Shanghai \
  -v ./data:/data \
  calciumion/new-api:latest

💡 パス説明:

  • ./data:/data - 相対パス、データは現在のディレクトリのdataフォルダに保存されます
  • 絶対パスを使用することもできます：/your/custom/path:/data
方法 3: 宝塔パネル
  1. 宝塔パネル（9.2.0バージョン以上）をインストールし、アプリケーションストアでNew-APIを検索してインストールします。

📖 画像付きチュートリアル

⚠️ マルチマシンデプロイの注意事項

Warning

  • 必ず設定する必要があります SESSION_SECRET - そうしないとマルチマシンデプロイ時にログイン状態が不一致になります
  • 共有Redisは必ず設定する必要があります CRYPTO_SECRET - そうしないとデータを復号化できません

🔄 チャネルリトライとキャッシュ

リトライ設定: 設定 → 運営設定 → 一般設定 → 失敗リトライ回数

キャッシュ設定:

  • REDIS_CONN_STRING：Redisキャッシュ（推奨）
  • MEMORY_CACHE_ENABLED：メモリキャッシュ

🔗 関連プロジェクト

上流プロジェクト

プロジェクト 説明
One API オリジナルプロジェクトベース
Midjourney-Proxy Midjourneyインターフェースサポート

補助ツール

プロジェクト 説明
neko-api-key-tool キー使用量クォータ照会ツール
new-api-horizon New API高性能最適化版

💬 ヘルプサポート

📖 ドキュメントリソース

リソース リンク
📘 よくある質問 FAQ
💬 コミュニティ交流 交流チャネル
🐛 問題のフィードバック 問題フィードバック
📚 完全なドキュメント 公式ドキュメント

🤝 貢献ガイド

あらゆる形の貢献を歓迎します！

  • 🐛 バグを報告する
  • 💡 新しい機能を提案する
  • 📝 ドキュメントを改善する
  • 🔧 コードを提出する

🌟 スター履歴

スター履歴チャート

💖 New APIをご利用いただきありがとうございます

このプロジェクトがあなたのお役に立てたなら、ぜひ ⭐️ スターをください！

公式ドキュメント • 問題フィードバック • 最新リリース

❤️ で構築された QuantumNous