This project builds a multi-agent system designed to perform comprehensive market research and generate AI use cases tailored for a specified company or industry. The goal is to analyze market standards, assess competitors, and propose AI-driven solutions that align with the company's operational goals and enhance customer experiences.
- High-Level and Low-Level Design
- Source Code Architecture Overview
- Installation and Setup
- Usage
- Project Structure
- Contributing
- License
The high-level design provides a broad overview of the application, outlining the main components and data flow:
- User Interface:
- Built with Streamlit to capture user input for the company name and industry.
- Multi-Agent System:
- A set of modular agents, each handling a specific aspect of the workflow, from industry research to proposal creation.
- Proposal Generation:
- Agents produce insights and a final structured document with suggested use cases and relevant resources.
The low-level design details the responsibilities and functionalities within each agent:
- Industry Research Agent: Fetches high-level insights on the specified industry.
- Competitor Analysis Agent: Analyzes competitors’ AI usage within the industry.
- Use Case Generation Agent: Proposes AI applications aligned with the company's focus areas.
- Resource Collection Agent: Finds datasets or resources for implementing the use cases.
- Proposal Creation Agent: Compiles all gathered information into a Markdown document.
For an in-depth look at the High-Level and Low-Level Design, refer to the full document here.
The objective of this project is to create a structured, modular system where each agent performs a designated role, contributing to the overall goal of producing a tailored AI use-case proposal.
-
User Interface (UI):
- File:
app.py
- Role: Takes user input and initiates the process.
- File:
-
Agents:
- Industry Research Agent (
industry_research.py
): Collects high-level insights into the company’s industry. - Competitor Analysis Agent (
competitor_analysis.py
): Identifies competitors and their AI initiatives. - Use Case Generation Agent (
use_case_generation.py
): Proposes AI/ML use cases based on industry insights. - Resource Collection Agent (
resource_collection.py
): Finds datasets for the proposed use cases. - Proposal Creation Agent (
proposal_creation.py
): Compiles the insights, use cases, and resources into a formatted Markdown proposal.
- Industry Research Agent (
-
Utility Module (
utils.py
):- Contains helper functions used across different agents.
-
Output:
- File:
output/proposal.md
- Content: A Markdown file containing a well-structured AI/ML use-case proposal.
- File:
- User Input: User provides the company name and industry in the UI.
- Industry Research: Insights are generated about the industry.
- Competitor Analysis: Competitors are analyzed for their AI use.
- Use Case Generation: Relevant AI use cases are proposed.
- Resource Collection: Datasets are linked for each use case.
- Proposal Creation: The final proposal document is generated.
For a more detailed Source Code Architecture Overview, refer to the document here.
-
Clone the Repository
git clone https://github.com/yourusername/market-research-use-case-generator.git cd market-research-use-case-generator
-
Install Dependencies Make sure you have
streamlit
and other required packages installed. You can install them via:pip install -r requirements.txt
-
Run the Application Launch the Streamlit app:
streamlit run app.py
-
Enter Company Information:
- When prompted, enter the company's name and select its industry from the dropdown.
-
Generate Proposal:
- The agents will gather insights, suggest use cases, and generate a
proposal.md
file.
- The agents will gather insights, suggest use cases, and generate a
-
Review Proposal:
- The proposal document can be found in the
output/
directory.
- The proposal document can be found in the
├── app.py # Main application file (Streamlit UI)
├── industry_research.py # Industry research agent
├── competitor_analysis.py # Competitor analysis agent
├── use_case_generation.py # Use case generation agent
├── resource_collection.py # Resource collection agent
├── proposal_creation.py # Proposal creation agent
├── utils.py # Utility functions
├── requirements.txt # Project dependencies
├── output/
│ └── proposal.md # Generated proposal file
- Fork the repository.
- Create a feature branch (
git checkout -b feature/new-feature
). - Commit your changes (
git commit -m 'Add new feature'
). - Push to the branch (
git push origin feature/new-feature
). - Create a new Pull Request.
This project is licensed under the MIT License. See the LICENSE
file for more details.