Introduction to II-Researcher

II-Researcher is a cutting-edge deep search agent designed to enhance your web searching capabilities. Utilizing advanced BAML functions, it performs intelligent web searches and generates comprehensive answers to your queries. This project is a game-changer for developers, researchers, and anyone looking to harness the power of AI for information retrieval.

For more details about our project, please visit our blog post.

Key Features of II-Researcher

• 🔍 Intelligent web search using Tavily and SerpAPI search providers
• 🕸️ Web scraping and content extraction with multiple providers (Firecrawl, Browser, BS4, Tavily)
• 🧠 Multi-step reasoning and reflection capabilities
• ⚙️ Configurable LLM models for various tasks
• ⚡ Asynchronous operation for improved performance
• 📝 Comprehensive answer generation with references
• 🛠️ Support for customizable pipelines and reasoning methods for deep search

Technical Architecture and Implementation

II-Researcher is built on a robust architecture that integrates various AI models and web scraping technologies. The project consists of 165 files and 25,750 lines of code, showcasing its complexity and capability. The architecture supports multiple search providers and scraping methods, allowing for flexible and efficient data retrieval.

Installation and Setup

To get started with II-Researcher, follow these installation steps:

Option 1: Install from PyPI

pip install ii-researcher

Option 2: Install from Source

1. Clone the repository:

git clone https://github.com/Intelligent-Internet/ii-researcher.git
cd ii-researcher

2. Install the package in development mode:

pip install -e .

3. Set up your environment variables:

# API Keys
export OPENAI_API_KEY="your-openai-api-key"
export TAVILY_API_KEY="your-tavily-api-key"
export SERPAPI_API_KEY="your-serpapi-api-key"
export FIRECRAWL_API_KEY="your-firecrawl-api-key"

Usage Examples and API Overview

Once installed, you can run the deep search agent using the command line interface:

python ii_researcher/cli.py --question "your question here" --stream

For a more interactive experience, you can also use the web interface. Ensure that the backend API is running:

python api.py

The API server will be available at http://localhost:8000.

Community and Contribution

II-Researcher is an open-source project that thrives on community contributions. We encourage developers and enthusiasts to participate by submitting issues, feature requests, or pull requests. Join our community and help us improve the project!

License and Legal Considerations

II-Researcher is licensed under the Apache License 2.0. This allows you to use, modify, and distribute the software under certain conditions. Make sure to review the license for more details on usage and distribution rights.

Conclusion

II-Researcher is a powerful tool for anyone looking to enhance their web searching capabilities. With its intelligent search features and comprehensive answer generation, it stands out as a valuable resource in the open-source community. Explore the project today and unlock the potential of intelligent web searches!

Resources

For more information, visit the official GitHub repository.

FAQ