50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
# OpenAI Researcher Agent
|
|
A multi-agent research application built with OpenAI's Agents SDK and Streamlit. This application enables users to conduct comprehensive research on any topic by leveraging multiple specialized AI agents.
|
|
|
|
### Features
|
|
|
|
- Multi-Agent Architecture:
|
|
- Triage Agent: Plans the research approach and coordinates the workflow
|
|
- Research Agent: Searches the web and gathers relevant information
|
|
- Editor Agent: Compiles collected facts into a comprehensive report
|
|
|
|
- Automatic Fact Collection: Captures important facts from research with source attribution
|
|
- Structured Report Generation: Creates well-organized reports with titles, outlines, and source citations
|
|
- Interactive UI: Built with Streamlit for easy research topic input and results viewing
|
|
- Tracing and Monitoring: Integrated tracing for the entire research workflow
|
|
|
|
### How to get Started?
|
|
|
|
1. Clone the GitHub repository
|
|
```bash
|
|
git clone https://github.com/Shubhamsaboo/awesome-llm-apps.git
|
|
cd awesome-llm-apps/ai_agent_tutorials/openai_researcher_agent
|
|
```
|
|
|
|
2. Install the required dependencies:
|
|
|
|
```bash
|
|
cd awesome-llm-apps/ai_agent_tutorials/openai_researcher_agent
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
3. Get your OpenAI API Key
|
|
|
|
- - Sign up for an [OpenAI account](https://platform.openai.com/) and obtain your API key.
|
|
- Set your OPENAI_API_KEY environment variable.
|
|
```bash
|
|
export OPENAI_API_KEY='your-api-key-here'
|
|
```
|
|
|
|
4. Run the team of AI Agents
|
|
```bash
|
|
streamlit run openai_researcher_agent.py
|
|
```
|
|
|
|
Then open your browser and navigate to the URL shown in the terminal (typically http://localhost:8501).
|
|
|
|
### Research Process:
|
|
- Enter a research topic in the sidebar or select one of the provided examples
|
|
- Click "Start Research" to begin the process
|
|
- View the research process in real-time on the "Research Process" tab
|
|
- Once complete, switch to the "Report" tab to view and download the generated report |