ShadAI Framework
  1. getting-started
ShadAI Framework
  • Index
  • README
  • Pricing
    • Pricing Plan
  • advanced
    • Best Practices
    • Tool Orchestration
    • Performance Optimization
    • Custom Tools
  • examples
    • Advanced Patterns
    • Custom Agent Examples
    • Market Research Examples
    • Multi-Document Analysis
    • Basic Query Examples
  • api-reference
    • Exceptions Reference
    • Engine Tool API
    • Shadai Client API Reference
    • Query Tool API
    • Summarize Tool API
    • Agent Tool API
    • Web Search Tool API
  • use-cases
    • Knowledge Synthesis
    • Research Assistant
    • Custom Workflows
    • Document Q&A
  • core-concepts
    • Architecture
    • Intelligent Agent
    • RAG System
    • Tools Overview
  • guides
    • Memory & Context
    • Streaming Responses
    • File Ingestion
    • Error Handling
    • Session Management
  • getting-started
    • Authentication
    • Your First Query
    • Quick Start
    • Installation
  1. getting-started

Quick Start

Quick Start#

Get productive with Shadai in 5 minutes. This guide covers the essential operations you'll use every day.

Your First Shadai Application#

Create a file app.py:
Run it:

Core Operations#

1. Session Management#

Sessions organize your documents and conversations:

2. Document Ingestion#

Add documents to your knowledge base:
Supported formats:
šŸ“„ PDF
šŸ–¼ļø Images (JPG, PNG, WEBP)
Max size: 35MB per file

3. Query Knowledge Base#

Ask questions about your documents:

4. Summarize Documents#

Get an overview of all documents:

5. Web Search#

Search for current information:

6. Unified Engine#

Combine multiple capabilities:

Model Selection#

Choose specific AI models for your session:
Available Models:
31 LLM models: OpenAI, Azure, Anthropic (Claude), Google (Gemini)
5 embedding models: OpenAI, Azure, Google
See complete model list →

Complete Example#

Here's a realistic workflow with model selection:

Memory & Context#

By default, Shadai remembers your conversation:
Disable memory if needed:

Chat History#

Retrieve and manage conversation history:

Error Handling#

Handle errors gracefully:

Best Practices#

āœ… Do This#

āŒ Don't Do This#

Common Patterns#

Pattern 1: Batch Processing#

Pattern 2: Incremental Ingestion#

Pattern 3: Multi-Modal Analysis#

Next Steps#

šŸŽ‰ You now know the basics! Here's what to explore next:
Session Management Deep Dive
Memory & Context Guide
File Ingestion Guide
Use Cases

Need Help?#

šŸ“– Core Concepts - Understand how Shadai works
šŸ’” Examples - See more code examples
šŸš€ Advanced Topics - Go deeper

Ready to learn more? → Your First Query
Modified atĀ 2025-10-21 05:35:49
Previous
Your First Query
Next
Installation
Built with