ziinc-copilot
This project is a Go application that demonstrates how to use retrieval augmented generation in an agent-based GitHub Copilot Extension.
Installation:
- Clone the repository:
git clone git@github.com:copilot-extensions/rag-extension.git
cd rag-extension
- Install dependencies:
go mod tidy
Usage
- Start up ngrok with the port provided:
ngrok http http://localhost:8080
- Set the environment variables (use the ngrok generated url for the
FDQN) - Run the application:
go run .
Accessing the Agent in Chat:
- In the
Copilottab of your Application settings (https://github.com/settings/apps/)/agent
- Set the URL that was set for your FQDN above with the endpoint
/agent(e.g.https://6de513480979.ngrok.app/agent) - Set the Pre-Authorization URL with the endpoint
/auth/authorization(e.g.https://6de513480979.ngrok.app/auth/authorization)
- In the
Generaltab of your application settings (https://github.com/settings/apps/)
- Set the
Callback URLwith the/auth/callbackendpoint (e.g.https://6de513480979.ngrok.app/auth/callback) - Set the
Homepage URLwith the base ngrok endpoint (e.g.https://6de513480979.ngrok.app/auth/callback)
- Ensure your permissions are enabled in
Permissions & events>
Account Permissions>Copilot Chat>Access: Read Only
- Ensure you install your application at (
https://github.com/apps/) - Now if you go to
https://github.com/copilotyou can@your agent using the name of your application.
What Can It Do
Test out the agent with the following commands!
| Description | Prompt |
|---|---|
User asking @agent how to configure a Copilot extension |
@agent How do I configure a copilot extension? |
User asking @agent what a Copilot extension looks like |
@agent What is the response format for a copilot extension? |