CogSol Cookbook

Templates and runnable demos for building with the CogSol Framework.

Repository Layout

Core content:

• templates/ contains reusable starter projects.
• examples/ contains specific demos, often more complete and complex than templates.

Supporting contributor infrastructure:

• docs/ contains reusable README templates for contributors.
• .github/ contains issue/PR templates and repository automation.
• CONTRIBUTING.md explains how to propose and submit community contributions.

Catalog

Templates

• semantic-search — Starting point for building a semantic search agent over your own documents.
• orchestrator-subagents — Orchestrator agent that delegates to specialist sub-agents via built-in assistant services.
• support-escalation — Multi-layer escalation flow with fixed responses, FAQs, semantic search, and ticket creation.
• azure-storage-upload — Script tool that generates text documents and uploads them to Azure Blob Storage.
• external-api — Script tool that calls an external API using requests and platform secrets.

See templates/README.md for the template index and conventions.

Examples

• message-metadata — Agent that reads message metadata to personalize responses by language, name, and role.
• search-with-filters - Semantic search with metadata filters (genre, language, decade)
• semantic-search — Semantic search without filters using BaseRetrieval and BaseRetrievalTool.
• pretools — Agent with pre-processing tools for real-time context (date, weather, daily tips).
• common-questions — Agent with predefined FAQ answers using BaseFAQ.
• orchestrator-subagents — Corporate travel assistant with orchestrator + sub-agents pattern.
• fixed-responses — Agent with predefined answers using BaseFixedResponse.
• search-selector - Script tool routing queries to multiple retrievals by topic
• lessons — Agent with behavioral guidelines using BaseLesson.
• support-escalation — IT help desk with fixed responses, FAQs, semantic search, and ticket creation.

See examples/README.md for the example index and conventions.

Adding New Content

When adding a new template or example:

1. Create a dedicated folder under templates/ or examples/.
2. Add a local README.md with purpose, setup, and run steps.
3. Register it in:
   • this root README.md
   • the corresponding index (templates/README.md or examples/README.md)

For full contribution steps, see CONTRIBUTING.md.

Community Workflow

1. Open a proposal issue (Template Proposal or Example Proposal) if scope is unclear.
2. Submit a pull request using the repository PR template.
3. Ensure local docs are present and index entries are updated.
4. Automated checks verify that new folders include README.md and are listed in catalogs.