update doc, add mention about the python package for every agent or classifier

cornelcroi · cornelcroi · commit b47cc170c0f5 · 2024-12-23T17:53:05.000+01:00
diff --git a/README.md b/README.md
@@ -338,18 +338,44 @@ These examples showcase:
 3. The orchestrator's ability to route requests to the most appropriate agent based on the input.
 4. Handling of both streaming and non-streaming responses from different types of agents.
 
-### Working with Anthropic or OpenAI
-If you want to use Anthropic or OpenAI for classifier and/or agents, make sure to install the multi-agent-orchestrator with the relevant extra feature.
-```bash
+
+### Modular Installation Options
+
+The Multi-Agent Orchestrator is designed with a modular architecture, allowing you to install only the components you need while ensuring you always get the core functionality.
+
+#### Installation Options
+
+**1. AWS Integration**:
+
+  ```bash
+   pip install "multi-agent-orchestrator[aws]"
+  ```
+Includes core orchestration functionality with comprehensive AWS service integrations (`BedrockLLMAgent`, `AmazonBedrockAgent`, `LambdaAgent`, etc.)   
+
+**2. Anthropic Integration**:
+
+  ```bash
 pip install "multi-agent-orchestrator[anthropic]"
+  ```
+
+**3. OpenAI Integration**:
+
+  ```bash
 pip install "multi-agent-orchestrator[openai]"
-```
+  ```
 
-### Full package installation
-For a complete installation (including Anthropic and OpenAi):
-```bash
+Adds OpenAI's GPT models for agents and classification, along with core packages.
+
+**4. Full Installation**:
+
+  ```bash
 pip install "multi-agent-orchestrator[all]"
-```
+  ```
+
+Includes all optional dependencies for maximum flexibility. 
+
+Curious about how to use these installation options? Our comprehensive documentation provides:
+
 
 ## 🤝 Contributing
 
diff --git a/docs/src/content/docs/agents/built-in/amazon-bedrock-agent.mdx b/docs/src/content/docs/agents/built-in/amazon-bedrock-agent.mdx
@@ -9,6 +9,14 @@ The `AmazonBedrockAgent` is a specialized agent class in the Multi-Agent Orchest
 
 Here are various examples showing different ways to create and configure an AmazonBedrockAgent:
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 ### Basic Examples
 
 **1. Minimal Configuration**
diff --git a/docs/src/content/docs/agents/built-in/anthropic-agent.mdx b/docs/src/content/docs/agents/built-in/anthropic-agent.mdx
@@ -22,6 +22,14 @@ This agent can handle a wide range of processing tasks, making it suitable for d
 
 Here are various examples showing different ways to create and configure an AnthropicAgent:
 
+### Python Package
+
+If you haven't already installed the Anthropic-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[anthropic]"
+```
+
 ### Basic Examples
 
 **1. Minimal Configuration**
diff --git a/docs/src/content/docs/agents/built-in/bedrock-flows-agent.mdx b/docs/src/content/docs/agents/built-in/bedrock-flows-agent.mdx
@@ -15,6 +15,14 @@ This integration enables you to orchestrate your Bedrock Flows alongside other a
 
 ## Creating a BedrockFlowsAgent
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 ### Basic Example
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
diff --git a/docs/src/content/docs/agents/built-in/bedrock-inline-agent.mdx b/docs/src/content/docs/agents/built-in/bedrock-inline-agent.mdx
@@ -22,6 +22,14 @@ This architecture removes practical limits on the number of action groups and kn
 
 ## Creating a BedrockInlineAgent
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 ### Basic Example 
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
diff --git a/docs/src/content/docs/agents/built-in/bedrock-llm-agent.mdx b/docs/src/content/docs/agents/built-in/bedrock-llm-agent.mdx
@@ -23,6 +23,13 @@ This agent can handle a wide range of processing tasks, making it suitable for d
 
 By default, the **Bedrock LLM Agent** uses the `anthropic.claude-3-haiku-20240307-v1:0` model.
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
 
 **1. Minimal Configuration**
 
@@ -596,14 +603,40 @@ Choose the approach that best fits your needs:
 
 ### Option Explanations
 
-- `name` and `description`: Required fields to identify and describe the agent's purpose
-- `modelId`/`model_id`: Specifies the LLM model to use (e.g., Claude 3 Sonnet)
-- `region`: AWS region for the Bedrock service
-- `streaming`: Enables streaming responses for real-time output
-- `inferenceConfig`/`inference_config`: Fine-tunes the model's output characteristics
-- `guardrailConfig`/`guardrail_config`: Applies predefined guardrails to the model's responses
-- `retriever`: Integrates a retrieval system for enhanced context
-- `toolConfig`/`tool_config`: Defines tools the agent can use and how to handle their responses
-- `customSystemPrompt`/`custom_system_prompt`: Defines the agent's system prompt and behavior, with optional variables for dynamic content
-- `client`: Optional custom Bedrock client for specialized configurations
+<Tabs syncKey="runtime">
+
+  <TabItem label="TypeScript" icon="seti:typescript" color="blue">
+
+| Parameter | Description | Required/Optional |
+|------------|-------------|-------------------|
+| `name` | Identifies the agent within the system | **Required** |
+| `description` | Describes the agent's purpose and capabilities | **Required** |
+| `modelId` | Specifies the LLM model to use (e.g., Claude 3 Sonnet) | Optional |
+| `region` | AWS region for the Bedrock service | Optional |
+| `streaming` | Enables streaming responses for real-time output | Optional |
+| `inferenceConfig` | Fine-tunes the model's output characteristics | Optional |
+| `guardrailConfig` | Applies predefined guardrails to the model's responses | Optional |
+| `retriever` | Integrates a retrieval system for enhanced context | Optional |
+| `toolConfig` | Defines tools the agent can use and how to handle their responses | Optional |
+| `customSystemPrompt` | Defines the agent's system prompt and behavior, with optional variables for dynamic content | Optional |
+| `client` | Optional custom Bedrock client for specialized configurations | Optional |
+
+  </TabItem>
+  <TabItem label="Python" icon="seti:python">
+| Parameter | Description | Required/Optional |
+|--------|-------------|-------------------|
+| `name` | Identifies the agent within the system | **Required** |
+| `description` | Describes the agent's purpose and capabilities | **Required** |
+| `model_id` | Specifies the LLM model to use (e.g., Claude 3 Sonnet) | Optional |
+| `region` | AWS region for the Bedrock service | Optional |
+| `streaming` | Enables streaming responses for real-time output | Optional |
+| `inference_config` | Fine-tunes the model's output characteristics | Optional |
+| `guardrail_config` | Applies predefined guardrails to the model's responses | Optional |
+| `retriever` | Integrates a retrieval system for enhanced context | Optional |
+| `tool_config` | Defines tools the agent can use and how to handle their responses | Optional |
+| `custom_system_prompt` | Defines the agent's system prompt and behavior, with optional variables for dynamic content | Optional |
+| `client` | Optional custom Bedrock client for specialized configurations | Optional |
+
+  </TabItem>
+</Tabs>
 
diff --git a/docs/src/content/docs/agents/built-in/bedrock-translator-agent.mdx b/docs/src/content/docs/agents/built-in/bedrock-translator-agent.mdx
@@ -15,6 +15,14 @@ The `BedrockTranslatorAgent` uses Amazon Bedrock's language models to translate
 
 ## Creating a Bedrock Translator Agent
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 ### Basic Example
 
 To create a new `BedrockTranslatorAgent` with minimal configuration:
diff --git a/docs/src/content/docs/agents/built-in/chain-agent.mdx b/docs/src/content/docs/agents/built-in/chain-agent.mdx
@@ -8,6 +8,14 @@ The `ChainAgent` is an agent class in the Multi-Agent Orchestrator System that a
 
 ### Basic Example
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 Here's how to create a ChainAgent with only the required parameters:
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
diff --git a/docs/src/content/docs/agents/built-in/comprehend-filter-agent.mdx b/docs/src/content/docs/agents/built-in/comprehend-filter-agent.mdx
@@ -18,6 +18,14 @@ When used in a [ChainAgent](/multi-agent-orchestrator/agents/built-in/chain-agen
 
 ## Creating a Comprehend Filter Agent
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 ### Basic Example
 
 To create a new `ComprehendFilterAgent` with default settings:
diff --git a/docs/src/content/docs/agents/built-in/lambda-agent.mdx b/docs/src/content/docs/agents/built-in/lambda-agent.mdx
@@ -14,6 +14,14 @@ The `LambdaAgent` is a versatile agent class in the Multi-Agent Orchestrator Sys
 
 ## Creating a LambdaAgent
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 import { Tabs, TabItem } from '@astrojs/starlight/components';
 
 <Tabs syncKey="runtime">
diff --git a/docs/src/content/docs/agents/built-in/lex-bot-agent.mdx b/docs/src/content/docs/agents/built-in/lex-bot-agent.mdx
@@ -13,6 +13,14 @@ The `LexBotAgent` is a specialized agent class in the Multi-Agent Orchestrator S
 
 ## Creating a LexBotAgent
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 To create a new `LexBotAgent` with the required parameters, use the following code:
 
 import { Tabs, TabItem } from '@astrojs/starlight/components';
diff --git a/docs/src/content/docs/agents/built-in/openai-agent.mdx b/docs/src/content/docs/agents/built-in/openai-agent.mdx
@@ -42,6 +42,14 @@ The `OpenAIAgentOptions` extends the base `AgentOptions` with the following fiel
 
 ## Creating an OpenAIAgent
 
+### Python Package
+
+If you haven't already installed the OpenAI-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[openai]"
+```
+
 Here are various examples showing different ways to create and configure an OpenAIAgent:
 
 ### Basic Examples
diff --git a/docs/src/content/docs/classifiers/built-in/anthropic-classifier.mdx b/docs/src/content/docs/classifiers/built-in/anthropic-classifier.mdx
@@ -16,7 +16,10 @@ The Anthropic Classifier extends the abstract `Classifier` class and uses the An
 
 ### Basic Usage
 
-⚠️ To use Anthropic Classifier, make sure you have installed the multi-agent-orchestrator with anthropic feature (see [python installation](/multi-agent-orchestrator/general/quickstart#-get-started))
+### Python Package
+
+If you haven't already installed the Anthropic-related dependencies, make sure to install them:
+
 ```bash
 pip install "multi-agent-orchestrator[anthropic]"
 ```
diff --git a/docs/src/content/docs/classifiers/built-in/bedrock-classifier.mdx b/docs/src/content/docs/classifiers/built-in/bedrock-classifier.mdx
@@ -22,6 +22,14 @@ The BedrockClassifier extends the abstract `Classifier` class and uses Amazon Be
 
 By default, the Multi-Agent Orchestrator uses the Bedrock Classifier, which in turn utilizes the `anthropic.claude-3-5-sonnet-20240620-v1:0` (Claude 3.5 Sonnet) model for classification tasks.
 
+### Python Package
+
+If you haven't already installed the AWS-related dependencies, make sure to install them:
+
+```bash
+pip install "multi-agent-orchestrator[aws]"
+```
+
 import { Tabs, TabItem } from '@astrojs/starlight/components';
 
 <Tabs syncKey="runtime">
diff --git a/docs/src/content/docs/classifiers/built-in/openai-classifier.mdx b/docs/src/content/docs/classifiers/built-in/openai-classifier.mdx
@@ -16,10 +16,12 @@ The OpenAI Classifier extends the abstract `Classifier` class and uses the OpenA
 
 ## Basic Usage
 
-⚠️ To use OpenAI Classifier, make sure you have installed the multi-agent-orchestrator with openai feature (see [python installation](/multi-agent-orchestrator/general/quickstart#-get-started))
+### Python Package
+
+If you haven't already installed the OpenAI-related dependencies, make sure to install them:
 
 ```bash
-pip install multi-agent-orchestrator[openai]
+pip install "multi-agent-orchestrator[openai]"
 ```
 
 To use the OpenAIClassifier, you need to create an instance with your OpenAI API key and pass it to the Multi-Agent Orchestrator:
diff --git a/docs/src/styles/custom.css b/docs/src/styles/custom.css
@@ -137,4 +137,3 @@
   }
 }
 
-
