Welcome to the RAG-Buddy Guidebook’s “Setting Up” section. This part of the guide is designed to help you seamlessly configure your RAG-Buddy account, ensuring you get the most out of our services.

Creating an Account

To begin using RAG-Buddy, the first step is to create an account on our SaaS portal. If you already have an account, you can skip this step and proceed to the next section.

  1. Visit the RAG-Buddy Console.
  2. Select the Sign Up option and complete the registration form.
  3. Follow the prompts to verify your account.
  4. Once your account is verified, log in to access your console.

Adding a New Project

With your account set up, you can now create a new project.

Each project corresponds to a specific subscription. By default, your project is assigned to the Free subscription plan, allowing you to experiment with and evaluate our services. When you’re ready to deploy RAG-Buddy in a production environment, you can select the appropriate subscription plan for your project.
The first project of your account is a trial project, meaning you get to experience the Business plan for a week. After the week passes your project’s plan will be updated to the Free plan and the cache’s data will be reset. If you wish to keep your data, subscribe to the Business plan for your project.

A project currently contains two services:

  1. RAG-Buddy Cache
  2. RAG-Buddy Analytics

To create a new project, follow these steps:

  1. On your RAG-Buddy Console, click [Create a new project].
  2. Name your project.
  3. Select OpenAI:ADA2 as the embedding model.
  4. Select OpenAI Chat Completions API as the LLM model type.
  5. Select the RAG+Citation or the Text-Classification option.
    • In case you choose Text-Classification, click Next to move on to the next step.
    • Add the classes you wish to use in your Text-Classification requests in the Classes list.
  6. Click Create Project to create your project.
Currently all Cache settings are fixed to their default values. Please let us know if you are interested in support for different options.

Generating an Access Key

An API key is essential for secure access to your RAG-Services.

  1. Navigate to the Services tab.
  2. Scroll down to the API Keys for Cache section.
  3. Click on Create new key.
  4. Assign a name to your key and select Create API Key.
  5. Copy the newly generated API key for use in the next step.

By completing these steps, your RAG-Budy project environment is ready to go. The subsequent sections in the guidebook will delve into integration, usage, code examples, and FAQs.