SimpleRag 0.0.1-preview8

SimpleRag

A Simple and Opinionated AI RAG Solutions for SourceCode, where you just need to setup and point to your source and we take care of the rest.

Getting Started

Step 1: Install SimpleRag Nuget + your Embedding Generator (in this sample Azure OpenAI via Semantic Kernel and SQL Server 2025 as VectorStore)

dotnet add package SimpleRag
dotnet add package Microsoft.SemanticKernel
dotnet add package Microsoft.SemanticKernel.Connectors.SqlServer

Step 2: Setup Dependency Injection of Embedding Generator and SimpleRag

string endpoint = builder.Configuration["AiEndpoint"]!;
string key = builder.Configuration["AiKey"]!;
string embeddingDeploymentName = builder.Configuration["AiEmbeddingDeploymentName"]!;
string sqlServerConnectionString = builder.Configuration["SqlServerConnectionString"]!;
string githubToken = builder.Configuration["GitHubToken"]!;

//Setup Embedding Generator
builder.Services.AddAzureOpenAIEmbeddingGenerator(embeddingDeploymentName, endpoint, key);

//Setup SimpleRag (use .AddSimpleRag(...) instead if you do not wish to use GitHub as Datasource)
builder.Services.AddSimpleRagWithGitHubIntegration(new VectorStoreConfiguration(Constants.VectorStoreName, Constants.MaxRecords), options => new SqlServerVectorStore(sqlServerConnectionString, new SqlServerVectorStoreOptions
{
    EmbeddingGenerator = options.GetRequiredService<IEmbeddingGenerator<string, Embedding<float>>>()
}), githubToken);

Step 3: Ingest Data into your VectorStore (in this sample the TrelloDotNet open-source repo)

public class IngestionExample(Ingestion ingestion)
{
    public async Task Sync()
    {
        string gitHubOwner = "rwjdk";
        string gitHubRepo = "TrelloDotNet";

        await ingestion.IngestAsync(
        [
            new CSharpDataSourceGitHub
            {
                CollectionId = Constants.CollectionId,
                Id = Constants.SourceIdCode,
                Recursive = true,
                Path = "src",
                FileIgnorePatterns = "TrelloDotNet.Tests",
                GitHubOwner = gitHubOwner,
                GitHubRepo = gitHubRepo,
            },
            new MarkdownDataSourceGitHub
            {
                CollectionId = Constants.CollectionId,
                Id = Constants.SourceIdMarkdownInCode,
                Recursive = true,
                Path = "/",
                GitHubOwner = gitHubOwner,
                GitHubRepo = gitHubRepo,
                LevelsToChunk = 3,
            }
        ], onProgressNotification: NotifyProgress);
    }

    private void NotifyProgress(ProgressNotification obj)
    {
        Console.WriteLine(obj.GetFormattedMessageWithDetails());
    }
}

Step 4: Search your VectorStore

public class SearchExample(Search search)
{
    public async Task<string> SearchAsync(string question)
    {
        SearchResult searchResult = await search.SearchAsync(new SearchOptions
        {
            SearchQuery = searchQuery,
            NumberOfRecordsBack = 10,
            Filter = entity => entity.SourceCollectionId == Constants.CollectionId
        });
        return searchResult.GetAsStringResult();
    }
}