Skip to content

Commit

Permalink
.Net: Re-ordered parameters in VectorStoreRecordVectorAttribute (#9260)
Browse files Browse the repository at this point in the history 
### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

There are connectors, where `IndexKind` is not required (e.g. it's not
supported yet or there is only one index kind). This PR contains a
change to add overload to `VectorStoreRecordVectorAttribute` which
doesn't require `IndexKind` parameter and re-order parameters in
existing constructor to keep `IndexKind` parameter as last one.

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄
  • Loading branch information
@dmytrostruk
dmytrostruk authored Oct 15, 2024
1 parent 524d9ab commit afef598
Show file tree
Hide file tree
Showing 14 changed files with 32 additions and 21 deletions.
2 changes: 1 addition & 1 deletion ...rc/Connectors/Connectors.AzureCosmosDBMongoDB.UnitTests/AzureCosmosDBMongoDBHotelModel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ public class AzureCosmosDBMongoDBHotelModel(string hotelId)
public string? Description { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.IvfFlat, DistanceFunction: DistanceFunction.CosineDistance)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineDistance, IndexKind: IndexKind.IvfFlat)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
4 changes: 2 additions & 2 deletions ...rs.AzureCosmosDBMongoDB.UnitTests/AzureCosmosDBMongoDBVectorStoreRecordCollectionTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -828,11 +828,11 @@ private sealed class VectorSearchModel
[VectorStoreRecordData]
public string? HotelName { get; set; }

[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.IvfFlat, DistanceFunction: DistanceFunction.CosineDistance, StoragePropertyName = "test_embedding_1")]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineDistance, IndexKind: IndexKind.IvfFlat, StoragePropertyName = "test_embedding_1")]
public ReadOnlyMemory<float> TestEmbedding1 { get; set; }

[BsonElement("test_embedding_2")]
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.IvfFlat, DistanceFunction: DistanceFunction.CosineDistance)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineDistance, IndexKind: IndexKind.IvfFlat)]
public ReadOnlyMemory<float> TestEmbedding2 { get; set; }
}
#pragma warning restore CA1812
Expand Down
2 changes: 1 addition & 1 deletion dotnet/src/Connectors/Connectors.AzureCosmosDBNoSQL.UnitTests/AzureCosmosDBNoSQLHotel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ public class AzureCosmosDBNoSQLHotel(string hotelId)

/// <summary>A vector field.</summary>
[JsonPropertyName("description_embedding")]
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.Flat, DistanceFunction: DistanceFunction.CosineSimilarity)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineSimilarity, IndexKind: IndexKind.Flat)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
8 changes: 4 additions & 4 deletions ...ectors.AzureCosmosDBNoSQL.UnitTests/AzureCosmosDBNoSQLVectorStoreRecordCollectionTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -701,16 +701,16 @@ private sealed class TestIndexingModel
[VectorStoreRecordKey]
public string? Id { get; set; }

[VectorStoreRecordVector(Dimensions: 1, IndexKind: IndexKind.Flat, DistanceFunction: DistanceFunction.CosineSimilarity)]
[VectorStoreRecordVector(Dimensions: 1, DistanceFunction: DistanceFunction.CosineSimilarity, IndexKind: IndexKind.Flat)]
public ReadOnlyMemory<Half>? DescriptionEmbedding1 { get; set; }

[VectorStoreRecordVector(Dimensions: 2, IndexKind: IndexKind.Flat, DistanceFunction: DistanceFunction.CosineSimilarity)]
[VectorStoreRecordVector(Dimensions: 2, DistanceFunction: DistanceFunction.CosineSimilarity, IndexKind: IndexKind.Flat)]
public ReadOnlyMemory<float>? DescriptionEmbedding2 { get; set; }

[VectorStoreRecordVector(Dimensions: 3, IndexKind: IndexKind.QuantizedFlat, DistanceFunction: DistanceFunction.DotProductSimilarity)]
[VectorStoreRecordVector(Dimensions: 3, DistanceFunction: DistanceFunction.DotProductSimilarity, IndexKind: IndexKind.QuantizedFlat)]
public ReadOnlyMemory<byte>? DescriptionEmbedding3 { get; set; }

[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.DiskAnn, DistanceFunction: DistanceFunction.EuclideanDistance)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.EuclideanDistance, IndexKind: IndexKind.DiskAnn)]
public ReadOnlyMemory<sbyte>? DescriptionEmbedding4 { get; set; }

[VectorStoreRecordData(IsFilterable = true)]
Expand Down
2 changes: 1 addition & 1 deletion dotnet/src/Connectors/Connectors.Weaviate.UnitTests/WeaviateHotel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ public sealed record WeaviateHotel
public DateTimeOffset Timestamp { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.Hnsw, DistanceFunction: DistanceFunction.CosineDistance)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineDistance, IndexKind: IndexKind.Hnsw)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
17 changes: 14 additions & 3 deletions ...c/Connectors/VectorData.Abstractions/RecordAttributes/VectorStoreRecordVectorAttribute.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,24 @@ public VectorStoreRecordVectorAttribute(int Dimensions)
/// Initializes a new instance of the <see cref="VectorStoreRecordVectorAttribute"/> class.
/// </summary>
/// <param name="Dimensions">The number of dimensions that the vector has.</param>
/// <param name="IndexKind">The kind of index to use.</param>
/// <param name="DistanceFunction">The distance function to use when comparing vectors.</param>
public VectorStoreRecordVectorAttribute(int Dimensions, string? IndexKind, string? DistanceFunction)
public VectorStoreRecordVectorAttribute(int Dimensions, string? DistanceFunction)
{
this.Dimensions = Dimensions;
this.DistanceFunction = DistanceFunction;
}

/// <summary>
/// Initializes a new instance of the <see cref="VectorStoreRecordVectorAttribute"/> class.
/// </summary>
/// <param name="Dimensions">The number of dimensions that the vector has.</param>
/// <param name="DistanceFunction">The distance function to use when comparing vectors.</param>
/// <param name="IndexKind">The kind of index to use.</param>
public VectorStoreRecordVectorAttribute(int Dimensions, string? DistanceFunction, string? IndexKind)
{
this.Dimensions = Dimensions;
this.IndexKind = IndexKind;
this.DistanceFunction = DistanceFunction;
this.IndexKind = IndexKind;
}

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion ...ionTests/Connectors/Memory/AzureCosmosDBMongoDB/AzureCosmosDBMongoDBVectorStoreFixture.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ public record AzureCosmosDBMongoDBHotel()
public DateTime Timestamp { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.IvfFlat, DistanceFunction: DistanceFunction.CosineDistance)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineDistance, IndexKind: IndexKind.IvfFlat)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
#pragma warning restore CS8618
Expand Down
2 changes: 1 addition & 1 deletion dotnet/src/IntegrationTests/Connectors/Memory/AzureCosmosDBNoSQL/AzureCosmosDBNoSQLHotel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ public record AzureCosmosDBNoSQLHotel()
public DateTimeOffset Timestamp { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.Flat, DistanceFunction: DistanceFunction.CosineSimilarity)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineSimilarity, IndexKind: IndexKind.Flat)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
2 changes: 1 addition & 1 deletion dotnet/src/IntegrationTests/Connectors/Memory/Pinecone/PineconeAllTypes.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ public record PineconeAllTypes()
[VectorStoreRecordData]
public IEnumerable<string> Enumerable { get; set; }

[VectorStoreRecordVector(Dimensions: 8, IndexKind: null, DistanceFunction: DistanceFunction.DotProductSimilarity)]
[VectorStoreRecordVector(Dimensions: 8, DistanceFunction: DistanceFunction.DotProductSimilarity)]
public ReadOnlyMemory<float>? Embedding { get; set; }
}
2 changes: 1 addition & 1 deletion dotnet/src/IntegrationTests/Connectors/Memory/Pinecone/PineconeHotel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ public record PineconeHotel()
[VectorStoreRecordData]
public string Description { get; set; }

[VectorStoreRecordVector(Dimensions: 8, IndexKind: null, DistanceFunction: DistanceFunction.DotProductSimilarity)]
[VectorStoreRecordVector(Dimensions: 8, DistanceFunction: DistanceFunction.DotProductSimilarity)]
public ReadOnlyMemory<float> DescriptionEmbedding { get; set; }
}
2 changes: 1 addition & 1 deletion ...c/IntegrationTests/Connectors/Memory/Pinecone/PineconeVectorStoreRecordCollectionTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ private sealed record PineconeRecordWithUnsupportedMetric
[VectorStoreRecordData]
public string? Name { get; set; }

[VectorStoreRecordVector(Dimensions: 5, IndexKind: null, DistanceFunction: "just eyeball it")]
[VectorStoreRecordVector(Dimensions: 5, DistanceFunction: "just eyeball it")]
public ReadOnlyMemory<float> Embedding { get; set; }
}
#pragma warning restore CA1812
Expand Down
4 changes: 2 additions & 2 deletions dotnet/src/IntegrationTests/Connectors/Memory/Qdrant/QdrantVectorStoreFixture.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ public record HotelInfo()
public string Description { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(VectorDimensions, IndexKind.Hnsw, DistanceFunction.ManhattanDistance)]
[VectorStoreRecordVector(VectorDimensions, DistanceFunction.ManhattanDistance, IndexKind.Hnsw)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}

Expand All @@ -358,7 +358,7 @@ public record HotelInfoWithGuidId()
public string Description { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(VectorDimensions, IndexKind.Hnsw, DistanceFunction.ManhattanDistance)]
[VectorStoreRecordVector(VectorDimensions, DistanceFunction.ManhattanDistance, IndexKind.Hnsw)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
}
Expand Down
2 changes: 1 addition & 1 deletion dotnet/src/IntegrationTests/Connectors/Memory/Weaviate/WeaviateHotel.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ public sealed record WeaviateHotel
public DateTimeOffset Timestamp { get; set; }

/// <summary>A vector field.</summary>
[VectorStoreRecordVector(Dimensions: 4, IndexKind: IndexKind.Hnsw, DistanceFunction: DistanceFunction.CosineDistance)]
[VectorStoreRecordVector(Dimensions: 4, DistanceFunction: DistanceFunction.CosineDistance, IndexKind: IndexKind.Hnsw)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}
2 changes: 1 addition & 1 deletion dotnet/src/SemanticKernel.UnitTests/Data/VectorStoreRecordPropertyReaderTests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ private sealed class MultiPropsModel
[JsonPropertyName("json_data2")]
public string Data2 { get; set; } = string.Empty;

[VectorStoreRecordVector(4, IndexKind.Flat, DistanceFunction.DotProductSimilarity)]
[VectorStoreRecordVector(4, DistanceFunction.DotProductSimilarity, IndexKind.Flat)]
public ReadOnlyMemory<float> Vector1 { get; set; }

[VectorStoreRecordVector(StoragePropertyName = "storage_vector2")]
Expand Down

0 comments on commit afef598

Please sign in to comment.