krinya commited on
Commit
b7b603e
·
1 Parent(s): a38d48e

Update README and FAQ: Refine descriptions and add usage instructions for the chatbot

Browse files
HUGGINGFACE_SOLUTIONS.md DELETED
@@ -1,61 +0,0 @@
1
- # Hugging Face Spaces File System Solutions
2
-
3
- ## The Problem
4
- Hugging Face Spaces have a **read-only file system**, meaning your app cannot write to CSV files or any files on disk. This is expected behavior for security and resource management.
5
-
6
- ## Current Quick Fix (Implemented)
7
- ✅ **Session State Storage**: The app now stores user details and unknown questions in Streamlit's session state:
8
- - Visitors can still leave their contact details
9
- - You can see collected leads in the sidebar during their session
10
- - Data persists for the duration of their browser session
11
-
12
- ## Permanent Solutions for Production
13
-
14
- ### 1. **Database Integration** (Recommended)
15
- Connect to an external database to store contact details permanently:
16
-
17
- **Options:**
18
- - **Supabase** (PostgreSQL, free tier available)
19
- - **MongoDB Atlas** (NoSQL, free tier available)
20
- - **Google Sheets API** (Simple, visual)
21
- - **Airtable API** (User-friendly interface)
22
-
23
- ### 2. **Email Notifications**
24
- Instead of storing data, send immediate email notifications:
25
- ```python
26
- # When user provides contact info, send email via:
27
- # - SendGrid API
28
- # - Mailgun API
29
- # - SMTP (Gmail, etc.)
30
- ```
31
-
32
- ### 3. **Webhook Integration**
33
- Send data to external services via webhooks:
34
- ```python
35
- # Send to:
36
- # - Zapier webhook
37
- # - Make.com (Integromat)
38
- # - Custom API endpoint
39
- ```
40
-
41
- ### 4. **Google Sheets Integration**
42
- Simple solution using Google Sheets as database:
43
- ```python
44
- import gspread
45
- # Write directly to Google Sheets
46
- # Easy to view and manage leads
47
- ```
48
-
49
- ## Implementation Priority
50
-
51
- 1. **Immediate** ✅: Session state storage (already done)
52
- 2. **Short-term**: Email notifications for new leads
53
- 3. **Long-term**: Full database integration
54
-
55
- ## Next Steps
56
-
57
- 1. Test the current Hugging Face app - errors should be gone
58
- 2. Choose a permanent storage solution
59
- 3. Set up email notifications for immediate lead capture
60
-
61
- The current fix ensures your chatbot works without errors while you decide on the best permanent solution.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README.md CHANGED
@@ -11,40 +11,29 @@ tags:
11
  - openai
12
  - data-solutions
13
  pinned: false
14
- short_description: AI Assistant v1.0.3 - Blue Bean Data services and solutions
15
  ---
16
 
17
- # Blue Bean Data AI Assistant
18
 
19
- An intelligent chatbot powered by OpenAI that helps visitors learn about Blue Bean Data's services and capabilities.
20
 
21
- ## Features
22
 
23
- - 🤖 **AI-Powered Conversations**: Uses OpenAI GPT-4o-mini for natural language understanding
24
- - 📚 **Knowledge Base**: Includes comprehensive FAQ and team information
25
- - 📊 **Contact Recording**: Automatically records interested visitors' details
26
- - 🔍 **Unknown Question Tracking**: Logs questions that need human follow-up
27
- - 💬 **Natural Interface**: Clean, professional chat interface
28
 
29
- ## Services We Cover
30
 
31
- - Data Strategy & Consulting
32
- - BI & Dashboards
33
- - Data Pipeline Development
34
- - AI & Automation
35
- - Predictive Modeling & Analytics
36
- - Database Design & Optimization
37
 
38
- ## Usage
39
 
40
- Simply start a conversation by asking about Blue Bean Data's services, expertise, or how we can help with your data challenges!
41
-
42
- ## Setup
43
-
44
- This application requires an OpenAI API key. Set it as a secret named `OPENAI_API_KEY` in your Hugging Face Space settings.
45
-
46
- ## Version History
47
- - v1.0.3 (2025-01-20): Blue theme, session-based storage for HF compatibility
48
 
49
  ---
50
- Built by Blue Bean Data - Transforming data into business value.
 
11
  - openai
12
  - data-solutions
13
  pinned: false
14
+ short_description: AI Assistant - Blue Bean Data services and solutions
15
  ---
16
 
17
+ # Blue Bean Data AI Assistant
18
 
19
+ >A minimal AI-powered chatbot for Blue Bean Data, built with Streamlit and OpenAI.
20
 
21
+ ## What it does
22
 
23
+ - Answers questions about Blue Bean Data's services using a built-in FAQ and OpenAI GPT-4o-mini.
24
+ - Records visitor contact details for follow-up.
25
+ - Tracks unknown questions for later review.
 
 
26
 
27
+ ## How to use
28
 
29
+ 1. Start the app (Streamlit, Docker, or Hugging Face Space).
30
+ 2. Ask questions about Blue Bean Data's offerings or expertise.
31
+ 3. The chatbot responds instantly and can collect your contact info if you wish.
 
 
 
32
 
33
+ ## Requirements
34
 
35
+ - Python 3.10+
36
+ - OpenAI API key (set as `OPENAI_API_KEY` environment variable)
 
 
 
 
 
 
37
 
38
  ---
39
+ Made by Blue Bean Data.
src/chatbot_data/faq_blue_bean_data.md CHANGED
@@ -54,6 +54,19 @@ A: This service is for companies struggling with slow application performance, d
54
  Q: What technologies do you work with?
55
  A: We use a modern and robust tech stack, including Python, SQL, AWS, Google Cloud, Azure, Databricks, Snowflake, Power BI, Tableau, Streamlit, Scikit-learn, TensorFlow, OpenAI, and more.
56
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
  Our Approach & Process
58
  Q: What is your process for working with new clients?
59
  A: We follow a transparent, five-step process:
@@ -88,4 +101,19 @@ Q: How soon can you start a new project?
88
  A: Our contact form includes an option to indicate your timeline, whether it's "Immediately," "Within a month," "Within 3 months," or "Just exploring options." We will discuss a specific start date during our initial conversations.
89
 
90
  Q: How does your pricing work?
91
- A: We work on a project basis. After our free hands-on discovery session, we provide a detailed project proposal that outlines the scope, deliverables, and associated costs, so you have a clear understanding of the investment before we begin.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
54
  Q: What technologies do you work with?
55
  A: We use a modern and robust tech stack, including Python, SQL, AWS, Google Cloud, Azure, Databricks, Snowflake, Power BI, Tableau, Streamlit, Scikit-learn, TensorFlow, OpenAI, and more.
56
 
57
+ Using the Chatbot
58
+ Q: How do I use the Blue Bean Data chatbot?
59
+ A: Simply type your question or message into the chat interface. The chatbot will respond instantly with helpful information based on our FAQ, knowledge base, and AI-powered understanding. You can ask about our services, team, process, technologies, or anything related to Blue Bean Data.
60
+
61
+ Q: What kind of questions can the chatbot answer?
62
+ A: The chatbot is designed to answer a wide range of questions, including:
63
+ - Details about Blue Bean Data's services and expertise
64
+ - Information about our team and company background
65
+ - Our approach, process, and technologies used
66
+ - How to get in touch or start a project
67
+ - General data, analytics, and AI topics
68
+ If your question is outside the chatbot's knowledge, it will log it for human follow-up, so you always get the help you need.
69
+
70
  Our Approach & Process
71
  Q: What is your process for working with new clients?
72
  A: We follow a transparent, five-step process:
 
101
  A: Our contact form includes an option to indicate your timeline, whether it's "Immediately," "Within a month," "Within 3 months," or "Just exploring options." We will discuss a specific start date during our initial conversations.
102
 
103
  Q: How does your pricing work?
104
+ A: We work on a project basis. After our free hands-on discovery session, we provide a detailed project proposal that outlines the scope, deliverables, and associated costs, so you have a clear understanding of the investment before we begin.
105
+
106
+ Q: Do you offer freelance or contract-based services?
107
+ A: Yes, we also provide freelance and contract-based data services for clients who need flexible, short-term, or specialized support. Whether you need extra hands for a specific project, expert advice, or ongoing part-time help, we can tailor our engagement to fit your needs. Contact us to discuss your requirements and how we can help as freelance data professionals.
108
+
109
+ Q: Can you build a custom chatbot like this for my business?
110
+ A: Absolutely! The chatbot you are interacting with was built using modern technologies like Streamlit and OpenAI's GPT models. If you are interested in a similar AI-powered chatbot for your own website or business, we can design and implement a tailored solution to fit your needs, including integration with your data and branding. Contact us to discuss your requirements and get a proposal.
111
+
112
+ Chatbot Technical Implementation
113
+ Q: How was this chatbot built?
114
+ A: This chatbot was developed using a combination of modern AI and web technologies:
115
+ - **OpenAI GPT models** for natural language understanding and response generation
116
+ - **Streamlit** for the interactive web interface
117
+ - **Langchain** and other GenAI frameworks for advanced prompt engineering, retrieval, and workflow orchestration
118
+ - Deployed on **Hugging Face Spaces** for easy public access
119
+ We can adapt the technical stack to your needs, including integration with your own data sources, APIs, or cloud infrastructure.