ShadAI Framework
  1. api-reference
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. api-reference

Engine Tool API

Orchestrate multiple AI capabilities (knowledge base, web search, summarization) for comprehensive analysis.

Method Signature#

Parameters#

prompt (str, required): Query or analysis task
use_knowledge_base (bool, optional): Query uploaded documents (default: True)
use_summary (bool, optional): Include document summary context (default: True)
use_web_search (bool, optional): Search web for current information (default: True)
use_memory (bool, optional): Enable conversation context/memory (default: True)

Returns#

Async iterator yielding response chunks (strings) for streaming display.

Examples#

Basic Usage (All Features Enabled)#

Selective Feature Control#

LLM-Only Mode#

Market Analysis with Full Context#

Use Cases#

1. Research & Analysis#

Combine documents with web search for comprehensive research:

2. Document-Grounded Q&A#

Query documents without external information:

3. Real-Time Information#

Get current information without document context:

Behavior#

Tool Selection#

The engine intelligently decides which tools to use based on your query and enabled capabilities:
Knowledge Base: Retrieves relevant document chunks
Summary: Provides document overview for context
Web Search: Searches web for current information
Memory: Maintains conversation context across queries

Tool Orchestration#

1.
Planning: Analyzes query to determine tool needs
2.
Parallel Execution: Runs applicable tools concurrently
3.
Synthesis: Combines results into coherent response
4.
Streaming: Delivers response as it's generated

Memory & Context#

With use_memory=True (default):
Remembers previous queries in session
Maintains conversation context
Allows follow-up questions

Performance Considerations#

Enabling All Tools (Default)#

Pros: Most comprehensive answers, combines multiple sources
Cons: Slower response time, higher token usage
Best for: Research, analysis, complex queries

Selective Tools#

Pros: Faster responses, lower costs
Cons: May miss relevant information
Best for: Simple queries, known information needs

Error Handling#

Comparison with Other Tools#

Engine vs Query#

FeatureEngineQuery
Knowledge BaseOptionalAlways
Web SearchOptionalNo
SummaryOptionalNo
Use CaseFlexible analysisDocument Q&A

Engine vs Agent#

FeatureEngineAgent
Built-in ToolsKnowledge base, web, summaryCustom tools
OrchestrationAutomatedPlanned & executed
Use CaseStandard workflowsCustom workflows

Tips & Best Practices#

1. Start with Defaults#

2. Disable Unused Features#

3. Use Memory for Conversations#

4. Disable Memory for Independent Queries#

See Also#

Query Tool - Simpler document Q&A
Agent Tool - Custom tool workflows
Tools Overview - All available tools
Shadai Client - Main client interface
Modified at 2025-10-17 17:46:10
Previous
Exceptions Reference
Next
Shadai Client API Reference
Built with