Encamina.Enmarcha.Data.Qdrant 8.1.5-preview-07

Data - Qdrant

The Data Qdrant project contains functionalities related to the Qdrant vector database.

Setup

Nuget package

First, install NuGet. Then, install Encamina.Enmarcha.Data.Qdrant from the package manager console:

PM> Install-Package Encamina.Enmarcha.Data.Qdrant

.NET CLI:

First, install .NET CLI. Then, install Encamina.Enmarcha.Data.Qdrant from the .NET CLI:

dotnet add package Encamina.Enmarcha.Data.Qdrant

How to use

QdrantSnapshotHandler

Qdrant vector database supports creating snapshots, which consist in a .snapshot archive file containing the necessary data to restore the collection at the time of the snapshot. This handler allows you to take snapshots of Qdrant. First, you need to add the QdrantOptions to your project configuration. You can achieve this by using any configuration provider. The followng code is an example of how the settings would appear using the appsettings.json file:

// ...
  "QdrantOptions": {
    "Host": "https://sample-qdrant.azurewebsites.net/", // Endpoint protocol and host
    "Port": 6333, // Endpoint port
    "VectorSize": 1536, // Vector size
    "ApiKey": "xxxxxxxxxx" // API Key used by Qdrant as a form of client authentication.
  },
// ...

Starting from a Program.cs or a similar entry point file in your project, add the following code:

// Entry point
var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
    // ...
});

// ... 

// Or others configuration providers...
builder.Configuration.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true); 

builder.Services.AddOptions<QdrantOptions>().Bind(builder.Configuration.GetSection(nameof(QdrantOptions)))
    .ValidateDataAnnotations()
    .ValidateOnStart();

services.AddQdrantSnapshotHandler();

This extension method will add the implementation of the IQdrantSnapshotHandler interface as a singleton, in addition to configuring an HttpClient with QdrantOptions so that the handler can use the Qdrant REST API. The implementation is QdrantSnapshotHandler. With this, it can resolve the IQdrantSnapshotHandler interface and take snapshots:

public class MyClass
{
    private readonly IQdrantSnapshotHandler qdrantSnapshotHandler;

    public MyClass(IQdrantSnapshotHandler qdrantSnapshotHandler)
    {
        this.qdrantSnapshotHandler = qdrantSnapshotHandler;
    }

    public async Task TestQdrantSnapshotAsync()
    {
        await qdrantSnapshotHandler.CreateCollectionSnapshotAsync("my-collection-1", CancellationToken.None);
    }
}

The previous code creates a snapshot of the 'my-collection-1' collection.