With Repositories you can just upload the documents and we take care of the rest.

This guide will show you how to create RAG-based assistants that are able to interact with your documents.

Overview

RAG is a powerful technique that combines the strengths of retrieval-based systems and generative models to enable assistants to provide accurate and contextually relevant responses based on the content of your documents.

Before you get started

  • Create a collection of documents that you’d like your LLM to interact with.

  • Get a basic understanding of Prem’s APIs and SDKs.

1

Create A Repository and Upload Your Documents

The max file size is: 10MB

  • Use the sidebar to navigate to the Repositories page. Click New Repository to create a new place to store your documents.
Overview
  • Prepare your documents in a format supported by Prem, such as PDF, TXT, or DOCX. Ensure that the documents are clean, well-structured, and free of any formatting issues.

  • Upload your documents to a repository using Prem’s interface, API or SDK. You can either upload documents individually or in batches. Make sure to provide meaningful names or identifiers for your documents.

from premai import Prem

client = Prem(
    api_key=YOUR_API_KEY
)

FILE_CONTENT = "My friend Jack has a beautiful pet, he gave it the name Sparky, [...]"

response = client.repository.document.create(
	repository_id=REPOSITORY_ID,
	name="pets_and_their_owners.txt",
	content=FILE_CONTENT,
	document_type="text",
)

print(response)
# E.g., DocumentOutput(repository_id=4, document_id=14, name="pets_and_their_owners.txt", type="text", status="UPLOADED", chunk_count=0, error=None)
Overview
  • Once the documents are uploaded, Prem will automatically index them to enable fast and efficient retrieval.

The indexing process may take some time depending on the size and number of documents.

Overview
2

Choose a Model and Configure Retrieval Settings

Once you’ve uploaded your documents, you need to configure the retrieval settings. Head over to the Lab and choose a suitable model to test with your documents.

You can find the following retrieval settings in the Lab or in the Launchpad:

  • Limit: Sets the maximum number of top-matching documents to retrieve based on similarity.

  • Similarity: Measures how closely a query matches document embeddings. Higher values indicate greater similarity, ranging from 0 to 1.

3

Fine-tune the model with the Gym

You MUST add a project description, otherwise you will not be able to start the training.

  • Fine-tune your selected model in the Gym on your specific domain or task. This involves training the model on a subset of your documents and optimizing its parameters for better performance and coherence.
  • Integrate the fine-tuned model into your pipeline. When a user sends a query, the model will retrieve relevant documents from the repository and then pass them to the generative model to generate a contextually appropriate response.
4

Testing and Evaluation

Before deploying your configured model, it’s crucial to thoroughly test and evaluate its performance in the Lab.

  • Test Queries: Prepare a set of test queries that cover different scenarios and edge cases. Send these queries to your assistant and evaluate the quality and relevance of the generated responses.

  • Iterative Refinement: Based on the evaluation results, iteratively refine your assistant by adjusting the retrieval settings, fine-tuning the generative model, or improving the document collection.

You can see which documents were used as a verified source at the bottom of the model’s response.
Overview
5

Deployment and Integration

Once you’re satisfied with the performance of your models, you can deploy them with the Launchpad and integrate your application with the Prem SDKs or API.