🤖 🔥 Let your users chat with your product features and execute things by text - open source Shopify sidekick

Documentation available here

🔥 OpenCopilot

OpenCopilot allows you to have your own product's AI copilot. It integrates with your underlying APIs and can execute API calls whenever needed. It uses LLMs to determine if the user's request requires calling an API endpoint. Then, it decides which endpoint to call and passes the appropriate payload based on the given API definition.

How does it work?

• Provide your API/backend definition, including your public endpoints and how to call them. Currently, OpenCopilot supports Swagger OpenAPI 3.0. We're also working on a UI to allow you to dynamically add endpoints.
• OpenCopilot validates your schema to achieve the best results.
• We feed the API definition to an LLM.
• Finally, you can integrate our user-friendly chat bubble into your SaaS app.

(In this example, the user was able to add a new fish to the store just by text commands)

🚀 Getting Started

• Make sure you have docker installed.

• To begin, clone this Git repository:

git clone git@github.com:openchatai/OpenCopilot.git

Please find below an update concerning the API key configuration in our system.

In the .env file located in the llm-server directory, make sure to replace the placeholder value for the OPENAI_API_KEY variable with your actual token:

OPENAI_API_KEY=YOUR_TOKEN_HERE
MYSQL_URI=mysql+pymysql://dbuser:dbpass@mysql:3306/opencopilot
QDRANT_PASS=bW9tZW50bmVhcmZld2VyYXJ0YmVuZG1pbGticmVhdGhldGFsZXN3aGFsZW5vYm9keXM=

Regarding the QDRANT_PASS variable, be advised that the current value functions as the default API key for Qdrant. We highly recommend customizing this key to suit your needs by modifying the corresponding value within the qdrant_config.yaml file.

For Linux Machines

To install the necessary dependencies and set up the environment for the OpenCopilot project, use the following command:

make install

For ARM Machines (Mac Silicon)

If you are using an ARM machine, specifically Mac Silicon, use the following command to install dependencies and set up the environment:

make install-arm

Once the installation is complete, you can access the OpenCopilot console at http://localhost:8888.

Additional Commands

• make migrate: Run Alembic migrations.
• make down: Stop and remove all containers.
• make exec-dashboard: Access the dashboard container's shell.
• make exec-llm-server: Access the llm-server container's shell.
• make restart: Restart all containers.
• make logs: Show container logs.
• make purge: Fully clean uninstall (remove containers, networks, volumes, .env).
• make help: Display help message with available targets.

This will install the necessary dependencies and set up the environment for the OpenCopilot project.

Once the installation is complete, you can access the OpenCopilot console at http://localhost:8888

Try it out:

You can try it out on opencopilot.so

(OpenCopilot is not affiliated with Shopify, and they do not use OpenCopilot, it's just a demo of what copilots are capable of)

AI Copilot: a growing trend

• Shopify is developing "Shopify Sidekick."
• Microsoft is working on "Windows Copilot."
• GitHub is in the process of creating "GitHub Copilot."
• Microsoft is also developing "Bing Copilot."

Our goal is to empower every SaaS product with the ability to have their own AI copilots tailored for their unique products.

🏁 What OpenCopilot can and can't do now?

• It is capable of calling your underlying APIs.
• It can transform the response into meaningful text.
• It can automatically populate certain request payload fields based on the context.
  • For instance, you can request actions like: "Initiate a new case about X problem," and the title field will be automatically filled with the appropriate name.
• It is not suitable for handling large APIs (you will need to write JSON transformers to make it work, refer to the docs for more)

🛣️ Teach the copilot via flows:

Most of the time, the copilot can figure out what actions to execute when the user requests something, but in case there is a complex flow, you can define it to help the copilot:

🛣️ Embed on your app in a few lines of code

Less than <10 lines of codes to implement on your web app or desktop app

Important links

• OpenCopilot Flows Editor
• The backend server (API) is reachable via http://localhost:8888/backend
• The dashboard server is reachable via http://localhost:8888/ or http://localhost:8888/dashboard

This project follows the all-contributors specification. Contributions of any kind are welcome!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind are welcome!

We love hearing from you! Got any cool ideas or requests? We're all ears! So, if you have something in mind, give us a shout!