ItzRoBeerT commited on
Commit
a824c22
·
1 Parent(s): f810b2f

updated readme

Browse files
Files changed (1) hide show
  1. README.md +10 -99
README.md CHANGED
@@ -1,99 +1,10 @@
1
- # 🧑‍🍳 WAIter: Voice Chatbot for Restaurants
2
-
3
- WAIter es un chatbot interactivo con capacidades de voz diseñado para escenarios de restaurantes. Simula un camarero amigable y servicial que puede responder a las preguntas habladas de los clientes en tiempo real, utilizando tecnologías de reconocimiento de voz, modelos de lenguaje avanzados y síntesis de voz natural.
4
-
5
- ## 🛠️ Stack Tecnológico
6
-
7
- - **Procesamiento de Voz**:
8
- - 🎙️ [FastRTC](https://fastrtc.org) para streaming de audio en tiempo real
9
- - 🔊 [ElevenLabs](https://elevenlabs.io/) para síntesis de voz expresiva (TTS)
10
- - 🗣️ [Whisper](https://openai.com/research/whisper) (vía Groq) para reconocimiento de voz
11
-
12
- - **Inteligencia Artificial de Lenguaje**:
13
- - 💬 [LangChain](https://www.langchain.com/) para orquestación de LLMs
14
- - 🔄 [LangGraph](https://github.com/langchain-ai/langgraph) para flujos de trabajo de agentes
15
- - 🧠 [Gemini 2.5](https://deepmind.google/technologies/gemini/) (vía OpenRouter) para procesamiento de lenguaje natural
16
-
17
- - **Gestión de Datos**:
18
- - 🔍 Embeddings vectoriales con HuggingFace (BAAI/bge-m3)
19
- - 💾 Datos de menú almacenados en formato Markdown
20
- - 🗄️ [Supabase](https://supabase.com/) para almacenamiento y procesamiento de pedidos
21
-
22
- - **Interfaz**:
23
- - 🧪 [Gradio](https://www.gradio.app/) para la interfaz web interactiva
24
-
25
- ## 🚀 Características
26
-
27
- - **Interacción por voz en tiempo real** con un asistente virtual de camarero
28
- - **Consulta de información del menú** con respuestas contextuales sobre platos, precios y opciones
29
- - **Procesamiento de pedidos** con capacidad para enviar órdenes directamente a sistemas de cocina
30
- - **Flujo conversacional natural** usando LangGraph para orquestación compleja de agentes
31
- - **Integración de base de conocimientos** con RAG (Retrieval Augmented Generation)
32
- - **Memoria de conversación multi-turno** para respuestas contextuales
33
- - **Gestión de pedidos** con almacenamiento en Supabase y sistema de seguimiento
34
- - **Síntesis de voz expresiva** con ElevenLabs para respuestas naturales y fluidas
35
-
36
- ## 🚀 Primeros Pasos
37
-
38
- 1. Clona este repositorio
39
- 2. Instala las dependencias: `pip install -r requirements.txt` (requiere Python 3.10+)
40
- 3. Crea un archivo `.env` con tus claves API:
41
- ```
42
- OPENROUTER_API_KEY=tu_clave_openrouter
43
- OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
44
- GROQ_API_KEY=tu_clave_groq
45
- ELEVENLABS_API_KEY=tu_clave_elevenlabs
46
- HELICONE_API_KEY=tu_clave_helicone_opcional
47
- SUPABASE_URL=tu_url_supabase
48
- SUPABASE_KEY=tu_clave_supabase
49
- ```
50
- 4. Ejecuta la aplicación: `python app.py`
51
- 5. Abre la interfaz de Gradio en tu navegador
52
-
53
- ## 🗂️ Estructura del Proyecto
54
-
55
- - `app.py` - Punto de entrada principal con interfaz Gradio
56
- - `agent.py` - Implementación del agente LangGraph para asistente de restaurante
57
- - `model.py` - Gestor para la creación y configuración de modelos de lenguaje
58
- - `tools.py` - Herramientas personalizadas para consulta de menú y envío de pedidos
59
- - `supabase_client.py` - Cliente para operaciones con la base de datos Supabase
60
- - `data/carta.md` - Datos del menú del restaurante en formato Markdown
61
- - `utils/` - Módulos de utilidad:
62
- - `functions.py` - Funciones auxiliares para manejo de mensajes y modelos
63
- - `logger.py` - Sistema de registro con colores para depuración
64
- - `classes.py` - Clases de datos como `Order` para representar pedidos
65
-
66
- ## 🧠 Cómo Funciona
67
-
68
- 1. **Reconocimiento de Voz**: FastRTC captura audio del micrófono del usuario y lo envía a la API Whisper de Groq para transcripción
69
- 2. **Procesamiento de Lenguaje Natural**: El texto transcrito se pasa al agente LangGraph
70
- 3. **Procesamiento RAG**: El agente utiliza búsqueda vectorial para encontrar información relevante del menú
71
- 4. **Herramientas del Agente**: El sistema utiliza herramientas especializadas para:
72
- - Búsqueda de información en el menú (vectores)
73
- - Envío de pedidos a cocina (integración Supabase)
74
- 5. **Generación de Respuesta**: Gemini 2.5 (a través de OpenRouter) genera una respuesta contextual y útil
75
- 6. **Síntesis de Voz**: ElevenLabs convierte la respuesta de texto a voz natural
76
- 7. **Interfaz Web**: Gradio renderiza la conversación y reproduce la respuesta de audio
77
-
78
- ## 📦 Requisitos del Sistema
79
-
80
- Los requisitos detallados se encuentran en el archivo `requirements.txt`. Las principales dependencias incluyen:
81
-
82
- - Python 3.10+
83
- - gradio >= 4.26.0
84
- - langchain >= 0.1.0 (con varios componentes adicionales)
85
- - fastrtc >= 0.6.0
86
- - elevenlabs >= 0.2.24
87
- - groq >= 0.4.0
88
- - supabase >= 2.0.0
89
- - sentence-transformers >= 2.2.2
90
-
91
- ## 📝 Licencia
92
-
93
- [MIT License](LICENSE)
94
-
95
- ---
96
-
97
- 🌐 Desarrollado por Roberto - 2024
98
-
99
-
 
1
+ title: WAIter
2
+ emoji: 👨🏼‍🍳
3
+ colorFrom: indigo
4
+ colorTo: indigo
5
+ sdk: gradio
6
+ sdk_version: 5.25.2
7
+ app_file: app.py
8
+ pinned: false
9
+ hf_oauth: true
10
+ hf_oauth_expiration_minutes: 480