{"id":18235815,"url":"https://github.com/XCollab/NoteMaster-AI","last_synced_at":"2025-04-04T04:30:28.391Z","repository":{"id":246903556,"uuid":"822681828","full_name":"XCollab/NoteMaster-AI","owner":"XCollab","description":"NoteMaster AI's FastAPI component provides a robust backend service for transforming photos into structured notes using AI. It handles image processing, text extraction, and note generation, offering a RESTful API for seamless integration into various applications.","archived":false,"fork":false,"pushed_at":"2024-11-28T03:24:36.000Z","size":115052,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T02:12:21.086Z","etag":null,"topics":["ai","ai-notes","app","g4f","imagetotext","llm","notes","notes-app","orc","python3","streamlit","streamlit-webapp"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/XCollab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-01T15:46:06.000Z","updated_at":"2025-01-16T18:00:36.000Z","dependencies_parsed_at":"2024-11-28T04:32:54.076Z","dependency_job_id":null,"html_url":"https://github.com/XCollab/NoteMaster-AI","commit_stats":null,"previous_names":["codewithdark-git/notemaster-ai","xcollab/notemaster-ai"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XCollab%2FNoteMaster-AI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XCollab%2FNoteMaster-AI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XCollab%2FNoteMaster-AI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XCollab%2FNoteMaster-AI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XCollab","download_url":"https://codeload.github.com/XCollab/NoteMaster-AI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247123070,"owners_count":20887259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","ai-notes","app","g4f","imagetotext","llm","notes","notes-app","orc","python3","streamlit","streamlit-webapp"],"created_at":"2024-11-05T00:22:34.469Z","updated_at":"2025-04-04T04:30:28.386Z","avatar_url":"https://github.com/XCollab.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NoteMaster AI - FastAPI Component\n\n## Overview\n\nNoteMaster AI's FastAPI component provides a robust backend service for transforming photos into structured notes using AI. It handles image processing, text extraction, and note generation, offering a RESTful API for seamless integration into various applications.\n\n## Features\n\n- **Image Upload**: Accepts multiple image formats for processing.\n- **Text Extraction**: Utilizes Tesseract OCR for extracting text from images.\n- **AI-Driven Note Generation**: Uses AI models to convert extracted text into organized notes.\n- **API Endpoints**: Provides endpoints for image processing, note management, and more.\n\n## Available Models\n\nThe FastAPI component supports the following AI models:\n- **GPT-3.5 Turbo**\n- **GPT-4o**\n- **Llama 3**\n- **Mixtral 70b**\n- **BlackBox**\n- **Meta AI**\n\n## Installation Options\n\n### Option 1: Streamlit Only Version (First Release)\nIf you want to use the app without FastAPI, you can use the first release of NoteMaster AI which is Streamlit-only:\n1. Go to the [Releases](https://github.com/codewithdark-git/NoteMaster-AI/releases) page.\n2. Download the first release.\n3. Follow the installation steps as mentioned on the release page.\n\n### Option 2: Full Version with FastAPI\nThe current version includes FastAPI for enhanced functionality. Follow the standard installation steps mentioned below to use this version.\n\n## Installation\n\n1. Clone the repository:\n    ```bash\n    git clone https://github.com/codewithdark-git/NoteMaster-AI.git\n    cd NoteMaster-AI\n    ```\n\n2. Install the required packages:\n    ```bash\n    pip install -r requirements.txt\n    ```\n\n3. Run the API generation script:\n    ```bash\n    python backend/generate_api.py\n    ```\n\n   After running the script, copy the API from `.env` and add it to your frontend configuration.\n\n4. Start the FastAPI server:\n    ```bash\n    uvicorn fastapi_app:app --reload\n    ```\n\n## Usage\n\n1. **Access the API**:\n   - The API runs on `http://localhost:8000`\n   - Access the interactive API documentation at `http://localhost:8000/docs`\n\n2. **Endpoints**:\n   - `POST /generate_from_images`: Generate notes from uploaded images\n   - `POST /generate_from_link`: Generate notes from a link\n   - `GET /notes/`: Retrieve all notes\n   - `DELETE /notes/{note_id}`: Remove notes\n   - `POST /follow-up-question/`: Generate a follow-up response based on a saved note\n\n3. **Example Usage**:\n   - `curl -X POST -F \"files=@image1.jpg\" http://localhost:8000/generate_from_images`\n   - `curl -X POST -F  http://localhost:8000/generate_from_link`\n   - `curl -X GET http://localhost:8000/notes/`\n   - `curl -X DELETE http://localhost:8000/notes/{note_id}`\n   - `curl -X POST -F \"note_id=1\" -F \"user_prompt=What more can I learn?\" http://localhost:8000/follow-up-question/`\n\n## Customization\n\n- **Model Configuration**: Adjust model settings in `fastapi_app.py`.\n- **API Behavior**: Modify processing parameters and response formats.\n\n## Contributing\n\nContributions are welcome! Please submit a pull request or open an issue to discuss your ideas.\n\n## License\n\nThis project is licensed under the MIT License.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FXCollab%2FNoteMaster-AI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FXCollab%2FNoteMaster-AI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FXCollab%2FNoteMaster-AI/lists"}