Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.67 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.67 KB
Raw

@ubiquity-os/command-ask

This is a high context aware GitHub organization integrated bot that uses the OpenAI GPT-4o model to provide highly relevant answers to questions and queries in GitHub issues and pull requests.

Usage

In any repository where your Ubiquity OS app is installed, both issues and pull requests alike, you simply mention @UbiquityOS with your question or query and using the latest OpenAi GPT-4o model, the bot will provide you with a highly relevant answer.

How it works

With its huge context window, we are able to feed the entire conversational history to the model which we obtain by recursively fetching any referenced issues or pull requests from the chat history. This allows the model to have a very deep understanding of the current scope and provide highly relevant answers.

As it receives everything from discussions to pull request diffs and review comments, it is a highly versatile and capable bot that can assist in a wide range of scenarios.

Installation

ubiquibot-config.yml:

plugins:
  - uses:
      - plugin: http://localhost:4000
        with:
          model: ""
          openAiBaseUrl: ""

.dev.vars (for local testing):

To use the Openrouter API for fetching chat history, set the OPENROUTER_API_KEY in the .dev.vars file and specify the OpenAiBase URL in the ubiquibot-config.yml file. Alternatively, you can set the OPENAI_API_KEY in the .dev.vars file.

OPENAI_API_KEY=your_openai_api_key
SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key
VOYAGEAI_API_KEY=your_voyageai_api_key
OPENROUTER_API_KEY=your_openrouter_api_key
UBIQUITY_OS_APP_NAME="UbiquityOS"

Testing

yarn test