Added support for sparsevec type to EF Core

src/Pgvector.EntityFrameworkCore/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## 0.2.1 (unreleased)
 
-- Added support for `halfvec` type
+- Added support for `halfvec` and `sparsevec` types
 - Added support for compiled models
 - Added `L1Distance` function
 

src/Pgvector.EntityFrameworkCore/SparsevecTypeMapping.cs

@@ -0,0 +1,19 @@
+using Microsoft.EntityFrameworkCore.Storage;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Storage.Internal.Mapping;
+using NpgsqlTypes;
+
+namespace Pgvector.EntityFrameworkCore;
+
+public class SparsevecTypeMapping : RelationalTypeMapping
+{
+    public static SparsevecTypeMapping Default { get; } = new();
+
+    public SparsevecTypeMapping() : base("sparsevec", typeof(SparseVector)) { }
+
+    public SparsevecTypeMapping(string storeType) : base(storeType, typeof(SparseVector)) { }
+
+    protected SparsevecTypeMapping(RelationalTypeMappingParameters parameters) : base(parameters) { }
+
+    protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters)
+        => new SparsevecTypeMapping(parameters);
+}

src/Pgvector.EntityFrameworkCore/SparsevecTypeMappingSourcePlugin.cs

@@ -0,0 +1,11 @@
+using Microsoft.EntityFrameworkCore.Storage;
+
+namespace Pgvector.EntityFrameworkCore;
+
+public class SparsevecTypeMappingSourcePlugin : IRelationalTypeMappingSourcePlugin
+{
+    public RelationalTypeMapping? FindMapping(in RelationalTypeMappingInfo mappingInfo)
+        => mappingInfo.ClrType == typeof(SparseVector)
+            ? new SparsevecTypeMapping(mappingInfo.StoreTypeName ?? "sparsevec")
+            : null;
+}

src/Pgvector.EntityFrameworkCore/VectorDbContextOptionsExtension.cs

@@ -18,6 +18,7 @@ public void ApplyServices(IServiceCollection services)
 
         services.AddSingleton<IRelationalTypeMappingSourcePlugin, VectorTypeMappingSourcePlugin>();
         services.AddSingleton<IRelationalTypeMappingSourcePlugin, HalfvecTypeMappingSourcePlugin>();
+        services.AddSingleton<IRelationalTypeMappingSourcePlugin, SparsevecTypeMappingSourcePlugin>();
     }
 
     public void Validate(IDbContextOptions options) { }

tests/Pgvector.CSharp.Tests/EntityFrameworkCoreTests.cs

@@ -39,6 +39,9 @@ public class Item
 
     [Column("half_embedding", TypeName = "halfvec(3)")]
     public HalfVector? HalfEmbedding { get; set; }
+
+    [Column("sparse_embedding", TypeName = "sparsevec(3)")]
+    public SparseVector? SparseEmbedding { get; set; }
 }
 
 public class EntityFrameworkCoreTests
@@ -52,9 +55,9 @@ public async Task Main()
         var databaseCreator = ctx.GetService<IRelationalDatabaseCreator>();
         databaseCreator.CreateTables();
 
-        ctx.Items.Add(new Item { Embedding = new Vector(new float[] { 1, 1, 1 }), HalfEmbedding = new HalfVector(new Half[] { (Half)1, (Half)1, (Half)1 }) });
-        ctx.Items.Add(new Item { Embedding = new Vector(new float[] { 2, 2, 2 }), HalfEmbedding = new HalfVector(new Half[] { (Half)2, (Half)2, (Half)2 }) });
-        ctx.Items.Add(new Item { Embedding = new Vector(new float[] { 1, 1, 2 }), HalfEmbedding = new HalfVector(new Half[] { (Half)1, (Half)1, (Half)2 }) });
+        ctx.Items.Add(new Item { Embedding = new Vector(new float[] { 1, 1, 1 }), HalfEmbedding = new HalfVector(new Half[] { (Half)1, (Half)1, (Half)1 }), SparseEmbedding = new SparseVector(new float[] { 1, 1, 1 }) });
+        ctx.Items.Add(new Item { Embedding = new Vector(new float[] { 2, 2, 2 }), HalfEmbedding = new HalfVector(new Half[] { (Half)2, (Half)2, (Half)2 }), SparseEmbedding = new SparseVector(new float[] { 2, 2, 2 }) });
+        ctx.Items.Add(new Item { Embedding = new Vector(new float[] { 1, 1, 2 }), HalfEmbedding = new HalfVector(new Half[] { (Half)1, (Half)1, (Half)2 }), SparseEmbedding = new SparseVector(new float[] { 1, 1, 2 }) });
         ctx.SaveChanges();
 
         var embedding = new Vector(new float[] { 1, 1, 1 });
@@ -80,6 +83,10 @@ public async Task Main()
         items = await ctx.Items.OrderBy(x => x.HalfEmbedding!.L2Distance(halfEmbedding)).Take(5).ToListAsync();
         Assert.Equal(new int[] { 1, 3, 2 }, items.Select(v => v.Id).ToArray());
 
+        var sparseEmbedding = new SparseVector(new float[] { 1, 1, 1 });
+        items = await ctx.Items.OrderBy(x => x.SparseEmbedding!.L2Distance(sparseEmbedding)).Take(5).ToListAsync();
+        Assert.Equal(new int[] { 1, 3, 2 }, items.Select(v => v.Id).ToArray());
+
         items = await ctx.Items
             .OrderBy(x => x.Id)
             .Where(x => x.Embedding!.L2Distance(embedding) < 1.5)