8000 GitHub - InitialXKO/KResearch: An application that uses the Gemini API to conduct deep research. It clarifies the topic with the user, devises a research strategy, iteratively executes research actions using Google Search, and synthesizes a comprehensive report with citations. The process is streamed to the user.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

An application that uses the Gemini API to conduct deep research. It clarifies the topic with the user, devises a research strategy, iteratively executes research actions using Google Search, and synthesizes a comprehensive report with citations. The process is streamed to the user.

License

Notifications You must be signed in to change notification settings

InitialXKO/KResearch

 
 

Repository files navigation

KResearch

An advanced AI-powered deep research application that synthesizes information from numerous sources to generate comprehensive, well-documented reports on complex topics.

License React TypeScript TailwindCSS

Table of Contents

About The Project

KResearch is a sophisticated research assistant designed to tackle complex topics by leveraging a multi-agent AI system. It automates the process of in-depth research by planning, executing, and synthesizing information from the web. The final output is a comprehensive, well-structured report complete with source citations and a visual knowledge graph, making it an invaluable tool for students, analysts, and anyone needing to quickly develop a deep understanding of a subject.

Key Features

  • Conversational AI Agents: Utilizes 'Alpha' (Strategist) and 'Beta' (Tactician) agents who collaborate to create an optimal research plan.
  • Iterative Research Cycles: Performs multiple cycles of planning, searching, and reading to gather comprehensive insights.
  • Real-time Progress Tracking: Visualizes the AI's entire thought process in a detailed, step-by-step timeline.
  • Configurable Research Modes: Offers 'Balanced', 'Deep Dive', 'Fast', and 'Ultra Fast' modes to tailor the research process to your needs.
  • Comprehensive Final Report: Generates a well-structured final report in Markdown, synthesizing all findings.
  • Knowledge Graph Visualization: Automatically creates a Mermaid.js graph to visualize key entities and their relationships.
  • Sourced Citations: Grounds all research using Google Search and provides a complete list of sources.
  • Modern & Responsive UI: A sleek, glassmorphism design built with React and Tailwind CSS, featuring light and dark modes.

Built With

Getting Started

This section will guide you through setting up and running the KResearch application locally.

Prerequisites

You must have a Google Gemini API key to use this application.

Installation

This project is a static web application but uses a local development server for better module handling and live reloading.

  1. Clone the repository:
    git clone https://github.com/KuekHaoYang/KResearch
    cd research
  2. Install dependencies: Make sure you have Node.js installed, then run:
    npm install
  3. Start the development server:
    npm run dev
  4. Open in browser: Once the server is running, open your browser and navigate to the local address provided (e.g., http://localhost:5173, http://localhost:3000, etc., depending on your setup).

Configuration

The application requires the Google Gemini API key to be available as an environment variable.

Create a .env file in the root of the project (if your serving method supports it) or ensure the API_KEY is set in the environment where the application is hosted.

# .env file
API_KEY="YOUR_GEMINI_API_KEY"

The application code directly accesses this key via process.env.API_KEY. You must ensure your local server or deployment environment makes this variable accessible to the frontend code.

Usage

Once the application is running in your browser:

  1. Select a Research Mode: Choose from 'Balanced', 'Deep Dive', 'Fast', or 'Ultra Fast' depending on the desired depth and speed.
  2. Enter Your Query: Type your research topic or question into the main text area.
  3. Start Research: Click the "Start Research" button or press Enter (without Shift).
  4. Monitor Progress: Observe the research log as the AI agents work. You can stop the process at any time.
  5. Review Results: Once complete, the final report, knowledge graph, and citations will be displayed. You can copy the report text to your clipboard.
  6. New Research: Click "Start New Research" to clear the results and begin again.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

  • Powered by the Google Gemini API.
  • UI inspired by modern glassmorphism design trends.

About

An application that uses the Gemini API to conduct deep research. It clarifies the topic with the user, devises a research strategy, iteratively executes research actions using Google Search, and synthesizes a comprehensive report with citations. The process is streamed to the user.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 96.3%
  • HTML 3.7%
0