textgen / README.md
1dm's picture
Update README.md
cd247f7 verified
---
title: NLP Space - API Texte (Phi-3 Mini)
emoji: 🧠
colorFrom: indigo
colorTo: purple
sdk: docker
cpu: true
app_file: app.py
pinned: true
---
# 🧠 NLP Space API (1dm/textgen)
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.
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.
## 🚀 Architecture et Modèle
* **Modèle LLM :** `microsoft/Phi-3-mini-4k-instruct` (3.8B paramètres)
* **Framework :** FastAPI
* **Déploiement :** Docker (Mode API)
* **Objectif :** Remplacer GPT/Gemini pour les tâches de texte courantes dans n8n et vos SaaS.
## 🛠 Utilisation de l'API REST
L'API est accessible via l'URL de votre Space.
**URL de Base :** `https://huggingface.co/spaces/1dm/textgen`
Toutes les requêtes doivent être de type `POST` et envoyer un corps JSON.
### Schéma de Requête (JSON Body)
| Paramètre | Type | Description | Défaut |
| :--- | :--- | :--- | :--- |
| `prompt` | `string` | Le texte d'entrée ou l'instruction à traiter. | *(Obligatoire)* |
| `max_tokens` | `integer` | Longueur maximale de la réponse générée (tokens). | `500` |
| `temperature` | `float` | Contrôle la créativité (0.1 = factuel, 1.0 = créatif). | `0.7` |
---
## 1. Endpoint : `/generate`
**Fonction :** Génération de texte libre (articles, titres, idées, scripts, etc.).
* **Méthode :** `POST`
* **URL Complète :** `https://de-base.com//generate`
### 💻 Exemple dans n8n (HTTP Request)
```json
{
"prompt": "Écris 5 idées de titres percutants pour un post LinkedIn sur le déploiement d'une IA gratuite.",
"max_tokens": 150,
"temperature": 0.8
}