Update README.md
Browse files
README.md
CHANGED
|
@@ -1,10 +1,87 @@
|
|
| 1 |
---
|
| 2 |
-
title: API
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: purple
|
| 5 |
colorTo: indigo
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
|
|
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: CygnisAI Studio API
|
| 3 |
+
emoji: 🦢
|
| 4 |
colorFrom: purple
|
| 5 |
colorTo: indigo
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
+
app_port: 7860
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# 🦢 CygnisAI Studio API
|
| 12 |
+
|
| 13 |
+
Une API unifiée et performante pour accéder aux meilleurs modèles d'IA open-source via l'infrastructure Hugging Face.
|
| 14 |
+
|
| 15 |
+
Cette API agit comme une passerelle sécurisée et intelligente, routant vos requêtes vers les modèles les plus adaptés (Llama 3, Gemma 2, DeepSeek, etc.) avec une interface compatible OpenAI.
|
| 16 |
+
|
| 17 |
+
## 🚀 Fonctionnalités
|
| 18 |
+
|
| 19 |
+
- **Multi-modèles** : Accès à une large gamme de LLMs via un seul endpoint.
|
| 20 |
+
- **Sécurisé** : Authentification par Bearer Token.
|
| 21 |
+
- **Standardisé** : Format de requête et de réponse JSON simple.
|
| 22 |
+
- **Robuste** : Gestion automatique des erreurs et fallbacks.
|
| 23 |
+
|
| 24 |
+
## 🛠️ Utilisation
|
| 25 |
+
|
| 26 |
+
### Endpoint Principal
|
| 27 |
+
|
| 28 |
+
`POST /api/ask`
|
| 29 |
+
|
| 30 |
+
### Authentification
|
| 31 |
+
|
| 32 |
+
Ajoutez le header suivant à vos requêtes :
|
| 33 |
+
`Authorization: Bearer VOTRE_CLE_API`
|
| 34 |
+
|
| 35 |
+
*(La clé par défaut pour la démo est : `cgn_live_stable_demo_api_key_012345`)*
|
| 36 |
+
|
| 37 |
+
### Exemple de Requête (JavaScript / Fetch)
|
| 38 |
+
|
| 39 |
+
```javascript
|
| 40 |
+
fetch('https://votre-space-url.hf.space/api/ask', {
|
| 41 |
+
method: 'POST',
|
| 42 |
+
headers: {
|
| 43 |
+
'Authorization': 'Bearer cgn_live_stable_demo_api_key_012345',
|
| 44 |
+
'Content-Type': 'application/json',
|
| 45 |
+
},
|
| 46 |
+
body: JSON.stringify({
|
| 47 |
+
question: 'Qui a découvert la pénicilline ?',
|
| 48 |
+
model: 'google/gemma-3-27b-it', // Optionnel
|
| 49 |
+
system_prompt: 'Tu es un expert en histoire des sciences.' // Optionnel
|
| 50 |
+
}),
|
| 51 |
+
})
|
| 52 |
+
.then(response => response.json())
|
| 53 |
+
.then(data => console.log(data));
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
### Exemple de Réponse
|
| 57 |
+
|
| 58 |
+
```json
|
| 59 |
+
{
|
| 60 |
+
"answer": "La pénicilline a été découverte par Alexander Fleming en 1928...",
|
| 61 |
+
"model_used": "google/gemma-2-27b-it",
|
| 62 |
+
"sources": []
|
| 63 |
+
}
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
## 🤖 Modèles Disponibles
|
| 67 |
+
|
| 68 |
+
Vous pouvez demander ces modèles via le paramètre `model`. L'API routera automatiquement vers la version la plus performante disponible.
|
| 69 |
+
|
| 70 |
+
| ID du Modèle (Alias) | Modèle Réel Utilisé (Fallback) | Description |
|
| 71 |
+
|---|---|---|
|
| 72 |
+
| `google/gemma-3-27b-it` | Gemma 2 27B IT | Rapide et efficace |
|
| 73 |
+
| `openai/gpt-oss-120b` | Llama 3.1 70B | Très puissant, équivalent GPT-4 |
|
| 74 |
+
| `deepseek-ai/DeepSeek-V3.2` | DeepSeek V3 | Excellent pour le code et la logique |
|
| 75 |
+
| `meta-llama/Llama-4-Scout` | Llama 3.1 8B | Léger et ultra-rapide |
|
| 76 |
+
| `nvidia/Nemotron-3` | Llama 3.1 Nemotron 70B | Spécialisé instruction-following |
|
| 77 |
+
| `default` | Llama 3 8B | Le choix par défaut équilibré |
|
| 78 |
+
|
| 79 |
+
## ⚙️ Configuration (Pour le déploiement)
|
| 80 |
+
|
| 81 |
+
Pour déployer cette API sur votre propre Space, vous devez configurer les **Secrets** suivants dans les paramètres du Space :
|
| 82 |
+
|
| 83 |
+
1. `HF_TOKEN` : Votre token d'accès Hugging Face (avec droits de lecture).
|
| 84 |
+
2. `CYGNIS_API_KEY` : (Optionnel) La clé API que vous souhaitez utiliser pour sécuriser l'accès.
|
| 85 |
+
|
| 86 |
+
---
|
| 87 |
+
*Propulsé par FastAPI, Docker et l'Inference API Hugging Face.*
|