From 1444a719c43c9f38b1a2d60085e2d2e2860c2b16 Mon Sep 17 00:00:00 2001 From: harshalmore31 Date: Fri, 1 Aug 2025 21:27:39 +0530 Subject: [PATCH] fixes !! --- docs/mkdocs.yml | 2 +- docs/swarms_cloud/group_chat.md | 151 +++++++++++++++++++++++++++++++ docs/swarms_cloud/swarm_types.md | 4 +- 3 files changed, 155 insertions(+), 2 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e6fe1aff..729dd70c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -452,7 +452,7 @@ nav: # - SpreadSheetSwarm: "swarms_cloud/spreadsheet_swarm.md" - SequentialWorkflow: "swarms_cloud/sequential_workflow.md" - ConcurrentWorkflow: "swarms_cloud/concurrent_workflow.md" - # - GroupChat: "swarms_cloud/group_chat.md" + - GroupChat: "swarms_cloud/group_chat.md" - MultiAgentRouter: "swarms_cloud/multi_agent_router.md" # - AutoSwarmBuilder: "swarms_cloud/auto_swarm_builder.md" # - HierarchicalSwarm: "swarms_cloud/hierarchical_swarm.md" diff --git a/docs/swarms_cloud/group_chat.md b/docs/swarms_cloud/group_chat.md index fa6cab9d..3c3ee17c 100644 --- a/docs/swarms_cloud/group_chat.md +++ b/docs/swarms_cloud/group_chat.md @@ -23,6 +23,157 @@ Key features: ## API Usage +### Basic GroupChat Example + +=== "Shell (curl)" + ```bash + curl -X POST "https://api.swarms.world/v1/swarm/completions" \ + -H "x-api-key: $SWARMS_API_KEY" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "Product Strategy Discussion", + "description": "Collaborative chat to develop product strategy", + "swarm_type": "GroupChat", + "task": "Discuss and develop a go-to-market strategy for a new AI-powered productivity tool targeting small businesses", + "agents": [ + { + "agent_name": "Product Manager", + "description": "Leads product strategy and development", + "system_prompt": "You are a senior product manager. Focus on product positioning, features, user needs, and market fit. Ask probing questions and build on others ideas.", + "model_name": "gpt-4o", + "max_loops": 3, + }, + { + "agent_name": "Marketing Strategist", + "description": "Develops marketing and positioning strategy", + "system_prompt": "You are a marketing strategist. Focus on target audience, messaging, channels, and competitive positioning. Contribute marketing insights to the discussion.", + "model_name": "gpt-4o", + "max_loops": 3, + }, + { + "agent_name": "Sales Director", + "description": "Provides sales and customer perspective", + "system_prompt": "You are a sales director with small business experience. Focus on pricing, sales process, customer objections, and market adoption. Share practical sales insights.", + "model_name": "gpt-4o", + "max_loops": 3, + }, + { + "agent_name": "UX Researcher", + "description": "Represents user experience and research insights", + "system_prompt": "You are a UX researcher specializing in small business tools. Focus on user behavior, usability, adoption barriers, and design considerations.", + "model_name": "gpt-4o", + "max_loops": 3, + } + ], + "max_loops": 3 + }' + ``` + +=== "Python (requests)" + ```python + import requests + import json + + API_BASE_URL = "https://api.swarms.world" + API_KEY = "your_api_key_here" + + headers = { + "x-api-key": API_KEY, + "Content-Type": "application/json" + } + + swarm_config = { + "name": "Product Strategy Discussion", + "description": "Collaborative chat to develop product strategy", + "swarm_type": "GroupChat", + "task": "Discuss and develop a go-to-market strategy for a new AI-powered productivity tool targeting small businesses", + "agents": [ + { + "agent_name": "Product Manager", + "description": "Leads product strategy and development", + "system_prompt": "You are a senior product manager. Focus on product positioning, features, user needs, and market fit. Ask probing questions and build on others ideas.", + "model_name": "gpt-4o", + "max_loops": 3, + }, + { + "agent_name": "Marketing Strategist", + "description": "Develops marketing and positioning strategy", + "system_prompt": "You are a marketing strategist. Focus on target audience, messaging, channels, and competitive positioning. Contribute marketing insights to the discussion.", + "model_name": "gpt-4o", + "max_loops": 3, + }, + { + "agent_name": "Sales Director", + "description": "Provides sales and customer perspective", + "system_prompt": "You are a sales director with small business experience. Focus on pricing, sales process, customer objections, and market adoption. Share practical sales insights.", + "model_name": "gpt-4o", + "max_loops": 3, + }, + { + "agent_name": "UX Researcher", + "description": "Represents user experience and research insights", + "system_prompt": "You are a UX researcher specializing in small business tools. Focus on user behavior, usability, adoption barriers, and design considerations.", + "model_name": "gpt-4o", + "max_loops": 3, + } + ], + "max_loops": 3 + } + + response = requests.post( + f"{API_BASE_URL}/v1/swarm/completions", + headers=headers, + json=swarm_config + ) + + if response.status_code == 200: + result = response.json() + print("GroupChat swarm completed successfully!") + print(f"Cost: ${result['metadata']['billing_info']['total_cost']}") + print(f"Execution time: {result['metadata']['execution_time_seconds']} seconds") + print(f"Chat discussion: {result['output']}") + else: + print(f"Error: {response.status_code} - {response.text}") + ``` + +**Example Response**: +```json +{ + "job_id": "swarms-2COVtf3k0Fz7jU1BOOHF3b5nuL2x", + "status": "success", + "swarm_name": "Product Strategy Discussion", + "description": "Collaborative chat to develop product strategy", + "swarm_type": "GroupChat", + "output": "User: \n\nSystem: \n Group Chat Name: Product Strategy Discussion\nGroup Chat Description: Collaborative chat to develop product strategy\n Agents in your Group Chat: Available Agents for Team: None\n\n\n\n[Agent 1]\nName: Product Manager\nDescription: Leads product strategy and development\nRole.....", + "number_of_agents": 4, + "service_tier": "standard", + "execution_time": 47.36732482910156, + "usage": { + "input_tokens": 30, + "output_tokens": 1633, + "total_tokens": 1663, + "billing_info": { + "cost_breakdown": { + "agent_cost": 0.04, + "input_token_cost": 0.00009, + "output_token_cost": 0.024495, + "token_counts": { + "total_input_tokens": 30, + "total_output_tokens": 1633, + "total_tokens": 1663 + }, + "num_agents": 4, + "service_tier": "standard", + "night_time_discount_applied": false + }, + "total_cost": 0.064585, + "discount_active": false, + "discount_type": "none", + "discount_percentage": 0 + } + } +} +``` ## Best Practices diff --git a/docs/swarms_cloud/swarm_types.md b/docs/swarms_cloud/swarm_types.md index e28bace4..d964ce0c 100644 --- a/docs/swarms_cloud/swarm_types.md +++ b/docs/swarms_cloud/swarm_types.md @@ -8,10 +8,12 @@ Each multi-agent architecture type is designed for specific use cases and can be | MixtureOfAgents | Builds diverse teams of specialized agents, each contributing unique skills to solve complex problems. Excels at tasks requiring multiple types of expertise. | [Learn More](mixture_of_agents.md) | | SequentialWorkflow | Executes tasks in a strict, predefined order. Perfect for workflows where each step depends on the completion of the previous one. | [Learn More](sequential_workflow.md) | | ConcurrentWorkflow | Runs independent tasks in parallel, significantly reducing processing time for complex operations. Ideal for tasks that can be processed simultaneously. | [Learn More](concurrent_workflow.md) | +| GroupChat | Enables dynamic collaboration between agents through a chat-based interface, facilitating real-time information sharing and decision-making. | [Learn More](group_chat.md) | | MultiAgentRouter | Acts as an intelligent task dispatcher, distributing work across agents based on their capabilities and current workload. | [Learn More](multi_agent_router.md) | | MajorityVoting | Implements robust decision-making through consensus, ideal for tasks requiring collective intelligence or verification. | [Learn More](majority_voting.md) | + - +