Create exampleapi.md

exampleapi.md

@@ -0,0 +1,119 @@
+---
+title: NLP Space - API Texte (Phi-3 Mini)
+emoji: 🧠
+colorFrom: indigo
+colorTo: purple
+sdk: docker
+cpu: true
+app_file: app.py
+pinned: true
+---
+
+
+# ⚡ Utilisation de l'API textgen (Space NLP)
+
+Ce document fournit des exemples d'utilisation de l'API REST déployée sur votre Space Hugging Face `1dm/textgen`.
+
+L'**URL de base** de l'API est : `https://1dm-textgen.hf.space`
+
+Toutes les requêtes utilisent la méthode **POST** et acceptent un corps JSON.
+
+### Schéma de Requête JSON
+
+| Paramètre | Type | Description |
+| :--- | :--- | :--- |
+| `prompt` | `string` | Le texte ou l'instruction (obligatoire). |
+| `max_tokens` | `integer` | Longueur maximale de la réponse (défaut: 500). |
+| `temperature` | `float` | Créativité (0.1 = déterministe, 1.0 = aléatoire, défaut: 0.7). |
+
+---
+
+## 1. 🌐 Utilisation avec n8n (HTTP Request Node)
+
+L'outil le plus courant pour intégrer votre API dans un workflow d'automatisation est le nœud **HTTP Request** de n8n.
+
+### Exemple 1 : Générer un Titre Viral (`/generate`)
+
+| Paramètre n8n | Valeur |
+| :--- | :--- |
+| **URL** | `https://1dm-textgen.hf.space/generate` |
+| **Method** | `POST` |
+| **Body (JSON/Raw)** | `{ "prompt": "Écris 5 titres YouTube pour une vidéo sur l'IA gratuite", "max_tokens": 150, "temperature": 0.8 }` |
+
+**Récupération du Résultat :**
+Le résultat se trouve dans la propriété `result` de la réponse JSON.
+
+### Exemple 2 : Classifier un Sentiment (`/classify`)
+
+| Paramètre n8n | Valeur |
+| :--- | :--- |
+| **URL** | `https://1dm-textgen.hf.space/classify` |
+| **Method** | `POST` |
+| **Body (JSON/Raw)** | `{ "prompt": "Classifie le sentiment de ce commentaire [positif/négatif/neutre] : 'Cette API est super rapide pour un CPU !'", "max_tokens": 10 }` |
+
+---
+
+## 2. 💻 Utilisation avec `curl` (Test en Ligne de Commande)
+
+`curl` est parfait pour tester rapidement les endpoints et vérifier que votre API répond correctement.
+
+### Exemple 1 : Résumer un Texte (`/summarize`)
+
+```bash
+curl -X POST "[https://1dm-textgen.hf.space/summarize](https://1dm-textgen.hf.space/summarize)" \
+-H "Content-Type: application/json" \
+-d '{
+    "prompt": "L\'automatisation No-Code permet aux utilisateurs non-techniques de construire des workflows complexes en utilisant des interfaces visuelles plutôt que du code. n8n est un exemple populaire de ce type d\'outil.",
+    "max_tokens": 80
+}'
+
+```
+### Exemple 2 : Génération de Texte (/generate)
+```
+curl -X POST "[https://1dm-textgen.hf.space/generate](https://1dm-textgen.hf.space/generate)" \
+-H "Content-Type: application/json" \
+-d '{
+    "prompt": "Rédige une courte description optimisée pour le SEO sur le thème du No-Code.",
+    "max_tokens": 200,
+    "temperature": 0.5
+}'
+```
+### 3. 🐍 Utilisation avec Python (index.py / Script)
+Pour l'intégration dans un script backend (SaaS, microservice), utilisez la librairie requests.
+
+Fichier index.py
+
+
+```
+import requests
+import json
+
+API_BASE_URL = "[https://1dm-textgen.hf.space](https://1dm-textgen.hf.space)"
+
+def generate_content(prompt_text):
+    """Appelle l'endpoint /generate."""
+    url = f"{API_BASE_URL}/generate"
+    payload = {
+        "prompt": prompt_text,
+        "max_tokens": 300,
+        "temperature": 0.7
+    }
+    
+    try:
+        response = requests.post(url, json=payload)
+        response.raise_for_status() # Lève une exception pour les codes d'erreur HTTP
+        data = response.json()
+        
+        return data.get("result", "Erreur : Résultat non trouvé.")
+        
+    except requests.exceptions.RequestException as e:
+        return f"Erreur de connexion à l'API : {e}"
+
+# --- Utilisation ---
+prompt_user = "Écris une courte introduction pour un article sur les avantages de l'utilisation des Spaces Hugging Face."
+resultat = generate_content(prompt_user)
+
+print("--- Résultat de Génération ---")
+print(resultat)
+
+```