Spaces:
Running
Running
File size: 15,855 Bytes
7bdbd56 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
"""
Support documentation module with accordion-style help sections
"""
import gradio as gr
from datetime import datetime
def create_support_docs():
"""Create the support documentation interface with accordion menus"""
with gr.Column():
gr.Markdown("# Support Documentation")
gr.Markdown("Step-by-step guidance for creating and deploying chat interfaces with HuggingFace Spaces.")
with gr.Accordion("π Getting Started", open=True):
gr.Markdown("""
# Quick Start
Build a functional assistant with URL grounding.
**Steps:**
1. Configure space settings and system prompt
2. Enable URL grounding tools
3. Preview and test
4. Generate deployment package
5. Deploy to HuggingFace
**Requirements:**
- HuggingFace account (free)
- OpenRouter API key
- Basic AI chatbot knowledge
""")
with gr.Accordion("βοΈ Configuration Guide", open=False):
gr.Markdown("""
### Essential Settings
**Space Title & Description** - Name and purpose for your assistant
**Model Selection:**
- **Gemini 2.0 Flash** - Fast, reliable (recommended)
- **Gemma 3 27B** - Open-source, cost-effective
- **Claude 3.5 Haiku** - Advanced reasoning
**System Prompt & Templates:**
- **Custom** - Write your own specific instructions
- **Research Template** - Academic work, citations, fact-checking
- **Socratic Template** - Teaching through questions, critical thinking
**URL Grounding (up to 10 URLs)** - Static content for consistent context
**URL Priority System:**
- **Primary URLs (2)**: Main references (syllabus, textbook) - always processed first with highest priority
- **Secondary URLs (8)**: Supplementary sources - additional context as needed
The system processes URLs in order of priority, ensuring your most important content is always included in the assistant's context.
**Example Prompts Guidelines:**
- One prompt per line, under 100 characters
- Show assistant capabilities
- Examples: "Explain [topic] in simple terms", "Help prepare for exam", "Analyze this source: [URL]"
**Advanced Parameters:**
- **Temperature (0.0-2.0)**: 0.0-0.3 (focused), 0.4-0.7 (balanced), 0.8+ (creative)
- **Max Tokens (50-4096)**: 750 recommended for balanced responses
- **API Key Variable**: Default `OPENROUTER_API_KEY`
- **Access Code**: Optional student protection
""")
with gr.Accordion("π¬ Preview & Testing", open=False):
gr.Markdown("""
### Pre-Deployment Testing
**Preview Steps:**
1. Complete Configuration tab setup
2. Click "Preview Deployment Package"
3. Test chat interface and URL grounding
4. Export conversations for documentation
**Requirements:** Set `OPENROUTER_API_KEY` environment variable for full testing
**Test Checklist:**
- Various query types and assistant responses
- URL grounding functionality (if enabled)
- System prompt behavior matches expectations
- Example prompts work correctly
""")
with gr.Accordion("π HuggingFace Space Deployment", open=False):
gr.Markdown("""
### Complete Deployment Workflow
**Overview:** Generate Package β Create Space β Upload Files β Configure Secrets β Monitor Build β Verify Configuration
""")
with gr.Accordion("Step 1: Generate & Create Space", open=False):
gr.Markdown("""
**1.1 Generate Deployment Package**
- Click "Generate Deployment Package" and download zip
- Extract files: `app.py`, `config.json`, `requirements.txt`
**1.2 Create New Space**
- Go to [huggingface.co/spaces](https://huggingface.co/spaces)
- Click "New Space"
- Choose Gradio SDK
- Select hardware (CPU Basic is free)
""")
with gr.Row():
with gr.Column(scale=1):
gr.Image(
value="img/img17.png",
label="Space Creation Form",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Column(scale=1):
gr.Image(
value="img/img16.png",
label="Hardware Selection",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Accordion("Step 2: Upload Files", open=False):
gr.Markdown("""
**2.1 Upload Project Files**
- Navigate to Files tab
- Click "Upload files" or drag and drop
- Upload: `app.py`, `config.json`, `requirements.txt`
- Commit directly to main branch
""")
with gr.Row():
with gr.Column(scale=1):
gr.Image(
value="img/img12.png",
label="File Upload",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Column(scale=1):
gr.Image(
value="img/img8.png",
label="Files After Upload",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Accordion("Step 3: Configure API Secrets", open=False):
gr.Markdown("""
**3.1 Configure HuggingFace Spaces Secrets**
- Go to Settings β Variables and secrets
- Click "New secret"
**Required Secret:**
- **OPENROUTER_API_KEY**: Set this to your OpenRouter API key value
**Optional Secret:**
- **SPACE_ACCESS_CODE**: Set this to your desired access code value for student access control
**Access Control Notes:**
- If you don't create the `SPACE_ACCESS_CODE` secret, your Space will be publicly accessible
- To enable access control, create the `SPACE_ACCESS_CODE` secret with your chosen code value
- To disable access control, delete the `SPACE_ACCESS_CODE` secret entirely
- Do NOT set an empty value - either set a code or don't create the secret at all
""")
with gr.Row():
with gr.Column(scale=1):
gr.Image(
value="img/img4.png",
label="Navigating to Settings",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Column(scale=1):
gr.Image(
value="img/img4.png",
label="Settings Variables and Secrets",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Column(scale=1):
gr.Image(
value="img/img3.png",
label="API Key Secret Configuration",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Accordion("Step 4: Monitor Build & Verify Configuration", open=False):
gr.Markdown("""
**4.1 Build Monitoring**
- Space will show "Building..." status
- Monitor build logs for errors
- Wait 1-3 minutes for completion
**4.2 Configuration Verification**
- Check Configuration Status panel
- API Key should show "Configured and valid" β
- Test chat interface with example prompts
""")
with gr.Row():
with gr.Column(scale=1):
gr.Image(
value="img/img7.png",
label="Build Process",
show_label=True,
interactive=False,
width=400,
container=False
)
with gr.Column(scale=1):
gr.Image(
value="img/img1.png",
label="Successful Configuration",
show_label=True,
interactive=False,
width=400,
container=False
)
gr.Markdown("""
**Configuration Status Indicators:**
- β Red X: API key not configured or invalid
- β
Green check: All settings configured correctly
- π Building: Space is updating with new changes
""")
with gr.Accordion("π§ Troubleshooting", open=False):
gr.Markdown("""
### Common Issues and Solutions
**Configuration Status Shows Red X:**
- Verify API key secret name matches configuration (usually `OPENROUTER_API_KEY`)
- Check OpenRouter account has credits
- Regenerate API key if needed
**Build Failed:**
- Check `requirements.txt` formatting (no extra spaces)
- Try reuploading files if build gets stuck
- Monitor build logs for specific errors
**API Errors:**
- **401 Unauthorized**: Invalid API key or incorrect secret name
- **429 Rate Limited**: Wait a few minutes, consider upgrading OpenRouter plan
**Access Issues:**
- **Access code not working**: Verify `SPACE_ACCESS_CODE` secret is set correctly (case-sensitive)
- **URLs not fetching**: Check URLs are publicly accessible, some sites block automated requests
""")
with gr.Accordion("π Additional Resources", open=False):
gr.Markdown("""
### Helpful Links
**HuggingFace Documentation**
- [Spaces Overview](https://huggingface.co/docs/hub/spaces-overview)
- [Gradio on Spaces](https://huggingface.co/docs/hub/spaces-gradio)
- [Environment Variables](https://huggingface.co/docs/hub/spaces-overview#managing-secrets)
**OpenRouter Documentation**
- [API Keys](https://openrouter.ai/keys)
- [Model Comparison](https://openrouter.ai/models)
- [Pricing](https://openrouter.ai/docs#models)
**Gradio Documentation**
- [Chat Interface](https://gradio.app/docs/chatinterface)
- [Components](https://gradio.app/docs/)
- [Sharing Apps](https://gradio.app/sharing-your-app/)
**Community Support**
- [HuggingFace Community Forums](https://discuss.huggingface.co/)
- [Gradio Discord](https://discord.gg/feTf9x3ZSB)
**Educational Use Cases**
- Course assistants for Q&A
- Research writing support
- Study guide generation
- Document analysis tools
- Language practice partners
""")
def export_conversation_to_markdown(conversation_history, config_metadata=None):
"""Export conversation history to markdown format with configuration metadata"""
if not conversation_history:
return "No conversation to export."
markdown_content = f"""# Conversation Export
Generated on: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}
"""
# Add configuration metadata if provided
if config_metadata:
markdown_content += """## Configuration Information
"""
# Add basic configuration details
if config_metadata.get('name'):
markdown_content += f"**Assistant Name:** {config_metadata['name']}\n"
if config_metadata.get('description'):
markdown_content += f"**Description:** {config_metadata['description']}\n"
if config_metadata.get('model'):
markdown_content += f"**Model:** {config_metadata['model']}\n"
if config_metadata.get('temperature'):
markdown_content += f"**Temperature:** {config_metadata['temperature']}\n"
if config_metadata.get('max_tokens'):
markdown_content += f"**Max Tokens:** {config_metadata['max_tokens']}\n"
# Add URL grounding information
grounding_urls = []
for i in range(1, 5):
url = config_metadata.get(f'url{i}')
if url and url.strip():
grounding_urls.append(url.strip())
if grounding_urls:
markdown_content += f"\n**URL Grounding ({len(grounding_urls)} URLs):**\n"
for i, url in enumerate(grounding_urls, 1):
markdown_content += f"- URL {i}: {url}\n"
# Add feature flags
if config_metadata.get('enable_dynamic_urls'):
markdown_content += f"\n**Dynamic URL Fetching:** Enabled\n"
# Add system prompt
if config_metadata.get('system_prompt'):
system_prompt = config_metadata['system_prompt']
markdown_content += f"\n**System Prompt:**\n```\n{system_prompt}\n```\n"
markdown_content += "\n---\n\n"
else:
markdown_content += "---\n\n"
for i, message in enumerate(conversation_history):
if isinstance(message, dict):
role = message.get('role', 'unknown')
content = message.get('content', '')
if role == 'user':
markdown_content += f"## User Message {(i//2) + 1}\n\n{content}\n\n"
elif role == 'assistant':
markdown_content += f"## Assistant Response {(i//2) + 1}\n\n{content}\n\n---\n\n"
return markdown_content |