From d6e97ab184e6be461d4cdb84c9d15b587c00db3c Mon Sep 17 00:00:00 2001 From: t0ng7u Date: Sun, 21 Dec 2025 21:00:33 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=94=97=20docs(readme):=20update=20documen?= =?UTF-8?q?tation=20links=20to=20new=20site=20routing?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Replace legacy `docs.newapi.pro` paths with the new `/{lang}/docs/...` structure across all README translations - Point key sections (installation, env vars, API, support, features) to their new locations - Ensure language-specific links use the correct locale prefix (zh/en/ja) and keep FR aligned with English routes --- README.en.md | 70 +++++++++++++++++++++++----------------------- README.fr.md | 70 +++++++++++++++++++++++----------------------- README.ja.md | 78 ++++++++++++++++++++++++++-------------------------- README.md | 70 +++++++++++++++++++++++----------------------- 4 files changed, 144 insertions(+), 144 deletions(-) diff --git a/README.en.md b/README.en.md index 063d360b2..d2e0947d2 100644 --- a/README.en.md +++ b/README.en.md @@ -146,7 +146,7 @@ docker run --name new-api -d --restart always \ 🎉 After deployment is complete, visit `http://localhost:3000` to start using! -📖 For more deployment methods, please refer to [Deployment Guide](https://docs.newapi.pro/installation) +📖 For more deployment methods, please refer to [Deployment Guide](https://docs.newapi.pro/en/docs/installation) --- @@ -154,7 +154,7 @@ docker run --name new-api -d --restart always \
-### 📖 [Official Documentation](https://docs.newapi.pro/) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +### 📖 [Official Documentation](https://docs.newapi.pro/en/docs) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api)
@@ -162,17 +162,17 @@ docker run --name new-api -d --restart always \ | Category | Link | |------|------| -| 🚀 Deployment Guide | [Installation Documentation](https://docs.newapi.pro/installation) | -| ⚙️ Environment Configuration | [Environment Variables](https://docs.newapi.pro/installation/environment-variables) | -| 📡 API Documentation | [API Documentation](https://docs.newapi.pro/api) | -| ❓ FAQ | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 Community Interaction | [Communication Channels](https://docs.newapi.pro/support/community-interaction) | +| 🚀 Deployment Guide | [Installation Documentation](https://docs.newapi.pro/en/docs/installation) | +| ⚙️ Environment Configuration | [Environment Variables](https://docs.newapi.pro/en/docs/installation/config-maintenance/environment-variables) | +| 📡 API Documentation | [API Documentation](https://docs.newapi.pro/en/docs/api) | +| ❓ FAQ | [FAQ](https://docs.newapi.pro/en/docs/support/faq) | +| 💬 Community Interaction | [Communication Channels](https://docs.newapi.pro/en/docs/support/community-interaction) | --- ## ✨ Key Features -> For detailed features, please refer to [Features Introduction](https://docs.newapi.pro/wiki/features-introduction) +> For detailed features, please refer to [Features Introduction](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction) ### 🎨 Core Functions @@ -201,11 +201,11 @@ docker run --name new-api -d --restart always \ ### 🚀 Advanced Features **API Format Support:** -- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) -- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime) (including Azure) -- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) -- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) -- 🔄 [Rerank Models](https://docs.newapi.pro/api/jinaai-rerank) (Cohere, Jina) +- ⚡ [OpenAI Responses](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session) (including Azure) +- ⚡ [Claude Messages](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) +- ⚡ [Google Gemini](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) +- 🔄 [Rerank Models](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) (Cohere, Jina) **Intelligent Routing:** - ⚖️ Channel weighted random @@ -246,16 +246,16 @@ docker run --name new-api -d --restart always \ ## 🤖 Model Support -> For details, please refer to [API Documentation - Relay Interface](https://docs.newapi.pro/api) +> For details, please refer to [API Documentation - Relay Interface](https://docs.newapi.pro/en/docs/api) | Model Type | Description | Documentation | |---------|------|------| | 🤖 OpenAI GPTs | gpt-4-gizmo-* series | - | -| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/api/midjourney-proxy-image) | -| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://docs.newapi.pro/api/suno-music) | -| 🔄 Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/api/jinaai-rerank) | -| 💬 Claude | Messages format | [Documentation](https://docs.newapi.pro/api/anthropic-chat) | -| 🌐 Gemini | Google Gemini format | [Documentation](https://docs.newapi.pro/api/google-gemini-chat/) | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/en/docs/guide/console/drawing-log) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://docs.newapi.pro/en/docs/guide/console/task-log) | +| 🔄 Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) | +| 💬 Claude | Messages format | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) | +| 🌐 Gemini | Google Gemini format | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) | | 🔧 Dify | ChatFlow mode | - | | 🎯 Custom | Supports complete call address | - | @@ -264,16 +264,16 @@ docker run --name new-api -d --restart always \
View complete interface list -- [Chat Interface (Chat Completions)](https://docs.newapi.pro/api/openai-chat) -- [Response Interface (Responses)](https://docs.newapi.pro/api/openai-responses) -- [Image Interface (Image)](https://docs.newapi.pro/api/openai-image) -- [Audio Interface (Audio)](https://docs.newapi.pro/api/openai-audio) -- [Video Interface (Video)](https://docs.newapi.pro/api/openai-video) -- [Embedding Interface (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) -- [Rerank Interface (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) -- [Realtime Conversation (Realtime)](https://docs.newapi.pro/api/openai-realtime) -- [Claude Chat](https://docs.newapi.pro/api/anthropic-chat) -- [Google Gemini Chat](https://docs.newapi.pro/api/google-gemini-chat/) +- [Chat Interface (Chat Completions)](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) +- [Response Interface (Responses)](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response) +- [Image Interface (Image)](https://docs.newapi.pro/en/docs/api/ai-model/images/openai/v1-images-generations--post) +- [Audio Interface (Audio)](https://docs.newapi.pro/en/docs/api/ai-model/audio/openai/create-transcription) +- [Video Interface (Video)](https://docs.newapi.pro/en/docs/api/ai-model/videos/create-video-generation) +- [Embedding Interface (Embeddings)](https://docs.newapi.pro/en/docs/api/ai-model/embeddings/create-embedding) +- [Rerank Interface (Rerank)](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) +- [Realtime Conversation (Realtime)](https://docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session) +- [Claude Chat](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) +- [Google Gemini Chat](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion)
@@ -309,7 +309,7 @@ docker run --name new-api -d --restart always \ | `AZURE_DEFAULT_API_VERSION` | Azure API version | `2025-04-01-preview` | | `ERROR_LOG_ENABLED` | Error log switch | `false` | -📖 **Complete configuration:** [Environment Variables Documentation](https://docs.newapi.pro/installation/environment-variables) +📖 **Complete configuration:** [Environment Variables Documentation](https://docs.newapi.pro/en/docs/installation/config-maintenance/environment-variables) @@ -411,10 +411,10 @@ docker run --name new-api -d --restart always \ | Resource | Link | |------|------| -| 📘 FAQ | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 Community Interaction | [Communication Channels](https://docs.newapi.pro/support/community-interaction) | -| 🐛 Issue Feedback | [Issue Feedback](https://docs.newapi.pro/support/feedback-issues) | -| 📚 Complete Documentation | [Official Documentation](https://docs.newapi.pro/support) | +| 📘 FAQ | [FAQ](https://docs.newapi.pro/en/docs/support/faq) | +| 💬 Community Interaction | [Communication Channels](https://docs.newapi.pro/en/docs/support/community-interaction) | +| 🐛 Issue Feedback | [Issue Feedback](https://docs.newapi.pro/en/docs/support/feedback-issues) | +| 📚 Complete Documentation | [Official Documentation](https://docs.newapi.pro/en/docs) | ### 🤝 Contribution Guide @@ -443,7 +443,7 @@ Welcome all forms of contribution! If this project is helpful to you, welcome to give us a ⭐️ Star! -**[Official Documentation](https://docs.newapi.pro/)** • **[Issue Feedback](https://github.com/Calcium-Ion/new-api/issues)** • **[Latest Release](https://github.com/Calcium-Ion/new-api/releases)** +**[Official Documentation](https://docs.newapi.pro/en/docs)** • **[Issue Feedback](https://github.com/Calcium-Ion/new-api/issues)** • **[Latest Release](https://github.com/Calcium-Ion/new-api/releases)** Built with ❤️ by QuantumNous diff --git a/README.fr.md b/README.fr.md index 0aa212d1f..1ca3de863 100644 --- a/README.fr.md +++ b/README.fr.md @@ -146,7 +146,7 @@ docker run --name new-api -d --restart always \ 🎉 Après le déploiement, visitez `http://localhost:3000` pour commencer à utiliser! -📖 Pour plus de méthodes de déploiement, veuillez vous référer à [Guide de déploiement](https://docs.newapi.pro/installation) +📖 Pour plus de méthodes de déploiement, veuillez vous référer à [Guide de déploiement](https://docs.newapi.pro/en/docs/installation) --- @@ -154,7 +154,7 @@ docker run --name new-api -d --restart always \
-### 📖 [Documentation officielle](https://docs.newapi.pro/) | [![Demander à DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +### 📖 [Documentation officielle](https://docs.newapi.pro/en/docs) | [![Demander à DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api)
@@ -162,17 +162,17 @@ docker run --name new-api -d --restart always \ | Catégorie | Lien | |------|------| -| 🚀 Guide de déploiement | [Documentation d'installation](https://docs.newapi.pro/installation) | -| ⚙️ Configuration de l'environnement | [Variables d'environnement](https://docs.newapi.pro/installation/environment-variables) | -| 📡 Documentation de l'API | [Documentation de l'API](https://docs.newapi.pro/api) | -| ❓ FAQ | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 Interaction avec la communauté | [Canaux de communication](https://docs.newapi.pro/support/community-interaction) | +| 🚀 Guide de déploiement | [Documentation d'installation](https://docs.newapi.pro/en/docs/installation) | +| ⚙️ Configuration de l'environnement | [Variables d'environnement](https://docs.newapi.pro/en/docs/installation/config-maintenance/environment-variables) | +| 📡 Documentation de l'API | [Documentation de l'API](https://docs.newapi.pro/en/docs/api) | +| ❓ FAQ | [FAQ](https://docs.newapi.pro/en/docs/support/faq) | +| 💬 Interaction avec la communauté | [Canaux de communication](https://docs.newapi.pro/en/docs/support/community-interaction) | --- ## ✨ Fonctionnalités clés -> Pour les fonctionnalités détaillées, veuillez vous référer à [Présentation des fonctionnalités](https://docs.newapi.pro/wiki/features-introduction) | +> Pour les fonctionnalités détaillées, veuillez vous référer à [Présentation des fonctionnalités](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction) | ### 🎨 Fonctions principales @@ -200,11 +200,11 @@ docker run --name new-api -d --restart always \ ### 🚀 Fonctionnalités avancées **Prise en charge des formats d'API:** -- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) -- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime) (y compris Azure) -- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) -- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) -- 🔄 [Modèles Rerank](https://docs.newapi.pro/api/jinaai-rerank) (Cohere, Jina) +- ⚡ [OpenAI Responses](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session) (y compris Azure) +- ⚡ [Claude Messages](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) +- ⚡ [Google Gemini](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) +- 🔄 [Modèles Rerank](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) (Cohere, Jina) **Routage intelligent:** - ⚖️ Sélection aléatoire pondérée des canaux @@ -242,16 +242,16 @@ docker run --name new-api -d --restart always \ ## 🤖 Prise en charge des modèles -> Pour les détails, veuillez vous référer à [Documentation de l'API - Interface de relais](https://docs.newapi.pro/api) +> Pour les détails, veuillez vous référer à [Documentation de l'API - Interface de relais](https://docs.newapi.pro/en/docs/api) | Type de modèle | Description | Documentation | |---------|------|------| | 🤖 OpenAI GPTs | série gpt-4-gizmo-* | - | -| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/api/midjourney-proxy-image) | -| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://docs.newapi.pro/api/suno-music) | -| 🔄 Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/api/jinaai-rerank) | -| 💬 Claude | Format Messages | [Documentation](https://docs.newapi.pro/api/anthropic-chat) | -| 🌐 Gemini | Format Google Gemini | [Documentation](https://docs.newapi.pro/api/google-gemini-chat/) | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/en/docs/guide/console/drawing-log) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://docs.newapi.pro/en/docs/guide/console/task-log) | +| 🔄 Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) | +| 💬 Claude | Format Messages | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) | +| 🌐 Gemini | Format Google Gemini | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) | | 🔧 Dify | Mode ChatFlow | - | | 🎯 Personnalisé | Prise en charge de l'adresse d'appel complète | - | @@ -260,16 +260,16 @@ docker run --name new-api -d --restart always \
Voir la liste complète des interfaces -- [Interface de discussion (Chat Completions)](https://docs.newapi.pro/api/openai-chat) -- [Interface de réponse (Responses)](https://docs.newapi.pro/api/openai-responses) -- [Interface d'image (Image)](https://docs.newapi.pro/api/openai-image) -- [Interface audio (Audio)](https://docs.newapi.pro/api/openai-audio) -- [Interface vidéo (Video)](https://docs.newapi.pro/api/openai-video) -- [Interface d'incorporation (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) -- [Interface de rerank (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) -- [Conversation en temps réel (Realtime)](https://docs.newapi.pro/api/openai-realtime) -- [Discussion Claude](https://docs.newapi.pro/api/anthropic-chat) -- [Discussion Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) +- [Interface de discussion (Chat Completions)](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) +- [Interface de réponse (Responses)](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response) +- [Interface d'image (Image)](https://docs.newapi.pro/en/docs/api/ai-model/images/openai/v1-images-generations--post) +- [Interface audio (Audio)](https://docs.newapi.pro/en/docs/api/ai-model/audio/openai/create-transcription) +- [Interface vidéo (Video)](https://docs.newapi.pro/en/docs/api/ai-model/videos/create-video-generation) +- [Interface d'incorporation (Embeddings)](https://docs.newapi.pro/en/docs/api/ai-model/embeddings/create-embedding) +- [Interface de rerank (Rerank)](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) +- [Conversation en temps réel (Realtime)](https://docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session) +- [Discussion Claude](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) +- [Discussion Google Gemini](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion)
@@ -305,7 +305,7 @@ docker run --name new-api -d --restart always \ | `AZURE_DEFAULT_API_VERSION` | Version de l'API Azure | `2025-04-01-preview` | | `ERROR_LOG_ENABLED` | Interrupteur du journal d'erreurs | `false` | -📖 **Configuration complète:** [Documentation des variables d'environnement](https://docs.newapi.pro/installation/environment-variables) +📖 **Configuration complète:** [Documentation des variables d'environnement](https://docs.newapi.pro/en/docs/installation/config-maintenance/environment-variables) @@ -405,10 +405,10 @@ docker run --name new-api -d --restart always \ | Ressource | Lien | |------|------| -| 📘 FAQ | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 Interaction avec la communauté | [Canaux de communication](https://docs.newapi.pro/support/community-interaction) | -| 🐛 Commentaires sur les problèmes | [Commentaires sur les problèmes](https://docs.newapi.pro/support/feedback-issues) | -| 📚 Documentation complète | [Documentation officielle](https://docs.newapi.pro/support) | +| 📘 FAQ | [FAQ](https://docs.newapi.pro/en/docs/support/faq) | +| 💬 Interaction avec la communauté | [Canaux de communication](https://docs.newapi.pro/en/docs/support/community-interaction) | +| 🐛 Commentaires sur les problèmes | [Commentaires sur les problèmes](https://docs.newapi.pro/en/docs/support/feedback-issues) | +| 📚 Documentation complète | [Documentation officielle](https://docs.newapi.pro/en/docs) | ### 🤝 Guide de contribution @@ -437,7 +437,7 @@ Bienvenue à toutes les formes de contribution! Si ce projet vous est utile, bienvenue à nous donner une ⭐️ Étoile! -**[Documentation officielle](https://docs.newapi.pro/)** • **[Commentaires sur les problèmes](https://github.com/Calcium-Ion/new-api/issues)** • **[Dernière version](https://github.com/Calcium-Ion/new-api/releases)** +**[Documentation officielle](https://docs.newapi.pro/en/docs)** • **[Commentaires sur les problèmes](https://github.com/Calcium-Ion/new-api/issues)** • **[Dernière version](https://github.com/Calcium-Ion/new-api/releases)** Construit avec ❤️ par QuantumNous diff --git a/README.ja.md b/README.ja.md index e76cd0ed4..68adbebec 100644 --- a/README.ja.md +++ b/README.ja.md @@ -146,7 +146,7 @@ docker run --name new-api -d --restart always \ 🎉 デプロイが完了したら、`http://localhost:3000` にアクセスして使用を開始してください! -📖 その他のデプロイ方法については[デプロイガイド](https://docs.newapi.pro/installation)を参照してください。 +📖 その他のデプロイ方法については[デプロイガイド](https://docs.newapi.pro/ja/docs/installation)を参照してください。 --- @@ -154,7 +154,7 @@ docker run --name new-api -d --restart always \
-### 📖 [公式ドキュメント](https://docs.newapi.pro/) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +### 📖 [公式ドキュメント](https://docs.newapi.pro/ja/docs) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api)
@@ -162,17 +162,17 @@ docker run --name new-api -d --restart always \ | カテゴリ | リンク | |------|------| -| 🚀 デプロイガイド | [インストールドキュメント](https://docs.newapi.pro/installation) | -| ⚙️ 環境設定 | [環境変数](https://docs.newapi.pro/installation/environment-variables) | -| 📡 APIドキュメント | [APIドキュメント](https://docs.newapi.pro/api) | -| ❓ よくある質問 | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 コミュニティ交流 | [交流チャネル](https://docs.newapi.pro/support/community-interaction) | +| 🚀 デプロイガイド | [インストールドキュメント](https://docs.newapi.pro/ja/docs/installation) | +| ⚙️ 環境設定 | [環境変数](https://docs.newapi.pro/ja/docs/installation/config-maintenance/environment-variables) | +| 📡 APIドキュメント | [APIドキュメント](https://docs.newapi.pro/ja/docs/api) | +| ❓ よくある質問 | [FAQ](https://docs.newapi.pro/ja/docs/support/faq) | +| 💬 コミュニティ交流 | [交流チャネル](https://docs.newapi.pro/ja/docs/support/community-interaction) | --- ## ✨ 主な機能 -> 詳細な機能については[機能説明](https://docs.newapi.pro/wiki/features-introduction)を参照してください。 +> 詳細な機能については[機能説明](https://docs.newapi.pro/ja/docs/guide/wiki/basic-concepts/features-introduction)を参照してください。 ### 🎨 コア機能 @@ -202,15 +202,15 @@ docker run --name new-api -d --restart always \ ### 🚀 高度な機能 **APIフォーマットサポート:** -- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) -- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime)(Azureを含む) -- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) -- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) -- 🔄 [Rerankモデル](https://docs.newapi.pro/api/jinaai-rerank) -- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime) -- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) -- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) -- 🔄 [Rerankモデル](https://docs.newapi.pro/api/jinaai-rerank)(Cohere、Jina) +- ⚡ [OpenAI Responses](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-response) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/ja/docs/api/ai-model/realtime/create-realtime-session)(Azureを含む) +- ⚡ [Claude Messages](https://docs.newapi.pro/ja/docs/api/ai-model/chat/create-message) +- ⚡ [Google Gemini](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-chat-completion) +- 🔄 [Rerankモデル](https://docs.newapi.pro/ja/docs/api/ai-model/rerank/create-rerank) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/ja/docs/api/ai-model/realtime/create-realtime-session) +- ⚡ [Claude Messages](https://docs.newapi.pro/ja/docs/api/ai-model/chat/create-message) +- ⚡ [Google Gemini](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-chat-completion) +- 🔄 [Rerankモデル](https://docs.newapi.pro/ja/docs/api/ai-model/rerank/create-rerank)(Cohere、Jina) **インテリジェントルーティング:** - ⚖️ チャネル重み付けランダム @@ -251,16 +251,16 @@ docker run --name new-api -d --restart always \ ## 🤖 モデルサポート -> 詳細については[APIドキュメント - 中継インターフェース](https://docs.newapi.pro/api) +> 詳細については[APIドキュメント - 中継インターフェース](https://docs.newapi.pro/ja/docs/api) | モデルタイプ | 説明 | ドキュメント | |---------|------|------| | 🤖 OpenAI GPTs | gpt-4-gizmo-* シリーズ | - | -| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [ドキュメント](https://docs.newapi.pro/api/midjourney-proxy-image) | -| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [ドキュメント](https://docs.newapi.pro/api/suno-music) | -| 🔄 Rerank | Cohere、Jina | [ドキュメント](https://docs.newapi.pro/api/jinaai-rerank) | -| 💬 Claude | Messagesフォーマット | [ドキュメント](https://docs.newapi.pro/api/suno-music) | -| 🌐 Gemini | Google Geminiフォーマット | [ドキュメント](https://docs.newapi.pro/api/google-gemini-chat/) | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [ドキュメント](https://docs.newapi.pro/ja/docs/guide/console/drawing-log) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [ドキュメント](https://docs.newapi.pro/ja/docs/guide/console/task-log) | +| 🔄 Rerank | Cohere、Jina | [ドキュメント](https://docs.newapi.pro/ja/docs/api/ai-model/rerank/create-rerank) | +| 💬 Claude | Messagesフォーマット | [ドキュメント](https://docs.newapi.pro/ja/docs/api/ai-model/chat/create-message) | +| 🌐 Gemini | Google Geminiフォーマット | [ドキュメント](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-chat-completion) | | 🔧 Dify | ChatFlowモード | - | | 🎯 カスタム | 完全な呼び出しアドレスの入力をサポート | - | @@ -269,16 +269,16 @@ docker run --name new-api -d --restart always \
完全なインターフェースリストを表示 -- [チャットインターフェース (Chat Completions)](https://docs.newapi.pro/api/openai-chat) -- [レスポンスインターフェース (Responses)](https://docs.newapi.pro/api/openai-responses) -- [イメージインターフェース (Image)](https://docs.newapi.pro/api/openai-image) -- [オーディオインターフェース (Audio)](https://docs.newapi.pro/api/openai-audio) -- [ビデオインターフェース (Video)](https://docs.newapi.pro/api/openai-video) -- [エンベッドインターフェース (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) -- [再ランク付けインターフェース (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) -- [リアルタイム対話インターフェース (Realtime)](https://docs.newapi.pro/api/openai-realtime) -- [Claudeチャット](https://docs.newapi.pro/api/anthropic-chat) -- [Google Geminiチャット](https://docs.newapi.pro/api/google-gemini-chat/) +- [チャットインターフェース (Chat Completions)](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-chat-completion) +- [レスポンスインターフェース (Responses)](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-response) +- [イメージインターフェース (Image)](https://docs.newapi.pro/ja/docs/api/ai-model/images/openai/v1-images-generations--post) +- [オーディオインターフェース (Audio)](https://docs.newapi.pro/ja/docs/api/ai-model/audio/openai/create-transcription) +- [ビデオインターフェース (Video)](https://docs.newapi.pro/ja/docs/api/ai-model/videos/create-video-generation) +- [エンベッドインターフェース (Embeddings)](https://docs.newapi.pro/ja/docs/api/ai-model/embeddings/create-embedding) +- [再ランク付けインターフェース (Rerank)](https://docs.newapi.pro/ja/docs/api/ai-model/rerank/create-rerank) +- [リアルタイム対話インターフェース (Realtime)](https://docs.newapi.pro/ja/docs/api/ai-model/realtime/create-realtime-session) +- [Claudeチャット](https://docs.newapi.pro/ja/docs/api/ai-model/chat/create-message) +- [Google Geminiチャット](https://docs.newapi.pro/ja/docs/api/ai-model/chat/openai/create-chat-completion)
@@ -314,7 +314,7 @@ docker run --name new-api -d --restart always \ | `AZURE_DEFAULT_API_VERSION` | Azure APIバージョン | `2025-04-01-preview` | | `ERROR_LOG_ENABLED` | エラーログスイッチ | `false` | -📖 **完全な設定:** [環境変数ドキュメント](https://docs.newapi.pro/installation/environment-variables) +📖 **完全な設定:** [環境変数ドキュメント](https://docs.newapi.pro/ja/docs/installation/config-maintenance/environment-variables) @@ -414,10 +414,10 @@ docker run --name new-api -d --restart always \ | リソース | リンク | |------|------| -| 📘 よくある質問 | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 コミュニティ交流 | [交流チャネル](https://docs.newapi.pro/support/community-interaction) | -| 🐛 問題のフィードバック | [問題フィードバック](https://docs.newapi.pro/support/feedback-issues) | -| 📚 完全なドキュメント | [公式ドキュメント](https://docs.newapi.pro/support) | +| 📘 よくある質問 | [FAQ](https://docs.newapi.pro/ja/docs/support/faq) | +| 💬 コミュニティ交流 | [交流チャネル](https://docs.newapi.pro/ja/docs/support/community-interaction) | +| 🐛 問題のフィードバック | [問題フィードバック](https://docs.newapi.pro/ja/docs/support/feedback-issues) | +| 📚 完全なドキュメント | [公式ドキュメント](https://docs.newapi.pro/ja/docs) | ### 🤝 貢献ガイド @@ -446,7 +446,7 @@ docker run --name new-api -d --restart always \ このプロジェクトがあなたのお役に立てたなら、ぜひ ⭐️ スターをください! -**[公式ドキュメント](https://docs.newapi.pro/)** • **[問題フィードバック](https://github.com/Calcium-Ion/new-api/issues)** • **[最新リリース](https://github.com/Calcium-Ion/new-api/releases)** +**[公式ドキュメント](https://docs.newapi.pro/ja/docs)** • **[問題フィードバック](https://github.com/Calcium-Ion/new-api/issues)** • **[最新リリース](https://github.com/Calcium-Ion/new-api/releases)** ❤️ で構築された QuantumNous diff --git a/README.md b/README.md index f1cb37480..4f87e9e4e 100644 --- a/README.md +++ b/README.md @@ -146,7 +146,7 @@ docker run --name new-api -d --restart always \ 🎉 部署完成后,访问 `http://localhost:3000` 即可使用! -📖 更多部署方式请参考 [部署指南](https://docs.newapi.pro/installation) +📖 更多部署方式请参考 [部署指南](https://docs.newapi.pro/zh/docs/installation) --- @@ -154,7 +154,7 @@ docker run --name new-api -d --restart always \
-### 📖 [官方文档](https://docs.newapi.pro/) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +### 📖 [官方文档](https://docs.newapi.pro/zh/docs) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api)
@@ -162,17 +162,17 @@ docker run --name new-api -d --restart always \ | 分类 | 链接 | |------|------| -| 🚀 部署指南 | [安装文档](https://docs.newapi.pro/installation) | -| ⚙️ 环境配置 | [环境变量](https://docs.newapi.pro/installation/environment-variables) | -| 📡 接口文档 | [API 文档](https://docs.newapi.pro/api) | -| ❓ 常见问题 | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 社区交流 | [交流渠道](https://docs.newapi.pro/support/community-interaction) | +| 🚀 部署指南 | [安装文档](https://docs.newapi.pro/zh/docs/installation) | +| ⚙️ 环境配置 | [环境变量](https://docs.newapi.pro/zh/docs/installation/config-maintenance/environment-variables) | +| 📡 接口文档 | [API 文档](https://docs.newapi.pro/zh/docs/api) | +| ❓ 常见问题 | [FAQ](https://docs.newapi.pro/zh/docs/support/faq) | +| 💬 社区交流 | [交流渠道](https://docs.newapi.pro/zh/docs/support/community-interaction) | --- ## ✨ 主要特性 -> 详细特性请参考 [特性说明](https://docs.newapi.pro/wiki/features-introduction) +> 详细特性请参考 [特性说明](https://docs.newapi.pro/zh/docs/guide/wiki/basic-concepts/features-introduction) ### 🎨 核心功能 @@ -202,11 +202,11 @@ docker run --name new-api -d --restart always \ ### 🚀 高级功能 **API 格式支持:** -- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) -- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime)(含 Azure) -- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) -- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) -- 🔄 [Rerank 模型](https://docs.newapi.pro/api/jinaai-rerank)(Cohere、Jina) +- ⚡ [OpenAI Responses](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-response) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/zh/docs/api/ai-model/realtime/create-realtime-session)(含 Azure) +- ⚡ [Claude Messages](https://docs.newapi.pro/zh/docs/api/ai-model/chat/create-message) +- ⚡ [Google Gemini](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-chat-completion) +- 🔄 [Rerank 模型](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank)(Cohere、Jina) **智能路由:** - ⚖️ 渠道加权随机 @@ -247,16 +247,16 @@ docker run --name new-api -d --restart always \ ## 🤖 模型支持 -> 详情请参考 [接口文档 - 中继接口](https://docs.newapi.pro/api) +> 详情请参考 [接口文档 - 中继接口](https://docs.newapi.pro/zh/docs/api) | 模型类型 | 说明 | 文档 | |---------|------|------| | 🤖 OpenAI GPTs | gpt-4-gizmo-* 系列 | - | -| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [文档](https://docs.newapi.pro/api/midjourney-proxy-image) | -| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [文档](https://docs.newapi.pro/api/suno-music) | -| 🔄 Rerank | Cohere、Jina | [文档](https://docs.newapi.pro/api/jinaai-rerank) | -| 💬 Claude | Messages 格式 | [文档](https://docs.newapi.pro/api/anthropic-chat) | -| 🌐 Gemini | Google Gemini 格式 | [文档](https://docs.newapi.pro/api/google-gemini-chat/) | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [文档](https://docs.newapi.pro/zh/docs/guide/console/drawing-log) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [文档](https://docs.newapi.pro/zh/docs/guide/console/task-log) | +| 🔄 Rerank | Cohere、Jina | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank) | +| 💬 Claude | Messages 格式 | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/chat/create-message) | +| 🌐 Gemini | Google Gemini 格式 | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-chat-completion) | | 🔧 Dify | ChatFlow 模式 | - | | 🎯 自定义 | 支持完整调用地址 | - | @@ -265,16 +265,16 @@ docker run --name new-api -d --restart always \
查看完整接口列表 -- [聊天接口 (Chat Completions)](https://docs.newapi.pro/api/openai-chat) -- [响应接口 (Responses)](https://docs.newapi.pro/api/openai-responses) -- [图像接口 (Image)](https://docs.newapi.pro/api/openai-image) -- [音频接口 (Audio)](https://docs.newapi.pro/api/openai-audio) -- [视频接口 (Video)](https://docs.newapi.pro/api/openai-video) -- [嵌入接口 (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) -- [重排序接口 (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) -- [实时对话 (Realtime)](https://docs.newapi.pro/api/openai-realtime) -- [Claude 聊天](https://docs.newapi.pro/api/anthropic-chat) -- [Google Gemini 聊天](https://docs.newapi.pro/api/google-gemini-chat) +- [聊天接口 (Chat Completions)](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-chat-completion) +- [响应接口 (Responses)](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-response) +- [图像接口 (Image)](https://docs.newapi.pro/zh/docs/api/ai-model/images/openai/v1-images-generations--post) +- [音频接口 (Audio)](https://docs.newapi.pro/zh/docs/api/ai-model/audio/openai/create-transcription) +- [视频接口 (Video)](https://docs.newapi.pro/zh/docs/api/ai-model/videos/create-video-generation) +- [嵌入接口 (Embeddings)](https://docs.newapi.pro/zh/docs/api/ai-model/embeddings/create-embedding) +- [重排序接口 (Rerank)](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank) +- [实时对话 (Realtime)](https://docs.newapi.pro/zh/docs/api/ai-model/realtime/create-realtime-session) +- [Claude 聊天](https://docs.newapi.pro/zh/docs/api/ai-model/chat/create-message) +- [Google Gemini 聊天](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-chat-completion)
@@ -310,7 +310,7 @@ docker run --name new-api -d --restart always \ | `AZURE_DEFAULT_API_VERSION` | Azure API 版本 | `2025-04-01-preview` | | `ERROR_LOG_ENABLED` | 错误日志开关 | `false` | -📖 **完整配置:** [环境变量文档](https://docs.newapi.pro/installation/environment-variables) +📖 **完整配置:** [环境变量文档](https://docs.newapi.pro/zh/docs/installation/config-maintenance/environment-variables) @@ -412,10 +412,10 @@ docker run --name new-api -d --restart always \ | 资源 | 链接 | |------|------| -| 📘 常见问题 | [FAQ](https://docs.newapi.pro/support/faq) | -| 💬 社区交流 | [交流渠道](https://docs.newapi.pro/support/community-interaction) | -| 🐛 反馈问题 | [问题反馈](https://docs.newapi.pro/support/feedback-issues) | -| 📚 完整文档 | [官方文档](https://docs.newapi.pro/support) | +| 📘 常见问题 | [FAQ](https://docs.newapi.pro/zh/docs/support/faq) | +| 💬 社区交流 | [交流渠道](https://docs.newapi.pro/zh/docs/support/community-interaction) | +| 🐛 反馈问题 | [问题反馈](https://docs.newapi.pro/zh/docs/support/feedback-issues) | +| 📚 完整文档 | [官方文档](https://docs.newapi.pro/zh/docs) | ### 🤝 贡献指南 @@ -444,7 +444,7 @@ docker run --name new-api -d --restart always \ 如果这个项目对你有帮助,欢迎给我们一个 ⭐️ Star! -**[官方文档](https://docs.newapi.pro/)** • **[问题反馈](https://github.com/Calcium-Ion/new-api/issues)** • **[最新发布](https://github.com/Calcium-Ion/new-api/releases)** +**[官方文档](https://docs.newapi.pro/zh/docs)** • **[问题反馈](https://github.com/Calcium-Ion/new-api/issues)** • **[最新发布](https://github.com/Calcium-Ion/new-api/releases)** Built with ❤️ by QuantumNous