diff --git a/python/docs/agents.md b/python/docs/agents.md index 3a4708d2..f889ee4c 100644 --- a/python/docs/agents.md +++ b/python/docs/agents.md @@ -504,7 +504,4 @@ _Source: [examples/workflows/multi_agents.py](/python/examples/workflows/multi_a ## Examples -- [simple.py](/python/examples/agents/simple.py) - Basic agent implementation -- [react.py](/python/examples/agents/react.py) - More complete implementation -- [granite.py](/python/examples/agents/granite.py) - Using Granite model -- [agents.ipynb](/python/examples/notebooks/agents.ipynb) - Interactive notebook examples +- All agent examples can be found in [here](/python/examples/agents). diff --git a/python/docs/cache.md b/python/docs/cache.md index 73f96db2..6221a28d 100644 --- a/python/docs/cache.md +++ b/python/docs/cache.md @@ -200,14 +200,4 @@ _Source: /examples/cache/custom.py_ ## Examples -- [unconstrainedCache.py](/python/examples/cache/unconstrainedCache.py) - Basic usage of unconstrained cache -- [unconstrainedCacheFunction.py](/python/examples/cache/unconstrainedCacheFunction.py) - Caching function output and intermediate steps -- [slidingCache.py](/python/examples/cache/slidingCache.py) - Size-limited cache implementation -- [fileCache.py](/python/examples/cache/fileCache.py) - Persistent disk-based caching -- [fileCacheCustomProvider.py](/python/examples/cache/fileCacheCustomProvider.py) - Custom provider for file cache -- [llmCache.py](/python/examples/cache/llmCache.py) - Caching LLM responses -- [toolCache.py](/python/examples/cache/toolCache.py) - Caching tool execution results -- [decoratorCache.py](/python/examples/cache/decoratorCache.py) - Using the cache decorator -- [decoratorCacheComplex.py](/python/examples/cache/decoratorCacheComplex.py) - Advanced decorator caching with custom key functions -- [cacheFn.py](/python/examples/cache/cacheFn.py) - Function wrapping for dynamic caching -- [custom.py](/python/examples/cache/custom.py) - Creating a custom cache provider \ No newline at end of file +- All cache examples can be found in [here](/python/examples/cache). diff --git a/python/docs/emitter.md b/python/docs/emitter.md index dfb7359c..5d3e27c2 100644 --- a/python/docs/emitter.md +++ b/python/docs/emitter.md @@ -298,8 +298,4 @@ _Source: [examples/emitter/advanced.py](/python/examples/emitter/advanced.py)_ ## Examples -- [base.py](/python/examples/emitter/base.py) - Basic emitter implementation -- [matchers.py](/python/examples/emitter/matchers.py) - Event matching techniques -- [piping.py](/python/examples/emitter/piping.py) - Event piping strategies -- [agentMatchers.py](/python/examples/emitter/agentMatchers.py) - Agent event handling -- [advanced.py](/python/examples/emitter/advanced.py) - Advanced configuration \ No newline at end of file +- All emitter examples can be found in [here](/python/examples/emitter). diff --git a/python/docs/errors.md b/python/docs/errors.md index 66da545b..7f719683 100644 --- a/python/docs/errors.md +++ b/python/docs/errors.md @@ -183,3 +183,8 @@ message: str = FrameworkError.ensure(error).explain() ``` See the source file [errors.py](python/beeai_framework/errors.py) for additional methods. + + +## Examples + +- All error examples can be found in [here](/python/examples/errors). diff --git a/python/docs/logger.md b/python/docs/logger.md index 456b5dde..058d87f6 100644 --- a/python/docs/logger.md +++ b/python/docs/logger.md @@ -162,5 +162,4 @@ _Source: /examples/logger/agent.py_ ## Examples -- [base.py](/python/examples/logger/base.py) - Simple example showing log levels -- [agent.py](/python/examples/logger/agent.py) - Simple example showing agent integration +- All logger examples can be found in [here](/python/examples/logger). diff --git a/python/docs/memory.md b/python/docs/memory.md index 92ea6ef8..ff0b75f4 100644 --- a/python/docs/memory.md +++ b/python/docs/memory.md @@ -526,8 +526,4 @@ _Source: [/python/examples/memory/custom.py](/python/examples/memory/custom.py)_ ## Examples -- [unconstrained_memory.py](/examples/memory/unconstrained_memory.py) - Basic memory usage -- [sliding_memory.py](/examples/memory/sliding_memory.py) - Sliding window memory example -- [token_memory.py](/examples/memory/token_memory.py) - Token-based memory management -- [summarize_memory.py](/examples/memory/summarize_memory.py) - Summarization memory example -- [agent_memory.py](/examples/memory/agent_memory.py) - Using memory with agents +- All memory examples can be found in [here](/python/examples/memory). diff --git a/python/docs/serialization.md b/python/docs/serialization.md index b84d1165..fad70ae7 100644 --- a/python/docs/serialization.md +++ b/python/docs/serialization.md @@ -120,8 +120,4 @@ _Source: [examples/serialization/context.py](/python/examples/serialization/cont ## Examples -- [base.py](/python/examples/serialization/base.py) - Base example -- [memory.py](/python/examples/serialization/memory.py) - Example of serializing and deserializing memory components -- [customExternal.py](/python/examples/serialization/customExternal.py) - Registering external classes with the serializer -- [customInternal.py](/python/examples/serialization/customInternal.py) - Implementing the Serializable interface -- [context.py](/python/examples/serialization/context.py) - Using serialization context for advanced scenarios \ No newline at end of file +- All serialization examples can be found in [here](/python/examples/serialization). diff --git a/python/docs/templates.md b/python/docs/templates.md index 1bf93684..825dda6e 100644 --- a/python/docs/templates.md +++ b/python/docs/templates.md @@ -369,9 +369,6 @@ _Source: [examples/templates/system_prompt.py](/examples/templates/system_prompt # Examples -- [basic_template.py](/python/examples/templates/basic_template.py) - Simple variable substitution with Pydantic validation -- [functions.py](/python/examples/templates/functions.py) - Adding dynamic content with custom template functions -- [objects.py](/python/examples/templates/objects.py) - Handle complex nested data structures in templates with proper type validation -- [arrays.py](/python/examples/templates/arrays.py) - Process collections of data within templates for dynamic list generation -- [forking.py](/python/examples/templates/forking.py) - Create new templates based on existing ones, with customizations -- [system_prompt.py](/python/examples/templates/system_prompt.py) - Creating specialized system prompts for AI assistants with tool definitions \ No newline at end of file +## Examples + +- All template examples can be found in [here](/python/examples/templates). diff --git a/python/docs/tools.md b/python/docs/tools.md index 6159791e..15bc0131 100644 --- a/python/docs/tools.md +++ b/python/docs/tools.md @@ -650,3 +650,7 @@ to recover from errors. When building tools, consider that the tool is being invoked by a somewhat unpredictable third party (the agent). You should ensure that sufficient guardrails are in place to prevent adverse outcomes. + +## Examples + +- All tool examples can be found in [here](/python/examples/tools). diff --git a/python/docs/workflows.md b/python/docs/workflows.md index b5d14b33..46325dd3 100644 --- a/python/docs/workflows.md +++ b/python/docs/workflows.md @@ -400,8 +400,4 @@ This pattern demonstrates: ## Examples -- [simple.py](/python/examples/workflows/simple.py) - Basic workflow example -- [nesting.py](/python/examples/workflows/nesting.py) - More complex workflow with loops -- [memory.py](/python/examples/workflows/memory.py) - Using memory in workflows -- [multi_agents.py](/python/examples/workflows/multi_agents.py) - Multi-agent workflow -- [workflows.ipynb](/python/examples/notebooks/workflows.ipynb) - Interactive notebook examples +- All workflow examples can be found in [here](/python/examples/workflows).