Sylin.Koan.Data.Connector.OpenSearch 1.0.57

dotnet add package Sylin.Koan.Data.Connector.OpenSearch --version 1.0.57
                    
NuGet\Install-Package Sylin.Koan.Data.Connector.OpenSearch -Version 1.0.57
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Sylin.Koan.Data.Connector.OpenSearch" Version="1.0.57" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sylin.Koan.Data.Connector.OpenSearch" Version="1.0.57" />
                    
Directory.Packages.props
<PackageReference Include="Sylin.Koan.Data.Connector.OpenSearch" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Sylin.Koan.Data.Connector.OpenSearch --version 1.0.57
                    
#r "nuget: Sylin.Koan.Data.Connector.OpenSearch, 1.0.57"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Sylin.Koan.Data.Connector.OpenSearch@1.0.57
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Sylin.Koan.Data.Connector.OpenSearch&version=1.0.57
                    
Install as a Cake Addin
#tool nuget:?package=Sylin.Koan.Data.Connector.OpenSearch&version=1.0.57
                    
Install as a Cake Tool

Sylin.Koan.Data.Connector.OpenSearch

OpenSearch vector storage for Koan Entities. The application declares one vector space; the connector realizes that plan through OpenSearch knn_vector, native kNN search, and native metadata pre-filtering.

  • Target framework: net10.0
  • License: Apache-2.0

Install

dotnet add package Sylin.Koan.Data.Connector.OpenSearch

Use

builder.Services.AddKoan(koan => koan.Data
    .Source("Search")
    .Vector<Article>(space => space
        .Name("content")
        .Dimensions(1536)
        .Metric(VectorMetric.Cosine)
        .Visibility(VectorVisibility.Session)));

await Vector<Article>.Save("article-1", embedding, new { category = "docs" });

var nearest = await Vector<Article>.Search(
    embedding,
    query => query.Top(5).Where(Filter.Eq("category", "docs")));

The space declaration owns its name, dimensions, metric, model, source, and visibility. Standard source declarations own access and storage lifecycle. OpenSearch configuration owns only placement, credentials, timeouts, and bounded work limits.

Configuration

{
  "Koan": {
    "Data": {
      "OpenSearch": {
        "Endpoint": "https://search.example.net:9200",
        "ApiKey": "use-your-secret-provider",
        "TimeoutSeconds": 30,
        "MaxSearchCandidates": 10000
      }
    }
  }
}

HTTP Basic authentication uses Username and Password. ConnectionStrings:OpenSearch remains an endpoint alternative. Standard named-source routing can select a different endpoint and credentials without changing Entity code. Keep credentials in the platform secret store.

Guarantees

  • complete point reads return logical identity, embedding, and neutral metadata;
  • Cosine, Euclidean, and unrestricted DotProduct spaces use explicit native mappings and normalized higher-is-closer scores;
  • awaited mutations use explicit refresh and are visible to subsequent Session reads;
  • Eq, Ne, ranges, In, Nin, Has, HasAny, HasAll, HasNone, Size, and Exists run as native kNN pre-filters; unsupported filters fail closed;
  • single and bulk upsert/delete preserve ordered outcomes; bulk atomicity is reported as not guaranteed;
  • Managed sources may create storage, External sources validate only, and ReadOnly sources reject mutations before I/O;
  • source, partition, container, and row scopes isolate every read and mutation path;
  • requests, responses, metadata, batches, candidates, retries, and tie expansion are bounded.

Deliberate limits

  • This is a Vector adapter, not a general OpenSearch Entity adapter.
  • Search accuracy is approximate because OpenSearch uses indexed approximate kNN.
  • Eventual visibility, hybrid text search, continuation snapshots, streaming export, and atomic batches are not claimed.
  • The adapter generates and validates its write alias and backing index. There is no ordinary index-name, field-name, dimension, metric, refresh, or auto-create option.
  • Existing external mappings must carry the Koan contract marker and match the declared space exactly.

Reference

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.57 124 9/13/2026
1.0.54 104 9/12/2026
1.0.51 98 9/12/2026
1.0.49 104 9/10/2026
1.0.45 113 9/10/2026
1.0.41 107 9/9/2026
1.0.37 106 9/9/2026
1.0.34 114 9/9/2026
1.0.29 95 9/9/2026
1.0.27 119 9/9/2026
1.0.22 113 9/5/2026
1.0.21 121 8/30/2026
1.0.20 106 8/30/2026
1.0.18 108 8/28/2026
1.0.17 108 8/28/2026
1.0.16 107 8/28/2026
1.0.15 96 8/28/2026
1.0.14 107 8/28/2026
1.0.13 113 8/27/2026
1.0.8 124 8/25/2026
Loading failed