Code Examples¶

Runnable examples for every feature

Copy, paste, and run with 400+ modules and 237 enterprise features

Enterprise Examples

These examples cover core functionality and advanced production patterns. See Enterprise Documentation for more.

Quick Start

All examples use the agenticaiframework namespace and are production-ready. Each example is self-contained and can be run independently.

Example Categories¶

Basic Examples

Core functionality

View
:material-cog-multiple:{ .lg } Advanced Patterns

Production use cases

View
Complete Apps

Full applications

View

Basic Examples¶

1. Agents Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.agents import AgentManager, Agent

if __name__ == "__main__":
    agent_manager = AgentManager()

    example_agent = Agent(name="ExampleAgent")
    agent_manager.register_agent(example_agent)

    example_agent.start()
    example_agent.pause()
    example_agent.resume()
    example_agent.stop()

    logger.info("Registered Agents:", [agent.name for agent in agent_manager.agents])
    retrieved_agent = agent_manager.get_agent("ExampleAgent")
    logger.info("Retrieved Agent:", retrieved_agent.name)

2. Tasks Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.tasks import TaskManager, Task

if __name__ == "__main__":
    task_manager = TaskManager()

    class AdditionTask(Task):
        def run(self, a, b):
            result = a + b
            logger.info(f"Task Result: {result}")
            return result

    addition_task = AdditionTask(name="AdditionTask")
    task_manager.register_task(addition_task)

    addition_task.run(5, 7)
    logger.info("Registered Tasks:", [task.name for task in task_manager.tasks])
    retrieved_task = task_manager.get_task("AdditionTask")
    logger.info("Retrieved Task:", retrieved_task.name)

3. LLMs Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.llms import LLMManager

if __name__ == "__main__":
    llm_manager = LLMManager()

    llm_manager.register_model("demo-llm", lambda prompt: f"[Demo LLM Response to: {prompt}]")
    llm_manager.set_active_model("demo-llm")

    logger.info("Generated Text:", llm_manager.generate("Explain the concept of machine learning in simple terms."))
    logger.info("Available Models:", list(llm_manager.models.keys()))

4. Guardrails Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.guardrails import GuardrailManager

if __name__ == "__main__":
    guardrail_manager = GuardrailManager()

    guardrail_manager.add_guardrail("No profanity", lambda text: "badword" not in text)
    logger.info("Compliant Output Valid:", guardrail_manager.validate("This is clean text."))
    logger.info("Non-Compliant Output Valid:", guardrail_manager.validate("This contains badword."))

5. Memory Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.memory import MemoryManager

if __name__ == "__main__":
    memory = MemoryManager()

    memory.store_short_term("user_name", "Alice")
    memory.store_short_term("last_query", "What is the capital of France?")

    logger.info("Retrieved User Name:", memory.retrieve("user_name"))
    logger.info("Retrieved Last Query:", memory.retrieve("last_query"))

    keys = list(memory.short_term.keys()) + list(memory.long_term.keys()) + list(memory.external.keys())
    logger.info("Stored Keys:", keys)

    memory.clear_short_term()
    memory.clear_long_term()
    memory.clear_external()
    logger.info("Memory cleared. Keys now:", list(memory.short_term.keys()) + list(memory.long_term.keys()) + list(memory.external.keys()))

6. MCP Tools Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.mcp_tools import MCPToolManager, MCPTool

def greet_tool(name: str) -> str:
    return f"Hello, {name}! Welcome to MCP Tools."

if __name__ == "__main__":
    mcp_manager = MCPToolManager()

    greet_mcp_tool = MCPTool(name="greet", capability="greeting", execute_fn=greet_tool)
    mcp_manager.register_tool(greet_mcp_tool)

    logger.info("Available Tools:", [tool.name for tool in mcp_manager.tools])
    result = mcp_manager.execute_tool("greet", "Alice")
    logger.info("Tool Execution Result:", result)

7. Monitoring Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.monitoring import MonitoringSystem

if __name__ == "__main__":
    monitor = MonitoringSystem()

    monitor.log_event("AgentStarted", {"agent_name": "ExampleAgent"})
    monitor.log_event("TaskCompleted", {"task_name": "AdditionTask", "status": "success"})

    monitor.record_metric("ResponseTime", 1.23)
    monitor.record_metric("Accuracy", 0.98)

    logger.info("Logged Events:", monitor.events)
    logger.info("Logged Metrics:", monitor.metrics)

8. Prompts Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.prompts import Prompt

if __name__ == "__main__":
    prompt_instance = Prompt(
        template="Write a {length} paragraph summary about {topic}."
    )

    rendered_prompt = prompt_instance.render(length="short", topic="artificial intelligence")
    logger.info("Rendered Prompt:", rendered_prompt)

9. Configurations Example¶

Python
import logging

logger = logging.getLogger(__name__)

from agenticaiframework.configurations import ConfigManager

if __name__ == "__main__":
    config = ConfigManager()
    config.set("api_key", "123456")
    logger.info("API Key:", config.get("api_key"))

Usage: Run any example with: ```bash python examples/.py