Welcome to the Market Research & Use Case Generator! This tool allows users to input a company's URL, extract its content, generate actionable AI/ML use cases from the content, and fetch relevant datasets from Kaggle. Powered by third-party APIs like Tavily, Google Gemini, and Kaggle, this system helps you identify AI opportunities and access valuable datasets for analysis.
- Overview
- Features
- System Architecture
- Modules
- Getting Started
- Technologies Used
- How to Use
- Output
- Contributing
- License
The Market Research & Use Case Generator is designed to extract valuable insights from any company’s website. By analyzing the company’s content, the system generates relevant AI/ML use cases and identifies datasets related to those use cases. You can download these results in .csv
and .txt
formats.
- URL Input: Simply input a company's URL, and the system will handle the rest.
- Content Extraction: Automatically extracts content from the given URL using the Tavily API.
- Use Case Generation: Generates actionable AI/ML use cases and keywords using Google Gemini.
- Dataset Fetching: Fetches relevant datasets from Kaggle based on generated keywords.
- Downloadable Results: Get structured results in
.csv
and.txt
formats for easy access.
The Market Research & Use Case Generator follows a modular architecture, comprising several interconnected components:
- User Interface (UI): Built with Streamlit, the UI allows users to input URLs and interact with the application.
- API Integrations:
- Tavily API: Extracts content from the provided URL.
- Google Gemini API: Analyzes content and generates AI/ML use cases.
- Kaggle API: Retrieves relevant datasets for generated keywords.
- Data Processing: Aggregates use cases and datasets into a final output.
- Output Handling: Allows users to download results in
.csv
and.txt
formats.
+----------------------------+
| Streamlit UI |
| |
| 1. Input URL |
| 2. Trigger Analysis |
+----------------------------+
|
v
+----------------------------+ +-------------------------------+ +----------------------------+
| Tavily API |---->| Google Gemini API |---->| Kaggle API |
| Extracts Content | | Generates Use Cases | | Fetches Datasets |
| from the URL | | and Keywords | | based on Keywords |
+----------------------------+ +-------------------------------+ +----------------------------+
| |
v v
+----------------------------------------------------------------------------+
| Data Aggregation |
| Aggregates Use Cases & Datasets |
| Structures Data for Output |
+----------------------------------------------------------------------------+
|
v
+----------------------------+
| Output Handling |
| 1. Save to .csv and .txt |
| 2. Display Results |
+----------------------------+
The following files are created by the system to store the output:
File Name | Data Type | Description |
---|---|---|
usecases_txt.txt |
Plain Text | Contains AI-generated use cases derived from extracted content. |
datasets.csv |
CSV | Contains Kaggle datasets fetched based on generated keywords. |
- Streamlit web interface for input and interaction.
- User inputs a company URL, triggers the analysis, and views results.
- Extracts content from the provided company URL.
- The raw content is sent for further processing.
- Generates AI/ML use cases and keywords based on the extracted content.
- Fetches relevant datasets based on generated keywords.
- Combines use cases and datasets into structured files for output.
To get started with the Market Research & Use Case Generator, follow these steps:
- Python 3.8 or higher
- API keys for Tavily, Google Gemini, and Kaggle
-
Clone the repository:
git clone https://github.com/JANNATHA-MANISH/GENAI-Multi-Agent-Phidata cd market-research-use-case-generator
-
Install the required dependencies:
pip install -r requirements.txt
-
Set up your API keys:
- Create a
.env
file and add your API keys for Tavily, Google Gemini, and Kaggle.
Example
.env
file:TAVILY_API_KEY=your-tavily-api-key GEMINI_API_KEY=your-gemini-api-key KAGGLE_API_KEY=your-kaggle-api-key
- Create a
-
Run the application:
streamlit run app.py
- Streamlit – For building the interactive web interface.
- Tavily API – For extracting content from websites.
- Google Gemini API – For generating AI/ML use cases.
- Kaggle API – For fetching relevant datasets.
- Python 3.x – The primary programming language.
- Pandas – For data manipulation and structuring.
- dotenv – For environment variable management.
- Input a URL: Enter the URL of a company’s website in the provided text field.
- Trigger Analysis: Click the "Start Analysis" button to begin the process.
- View Results: Once the process is complete, view the generated use cases and related datasets.
- Download Files: Download the results as
.csv
and.txt
files for further analysis.
After running the analysis, the following output will be available:
- Use Cases: A list of AI/ML use cases related to the company’s website, with detailed descriptions and potential applications.
- Datasets: A list of datasets related to the generated use cases, fetched from Kaggle.
-
use_cases.txt:
Use Case Title: Predictive Maintenance for Commercial Vehicles Objective/Use Case: To reduce downtime and maintenance costs for Tata Motors'...... AI Application: Machine Learning . Cross-Functional Benefit: Reduced maintenance costs in the operations department....
-
datasets.csv:
Dataset Name Dataset Link Source Keywords Predictive Maintenance https://www.kaggle.com/datasets/xyz Kaggle predictive maintenance, IoT IoT Sensor Data https://www.kaggle.com/datasets/abc Kaggle IoT, sensor data, maintenance
To get started, clone the repository to your local machine:
git clone https://github.com/your-username/market-research-use-case-generator.git
cd market-research-use-case-generator
(Optional but recommended) Create a virtual environment for the project:
python -m venv menv
Activate the virtual environment:
- On Windows:
menv\Scripts\activate
- On macOS/Linux:
source menv/bin/activate
Install all necessary dependencies by running:
pip install -r requirements.txt
To interact with the APIs, you need to configure your API keys. Create a .streamlit/secrets.toml
file in the root directory and add your keys:
[default]
TAVILY_KEY = "your_tavily_api_key"
GEMINI_KEY = "your_google_api_key"
Be sure to replace "your_tavily_api_key"
and "your_google_api_key"
with your actual keys.
Finally, to launch the app:
streamlit run market_research_agent.py
Once the app is running, enter your company URL and click "Run Analysis" to start generating use cases and fetching datasets.
This project requires Python 3.9 or higher, along with the following dependencies:
phidat
pandas
kaggle
streamlit
tavily-python
To install the dependencies:
pip install -r requirements.txt
https://drive.google.com/file/d/1uDMRBJfOdL4V-ElIY1H3XEIdzkkoVLWa/view?usp=sharing
https://drive.google.com/file/d/16lrw72mziKges8VysBQLw4l6lOuqMlCP/view?usp=sharing