AI-Note

An API service for multi-model chat and conversation history management.

• Installation
• Running the Application
• Testing
  • Unit Tests
  • API Endpoints Testing
• API Documentation
  • Chat API
  • History API

1. Clone the repository:

   git clone <repository-url>
   cd AI-Note

2. Install backend dependencies:

   pip install -r requirements.txt

3. Set up environment variables: Create a .env file in the app directory with the following variables:

   DASHSCOPE_API_KEY=your_dashscope_api_key
   MOONSHOT_API_KEY=your_moonshot_api_key
   DEEPSEEK_API_KEY=your_deepseek_api_key
   GEMINI_API_KEY=your_gemini_api_key
   CLAUDE_API_KEY=your_claude_api_key
   GPT_API_KEY=your_openai_api_key
   
   DASHSCOPE_BASE_URL=https://dashscope.aliyuncs.com/compatible-mode/v1
   MOONSHOT_BASE_URL=https://api.moonshot.cn/v1
   DEEPSEEK_BASE_URL=https://api.deepseek.com
   GEMINI_BASE_URL=https://generativelanguage.googleapis.com/v1beta/openai
   CLAUDE_BASE_URL=your_claude_openai_compatible_base_url
   GPT_BASE_URL=https://api.openai.com/v1
   

4. Install frontend dependencies:

   cd frontend
   npm install

Start the FastAPI server with hot reloading enabled:

uvicorn app.main:app --reload

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

Start the Webview:

cd frontend
npm run dev

The Webview will be available at http://localhost:3000.

Run the unit tests of different modules:

pytest -xvs app/tests/test_storage.py

pytest -xvs app/tests/test_rag.py

To view database contents for debugging:

python -m app.utils.db_viewer

Check app/routers/ for API definitions.