1dm commited on
Commit
3dc35cd
·
verified ·
1 Parent(s): 3d3cafc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +44 -8
README.md CHANGED
@@ -1,10 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: Textgen
3
- emoji: 📈
4
- colorFrom: purple
5
- colorTo: pink
6
- sdk: docker
7
- pinned: false
8
- ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 🧠 NLP Space API (1dm/textgen)
2
+
3
+ Ce Space Hugging Face déploie une **API REST** basée sur **FastAPI** pour effectuer des tâches de Traitement du Langage Naturel (NLP) courantes.
4
+
5
+ Il remplace l'utilisation des API payantes (OpenAI, Gemini) par un modèle de langage léger, **Phi-3 Mini-4K-Instruct**, optimisé pour les environnements **CPU** comme le vôtre.
6
+
7
+ ## 🚀 Architecture et Modèle
8
+
9
+ * **Modèle LLM :** `microsoft/Phi-3-mini-4k-instruct` (3.8B paramètres)
10
+ * **Framework :** FastAPI
11
+ * **Déploiement :** Docker (Mode API)
12
+ * **Objectif :** Remplacer GPT/Gemini pour les tâches de texte courantes dans n8n et vos SaaS.
13
+
14
+ ## 🛠 Utilisation de l'API REST
15
+
16
+ L'API est accessible via l'URL de votre Space.
17
+
18
+ **URL de Base :** `https://huggingface.co/spaces/1dm/textgen`
19
+
20
+ Toutes les requêtes doivent être de type `POST` et envoyer un corps JSON.
21
+
22
+ ### Schéma de Requête (JSON Body)
23
+
24
+ | Paramètre | Type | Description | Défaut |
25
+ | :--- | :--- | :--- | :--- |
26
+ | `prompt` | `string` | Le texte d'entrée ou l'instruction à traiter. | *(Obligatoire)* |
27
+ | `max_tokens` | `integer` | Longueur maximale de la réponse générée (tokens). | `500` |
28
+ | `temperature` | `float` | Contrôle la créativité (0.1 = factuel, 1.0 = créatif). | `0.7` |
29
+
30
  ---
 
 
 
 
 
 
 
31
 
32
+ ## 1. Endpoint : `/generate`
33
+
34
+ **Fonction :** Génération de texte libre (articles, titres, idées, scripts, etc.).
35
+
36
+ * **Méthode :** `POST`
37
+ * **URL Complète :** `https://de-base.com//generate`
38
+
39
+ ### 💻 Exemple dans n8n (HTTP Request)
40
+
41
+ ```json
42
+ {
43
+ "prompt": "Écris 5 idées de titres percutants pour un post LinkedIn sur le déploiement d'une IA gratuite.",
44
+ "max_tokens": 150,
45
+ "temperature": 0.8
46
+ }