@@ -398,15 +398,15 @@ result = execute_plan(reasoning.actions)
398398### Architecture by Model Size
399399
400400| Model Size | Recommended Approach | FC Accuracy | Why Choose This |
401- | ---------- | ---------------------------- | ----------- | ----------------------- |
401+ | ------------ | ------------------------------ | ------------- | ------------------------- |
402402| ** \< 14B** | Pure SGR + Structured Output | 15-25% | FC practically unusable |
403403| ** 14-32B** | SGR + FC hybrid | 45-65% | Best of both worlds |
404404| ** 32B+** | Native FC with SGR fallback | 85%+ | FC works reliably |
405405
406406### When to Use SGR vs Function Calling
407407
408408| Use Case | Best Approach | Why |
409- | ------------------------------- | ---------------- | ------------------------------------------------ |
409+ | --------------------------------- | ------------------ | -------------------------------------------------- |
410410| ** Data analysis & structuring** | SGR | Controlled reasoning with visibility |
411411| ** Document processing** | SGR | Step-by-step analysis with justification |
412412| ** Local models (\< 32B)** | SGR | Forces reasoning regardless of model limitations |
@@ -453,17 +453,23 @@ cp config.yaml.example config.yaml
4534532 . ** Configure API keys:**
454454
455455``` yaml
456+ # SGR Research Agent - Configuration Template
457+ # Production-ready configuration for Schema-Guided Reasoning
458+ # Copy this file to config.yaml and fill in your API keys
459+
456460# OpenAI API Configuration
457461openai :
458462 api_key : " your-openai-api-key-here" # Required: Your OpenAI API key
459463 base_url : " " # Optional: Alternative URL (e.g., for proxy LiteLLM/vLLM)
460464 model : " gpt-4o-mini" # Model to use
461465 max_tokens : 8000 # Maximum number of tokens
462466 temperature : 0.4 # Generation temperature (0.0-1.0)
467+ proxy : " " # Example: "socks5://127.0.0.1:1081" or "http://127.0.0.1:8080" or leave empty for no proxy
463468
464469# Tavily Search Configuration
465470tavily :
466471 api_key : " your-tavily-api-key-here" # Required: Your Tavily API key
472+ api_base_url : " https://api.tavily.com" # Tavily API base URL
467473
468474# Search Settings
469475search :
@@ -479,12 +485,13 @@ scraping:
479485execution :
480486 max_steps : 6 # Maximum number of execution steps
481487 reports_dir : " reports" # Directory for saving reports
488+ logs_dir : " logs" # Directory for saving reports
482489
483490# Prompts Settings
484491prompts :
485- prompts_dir : " prompts" # Directory with prompts
492+ prompts_dir : " prompts" # Directory with prompts
486493 tool_function_prompt_file : " tool_function_prompt.txt" # Tool function prompt file
487- system_prompt_file : " system_prompt.txt" # System prompt file
494+ system_prompt_file : " system_prompt.txt" # System prompt file
488495` ` `
489496
490497### Server Configuration
@@ -494,6 +501,27 @@ prompts:
494501python sgr_deep_research --host 127.0.0.1 --port 8080
495502```
496503
504+ ## 🤖 Available Agent Models
505+
506+ ### Agent Types Overview
507+
508+ | Agent Model | Description |
509+ | ------------------------| ------------------------------------|
510+ | ` sgr-agent ` | Pure SGR (Schema-Guided Reasoning) |
511+ | ` sgr-tools-agent ` | SGR + Function Calling hybrid |
512+ | ` sgr-auto-tools-agent ` | SGR + Auto Function Calling |
513+ | ` sgr-so-tools-agent ` | SGR + Structured Output |
514+ | ` tools-agent ` | Pure Function Calling |
515+
516+ ### Models Endpoint
517+
518+ Get the list of available agent models:
519+
520+ ``` bash
521+ curl http://localhost:8010/v1/models
522+ ```
523+
524+
497525## 📝 Reports
498526
499527Research reports are automatically saved to the ` reports/ ` directory in Markdown format:
0 commit comments