Git Product home page Git Product logo

ai-assistant's Introduction

AI Assistant Chat Application

This project is an AI assistant chat application built using FastAPI + LLamaIndex + ChromaDB. The AI assistant is capable of responding to user queries and performing various tasks such as providing information and answering questions.

Installation

To install and run the AI assistant application locally, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/K4rlosReyes/ai-assistant.git
    
  2. Navigate to the project directory:

    cd ai-assistant
  3. Install the dependencies using pip:

    pip install -r requirements.txt
  4. Start the FastAPI server:

    python main.py
  5. Access the AI assistant API at http://localhost:8000.

To try it in the terminal change step 4:

python -m core.process.rag

Usage

Once the application is running, you can interact with the AI assistant through requests. The AI assistant will respond accordingly.

Development Practices

This repository follows the following development practices:

  • Conventional Commits: Commits follow the conventional commits specification for clear and standardized commit messages.
  • Code Style: Code adheres to the PEP 8 style guide for Python code.
  • Documentation: Code is well-documented, and additional documentation is provided where necessary.
  • Testing: Unit tests are included in the tests directory to ensure code reliability and maintainability.
  • Continuous Integration: Continuous Integration (CI) pipelines are set up to automatically run tests and checks on every push or pull request.

Contributing

Contributions to the AI assistant chat application are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository and create a new branch for your feature or fix.
  2. Make your changes and ensure that the code adheres to the project's development practices.
  3. Write tests for your changes to ensure code reliability.
  4. Submit a pull request detailing your changes and the problem they solve.

License

This project is licensed under the MIT License.

ai-assistant's People

Contributors

k4rlosreyes avatar

Watchers

Kostas Georgiou avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.