Peter Michael Gits Claude commited on
Commit
b4b0dea
Β·
1 Parent(s): af6cf39

feat: Update VoiceCal with comprehensive documentation v0.5.6

Browse files

- Complete rebrand to VoiceCal with professional README
- Add detailed feature documentation and architecture guide
- Include WebSocket service configuration instructions
- Add comprehensive .gitignore to prevent sensitive file commits
- Ready for production deployment on voiceCal space

πŸ€– Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

Files changed (2) hide show
  1. .gitignore +45 -0
  2. README.md +86 -6
.gitignore ADDED
@@ -0,0 +1,45 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Environment variables and secrets
2
+ .env
3
+ .env.local
4
+ .env.development
5
+ .env.test
6
+ .env.production
7
+
8
+ # Vim swap files
9
+ *.swp
10
+ *.swo
11
+ *~
12
+
13
+ # Python
14
+ __pycache__/
15
+ *.py[cod]
16
+ *$py.class
17
+
18
+ # Virtual environments
19
+ venv/
20
+ env/
21
+ ENV/
22
+
23
+ # IDE files
24
+ .vscode/
25
+ .idea/
26
+
27
+ # OS files
28
+ .DS_Store
29
+ Thumbs.db
30
+
31
+ # Logs
32
+ *.log
33
+
34
+ # Temporary files
35
+ *.tmp
36
+
37
+ # Hugging Face tokens and API keys
38
+ hf_token
39
+ *.hf_token
40
+ api_keys.txt
41
+ secrets.txt
42
+
43
+ # Gradio temporary files
44
+ gradio_cached_examples/
45
+ flagged/
README.md CHANGED
@@ -1,14 +1,94 @@
1
  ---
2
- title: VoiceCal
3
- emoji: πŸ“‰
4
- colorFrom: purple
5
- colorTo: red
6
  sdk: gradio
7
  sdk_version: 5.43.1
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
- short_description: voice Calendar
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: VoiceCal - Voice-Enabled AI Scheduling Assistant
3
+ emoji: πŸŽ€πŸ“…
4
+ colorFrom: blue
5
+ colorTo: purple
6
  sdk: gradio
7
  sdk_version: 5.43.1
8
  app_file: app.py
9
  pinned: false
10
  license: mit
11
+ short_description: Voice-enabled AI scheduling assistant
12
  ---
13
 
14
+ # πŸŽ€πŸ“… VoiceCal - Voice-Enabled AI Scheduling Assistant
15
+
16
+ An intelligent AI scheduling assistant with **voice interaction capabilities** powered by WebRTC, Whisper STT, and Bark TTS. Book Google Calendar appointments through natural conversation - now with voice input and audio responses!
17
+
18
+ > **πŸš€ New Deployment**: VoiceCal is the latest iteration with improved WebSocket-based voice services and enhanced reliability. Previous ChatCal.ai space has been superseded by this deployment.
19
+
20
+ ## 🎯 Features
21
+
22
+ ### πŸ—£οΈ Voice Interaction
23
+ - 🎀 **Real-time Speech-to-Text**: WebRTC audio capture with Whisper transcription
24
+ - πŸ”Š **Text-to-Speech Responses**: AI responses with natural voice synthesis
25
+ - 🎭 **Multiple Voice Options**: Choose from different voice personalities
26
+ - ⚑ **Real-time Processing**: Live transcription as you speak
27
+
28
+ ### πŸ“… Smart Calendar Integration
29
+ - πŸ€– **AI-Powered Booking**: Natural language appointment scheduling
30
+ - πŸ“… **Google Calendar Sync**: Seamless integration with your calendar
31
+ - πŸ” **Conflict Detection**: Smart availability checking
32
+ - πŸŽ₯ **Google Meet Integration**: Automatic video conference setup
33
+ - πŸ“§ **Email Notifications**: Booking confirmations and cancellations
34
+
35
+ ### 🧠 Intelligent Conversation
36
+ - πŸ’­ **Conversation Memory**: Persistent context across interactions
37
+ - 🎯 **Smart Extraction**: Automatically extract names, emails, times
38
+ - 🌍 **Timezone Awareness**: Global scheduling support
39
+ - ⏰ **Flexible Time Parsing**: "tomorrow at 2pm", "next Tuesday", etc.
40
+
41
+ ## πŸ—οΈ Architecture
42
+
43
+ - **Frontend**: Gradio with WebRTC audio capture
44
+ - **AI**: Groq Llama-3.1 with Anthropic Claude fallback
45
+ - **STT**: Whisper via external service integration
46
+ - **TTS**: Bark text-to-speech synthesis
47
+ - **Calendar**: Google Calendar API with OAuth2
48
+ - **Storage**: Google Cloud Secret Manager for persistent auth
49
+
50
+ ## πŸš€ Usage
51
+
52
+ ### Voice Interaction
53
+ 1. Click the microphone button to start recording
54
+ 2. Speak naturally: "Hi, I'm John. Book a 30-minute meeting tomorrow at 2pm"
55
+ 3. Watch real-time transcription appear in the text box
56
+ 4. AI responds with voice confirmation of your booking
57
+
58
+ ### Text Interaction
59
+ - Type messages as normal - voice and text work together
60
+ - Edit voice transcriptions before sending
61
+ - Use quick action buttons for common requests
62
+
63
+ ### Example Conversations
64
+
65
+ **Voice**: "Book a Google Meet with Peter next Tuesday at 10 AM for 45 minutes"
66
+ **AI Audio Response**: "Perfect! I've scheduled your 45-minute Google Meet with Peter for next Tuesday at 10:00 AM..."
67
+
68
+ ## πŸ› οΈ Development
69
+
70
+ This space integrates:
71
+ - **VoiceCal Core**: Calendar booking logic and Google integration
72
+ - **STT Service**: External Whisper service for speech recognition via WebSocket
73
+ - **TTS Service**: External Bark service for voice synthesis via WebSocket
74
+ - **WebRTC**: Browser-based audio capture and streaming
75
+
76
+ ### πŸ”§ Service Configuration
77
+
78
+ For optimal performance, the external voice services should be configured with:
79
+ - **STT Service**: `STT_SERVICE_MODE=websocket` (enables WebSocket endpoints)
80
+ - **TTS Service**: `TTS_SERVICE_MODE=websocket` (enables WebSocket endpoints)
81
+ - **Service URLs**:
82
+ - STT: `wss://pgits-stt-gpu-service.hf.space/ws/stt`
83
+ - TTS: `wss://pgits-tts-gpu-service.hf.space/ws/tts`
84
+
85
+ ## πŸ” Privacy & Security
86
+
87
+ - Secure OAuth2 authentication with Google
88
+ - Audio processed in real-time, not stored
89
+ - Persistent token storage via Google Secret Manager
90
+ - All calendar operations respect your existing permissions
91
+
92
+ ## πŸ“ž Contact
93
+
94
+ For business scheduling needs or technical support: pgits.job@gmail.com