Learn more about our services and expertise: https://searchpioneer.com/

Weaviate .NET client

A Microsoft .NET native client for Weaviate

Build status

Packages

The .NET assembly is published to NuGet under the package name SearchPioneer.Weaviate.Client

Getting started

Installing

You can install SearchPioneer.Weaviate.Client from the package manager console:

PM> Install-Package SearchPioneer.Weaviate.Client

Alternatively, simply search for SearchPioneer.Weaviate.Client in the package manager UI.

Usage

using SearchPioneer.Weaviate.Client;
using Flurl.Http;

public class Main
{
    public void Main()
    {
        var flurlClient = new FlurlClient();
        var weaviateClient = new WeaviateClient(new Config("http", "localhost:8080"), flurlClient);
        var meta = weaviateClient.Misc.Meta();
        Console.WriteLine(meta.Error != null ? meta.Error.Message : meta.Result.Version);
    }
}

For a better understanding of usage, please refer to the API Integration Tests

Versioning

The version of the SearchPioneer.Weaviate.Client should match the published Weaviate server version.

For example, if you are using Weaviate server version 1.18 you should use version 1.18 of this package.

Patch versions are compatible within the minor version, for example;

SearchPioneer.Weaviate.Client version 1.18.4 can communicate with Weaviate server version 1.18.

A verification check takes place on creation of the client to ensure that the client and server versions match.