https://github.com/qdrant/qdrant-dotnet

Qdrant .Net SDK
https://github.com/qdrant/qdrant-dotnet

Last synced: 29 days ago
JSON representation

Qdrant .Net SDK

• Host: GitHub
• URL: https://github.com/qdrant/qdrant-dotnet
• Owner: qdrant
• License: apache-2.0
• Created: 2023-07-12T08:59:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-22T13:20:49.000Z (9 months ago)
• Last Synced: 2024-05-01T09:43:55.071Z (8 months ago)
• Language: C#
• Size: 154 KB
• Stars: 66
• Watchers: 6
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• dotnet-ai-resources - Qdrant .NET SDK - SDK for working with the Qdrant vector DB. (Vector Store SDKs / Teams)

README

        
# Qdrant .NET SDK

[![NuGet Release][Qdrant-image]][Qdrant-nuget-url]

[![Build](https://github.com/qdrant/qdrant-dotnet/actions/workflows/test.yml/badge.svg)](https://github.com/qdrant/qdrant-dotnet/actions/workflows/test.yml)

## 📥 Installation

```sh

dotnet add package Qdrant.Client

```

## 📖 Documentation

Usage examples are available throughout the [Qdrant documentation](https://qdrant.tech/documentation/quick-start/).

## 🔌 Getting started

### Creating a client

A client can be instantiated with

```csharp

var client = new QdrantClient("localhost");

```

which creates a client that will connect to Qdrant on `http://localhost:6334`.

Internally, the high level client uses a low level gRPC client to interact with Qdrant.

Additional constructor overloads provide more control over how the gRPC client is

configured. The following example configures a client to use TLS, validating the 

certificate using its thumbprint, and also configures API key authentication:

```csharp

var channel = QdrantChannel.ForAddress("https://localhost:6334", new ClientConfiguration

{

    ApiKey = "",

    CertificateThumbprint = ""

});

var grpcClient = new QdrantGrpcClient(channel);

var client = new QdrantClient(grpcClient);

```

> [!IMPORTANT]

> **IMPORTANT NOTICE for .NET Framework**

>

> .NET Framework has limited supported for gRPC over HTTP/2, but it can be enabled by

> 

> - Configuring qdrant to use TLS, and you **must** use HTTPS, so you will need to set up 

> server certificate validation

> - Referencing `System.Net.Http.WinHttpHandler` 6.0.1 or later, and configuring 

> `WinHttpHandler` as the inner handler for `GrpcChannelOptions`

>

> The following example configures a client for .NET Framework to use TLS, validating 

> the certificate using its thumbprint, and also configures API key authentication:

>

> ```csharp

> var channel = GrpcChannel.ForAddress($"https://localhost:6334", new GrpcChannelOptions

> {

>   HttpHandler = new WinHttpHandler

>   {

>     ServerCertificateValidationCallback =

>       CertificateValidation.Thumbprint("")

>   }

> });

> var callInvoker = channel.Intercept(metadata =>

> {

>   metadata.Add("api-key", "");

>   return metadata;

> });

>

> var grpcClient = new QdrantGrpcClient(callInvoker);

> var client = new QdrantClient(grpcClient);

> ```

### Working with collections

Once a client has been created, create a new collection

```csharp

await client.CreateCollectionAsync("my_collection", 

    new VectorParams { Size = 100, Distance = Distance.Cosine });

```

Insert vectors into a collection

```csharp

// generate some vectors

var random = new Random();

var points = Enumerable.Range(1, 100).Select(i => new PointStruct

{

  Id = (ulong)i,

  Vectors = Enumerable.Range(1, 100).Select(_ => (float)random.NextDouble()).ToArray(),

  Payload = 

  { 

    ["color"] = "red", 

    ["rand_number"] = i % 10 

  }

}).ToList();

var updateResult = await client.UpsertAsync("my_collection", points);

```

Search for similar vectors

```csharp

var queryVector = Enumerable.Range(1, 100).Select(_ => (float)random.NextDouble()).ToArray();

// return the 5 closest points

var points = await client.SearchAsync(

  "my_collection",

  queryVector,

  limit: 5);

```

Search for similar vectors with filtering condition

```csharp

// static import Conditions to easily build filtering

using static Qdrant.Client.Grpc.Conditions;

// return the 5 closest points where rand_number >= 3

var points = await _client.SearchAsync(

  "my_collection",

  queryVector,

  filter: Range("rand_number", new Range { Gte = 3 }),

  limit: 5);

```

[Qdrant-nuget-url]:https://www.nuget.org/packages/Qdrant.Client/

[Qdrant-image]:

https://img.shields.io/nuget/v/Qdrant.Client.svg