Setting Up
Create your RAG-Buddy account and set up a project.
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.
- Visit the RAG-Buddy Console.
- Select the
Sign Up
option and complete the registration form. - Follow the prompts to verify your account.
- 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.
A project currently contains two services:
- RAG-Buddy Cache
- RAG-Buddy Analytics
To create a new project, follow these steps:
- On your RAG-Buddy Console, click
[Create a new project]
. - Name your project.
- Select
OpenAI:ADA2
as the embedding model. - Select
OpenAI Chat Completions API
as the LLM model type. - Select the
RAG+Citation
or theText-Classification
option.- In case you choose
Text-Classification
, clickNext
to move on to the next step. - Add the classes you wish to use in your
Text-Classification
requests in theClasses list
.
- In case you choose
- Click
Create Project
to create your project.
Generating an Access Key
An API key is essential for secure access to your RAG-Services.
- Navigate to the
Services
tab. - Scroll down to the
API Keys for Cache
section. - Click on
Create new key
. - Assign a name to your key and select
Create API Key
. - 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.