Back to New Api

New API

README.ja.md

0.13.219.5 KB
Original Source
<div align="center">

New API

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

<p align="center"> <a href="./README.zh_CN.md">简体中文</a> | <a href="./README.zh_TW.md">繁體中文</a> | <a href="./README.md">English</a> | <a href="./README.fr.md">Français</a> | <strong>日本語</strong> </p> <p align="center"> <a href="https://raw.githubusercontent.com/Calcium-Ion/new-api/main/LICENSE">

</a><!-- --><a href="https://github.com/Calcium-Ion/new-api/releases/latest">

</a><!-- --><a href="https://hub.docker.com/r/CalciumIon/new-api">

</a><!-- --><a href="https://goreportcard.com/report/github.com/Calcium-Ion/new-api">

</a> </p> <p align="center"> <a href="https://trendshift.io/repositories/20180" target="_blank"> </a> <a href="https://hellogithub.com/repository/QuantumNous/new-api" target="_blank">

</a><!-- --><a href="https://www.producthunt.com/products/new-api/launches/new-api?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-new-api" target="_blank" rel="noopener noreferrer">

</a> </p> <p align="center"> <a href="#-クイックスタート">クイックスタート</a> • <a href="#-主な機能">主な機能</a> • <a href="#-デプロイ">デプロイ</a> • <a href="#-ドキュメント">ドキュメント</a> • <a href="#-ヘルプサポート">ヘルプ</a> </p> </div>

📝 プロジェクト説明

[!IMPORTANT]

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

🤝 信頼できるパートナー

<p align="center"> <em>順不同</em> </p> <p align="center"> <a href="https://www.cherry-ai.com/" target="_blank">

</a><!-- --><a href="https://github.com/iOfficeAI/AionUi/" target="_blank">

</a><!-- --><a href="https://bda.pku.edu.cn/" target="_blank">

</a><!-- --><a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target="_blank">

</a><!-- --><a href="https://www.aliyun.com/" target="_blank">

</a><!-- --><a href="https://io.net/" target="_blank">

</a> </p>

🙏 特別な感謝

<p align="center"> <a href="https://www.jetbrains.com/?from=new-api" target="_blank"> </a> </p> <p align="center"> <strong>感謝 <a href="https://www.jetbrains.com/?from=new-api">JetBrains</a> が本プロジェクトに無料のオープンソース開発ライセンスを提供してくれたことに感謝します</strong> </p>

🚀 クイックスタート

Docker Composeを使用(推奨)

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

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

# サービスを起動
docker-compose up -d
<details> <summary><strong>Dockerコマンドを使用</strong></summary>
bash
# 最新のイメージをプル
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

</details>

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

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


📚 ドキュメント

<div align="center">

📖 公式ドキュメント |

</div>

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

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

✨ 主な機能

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

🎨 コア機能

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

💰 支払いと課金

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

🔐 認証とセキュリティ

  • 😈 Discord認証ログイン
  • 🤖 LinuxDO認証ログイン
  • 📱 Telegram認証ログイン
  • 🔑 OIDC統一認証
  • 🔍 Key使用量クォータ照会(neko-api-key-toolと併用)

🚀 高度な機能

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

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

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

フォーマット変換:

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

Reasoning Effort サポート:

<details> <summary>詳細設定を表示</summary>

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 を付けることで推論強度を直接指定できます(追加の思考予算サフィックスは不要です)。
</details>

🤖 モデルサポート

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

モデルタイプ説明ドキュメント
🤖 OpenAI-CompatibleOpenAI互換モデルドキュメント
🤖 OpenAI ResponsesOpenAI Responsesフォーマットドキュメント
🎨 Midjourney-ProxyMidjourney-Proxy(Plus)ドキュメント
🎵 Suno-APISuno APIドキュメント
🔄 RerankCohere、Jinaドキュメント
💬 ClaudeMessagesフォーマットドキュメント
🌐 GeminiGoogle Geminiフォーマットドキュメント
🔧 DifyChatFlowモード-
🎯 カスタム完全な呼び出しアドレスの入力をサポート-

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

<details> <summary>完全なインターフェースリストを表示</summary> </details>

🚢 デプロイ

[!TIP] 最新のDockerイメージ: calciumion/new-api:latest

📋 デプロイ要件

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

⚙️ 環境変数設定

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

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

</details>

🔧 デプロイ方法

<details> <summary><strong>方法 1: Docker Compose(推奨)</strong></summary>
bash
# プロジェクトをクローン
git clone https://github.com/QuantumNous/new-api.git
cd new-api

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

# サービスを起動
docker-compose up -d
</details> <details> <summary><strong>方法 2: Dockerコマンド</strong></summary>

SQLiteを使用:

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

MySQLを使用:

bash
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
</details> <details> <summary><strong>方法 3: 宝塔パネル</strong></summary>
  1. 宝塔パネル(9.2.0バージョン以上)をインストールし、アプリケーションストアでNew-APIを検索してインストールします。

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

</details>

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

[!WARNING]

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

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

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

キャッシュ設定:

  • REDIS_CONN_STRING:Redisキャッシュ(推奨)
  • MEMORY_CACHE_ENABLED:メモリキャッシュ

🔗 関連プロジェクト

上流プロジェクト

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

補助ツール

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

💬 ヘルプサポート

📖 ドキュメントリソース

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

🤝 貢献ガイド

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

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

📜 ライセンス

このプロジェクトは GNU Affero General Public License v3.0 (AGPLv3) の下でライセンスされています。

本プロジェクトは、One API(MITライセンス)をベースに開発されたオープンソースプロジェクトです。

お客様の組織のポリシーがAGPLv3ライセンスのソフトウェアの使用を許可していない場合、またはAGPLv3のオープンソース義務を回避したい場合は、こちらまでお問い合わせください:[email protected]


🌟 スター履歴

<div align="center">

</div>
<div align="center">

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

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

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

<sub>❤️ で構築された QuantumNous</sub>

</div>