Git Product home page Git Product logo

ai-assistant-bot's Introduction

๐Ÿš€ AI Assistant App for Rocket.Chat ๐Ÿค–

Description

This Rocket.Chat app provides an AI Assistant bot to help you understand the Rocket.Chat codebase. Built on top of Rocket.Chat's app framework, the bot leverages open-source LLMs (Large Language Models) from Hugging Face Inference APIs to answer your queries about the code's structure, logic, and workflows directly into the room

How to Use the App

  1. Installation:

    • Install the app on your Rocket.Chat server.
  2. Usage:

    • Navigate to the dedicated AI Assistant room.
    • Ask any questions you have regarding the Rocket.Chat codebase.
    • The bot will promptly respond with relevant information.
  3. Customization:

    • Modify app settings to change the language model (LLM) or view available LLMs.
    • Use commands provided within the app to customize settings.

Local Setup Guide

To set up the AI Assistant bot locally, follow these steps:

  1. Prerequisites:

    • Ensure you have a working Rocket.Chat server and Apps-Engine CLI installed on your machine. If not, set up the server here and CLI here.
  2. Clone the Repository:

    git clone https://github.com/<github_handle>/ai-assistant-bot.git
  3. Install Dependencies::

    npm install
  4. Deploy your app locally::

    rc-apps deploy --url http://localhost:3000 --username ${username} --password ${password}

    Your username and password are your local server's user credentials .Verify the successful build by accessing the /excalidraw endpoint in the Whiteboard app settings. You can access the React app through the provided URL.

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.