GitHub Copilot

How to use the Spice.ai for GitHub Copilot Extension

The Spice AI GitHub Copilot Extension makes it easy to access and chat with external data in GitHub Copilot, enhancing AI-assisted research, Q&A, code, and documentation suggestions for greater accuracy.

The @spiceai extension in GitHub Copilot.

Access structured and unstructured data from any Spice data source like GitHub, PostgreSQL, MySQL, Snowflake, Databricks, GraphQL, data lakes (S3, Delta Lake, OneLake), HTTP(s), SharePoint, and even FTP.

Some example prompts:

• @spiceai What documentation is relevant to this file?

• @spiceai Write documentation about the user authentication issue

• @spiceai Who are the top 5 committers to this repository?

• @spiceai What are the latest error logs from my web app?

Installing the Spice.ai for GitHub Copilot Extension

To install the extension, visit the GitHub Marketplace and search for Spice.ai.

The Spice.ai Extension in the GitHub Marketplace.

Scroll down, and click Install it for free.

Install the Community Edition of the Spice.ai Extension for free.

Configuring the extension

1. Once installed, open Copilot Chat and type @spiceai. Press enter.

Starting a conversaton with @spiceai

1. A prompt will appear to connect to the Spice.ai Cloud Platform.

Connection prompt

1. You will need to authorize the extension. Click Authorize spiceai.

Permissions screen for the Spice AI Extension

1. To create an account on the Spice.ai Cloud Platform, click Authorize Spice AI Platform.

Authorizing the Spice.ai Cloud Platform

1. Once your account is created, you can configure the extension. Select from a set of ready-to-use datasets to get started. You can configure other datasets after setup.

GitHub Copilot Extension Setup page

1. The extension will take up to 30 seconds to deploy and load the initial dataset.

GitHub Copilot Extension Deployment page

1. When complete, proceed back to GitHub Copilot Chat.

Chatting with Copilot Chat

Start a new chat

To chat with the Spice.ai for GitHub Copilot extension, prefix the message with @spiceai

If @spiceai does not appear in the popup (2), ensure that all the installation steps have been followed.

Querying which datasets are available

To list the datasets available to Copilot, try @spiceai What datasets do I have access to?

Querying data using SQL

1

Navigate to Spice.ai and click Portal

2

Click the copilot app

This will open the Spice.ai playground

3

List the tables available

Run show tables to list the tables that are available to the Copilot extension

4

Querying repository content

To query the GitHub content, query one of the tables above like so:

SELECT name, path, url, content_embedding FROM react.docs LIMIT 10;

Reset the Copilot instance

1

Navigate to spice.ai and click Portal

2

Open the account menu in the top-right corner

3

Click Account Settings

4

Click GitHub Copilot

5

Click Reset GitHub Copilot config