diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionJsonModelBuilder.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionJsonModelBuilder.cs index e5364d89d242..bab81647514c 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionJsonModelBuilder.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionJsonModelBuilder.cs @@ -10,8 +10,8 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// -/// A model builder that performs logic specific to connectors which use System.Text.Json for serialization. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// Represents a model builder that performs logic specific to connectors that use System.Text.Json for serialization. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public abstract class CollectionJsonModelBuilder : CollectionModelBuilder @@ -27,7 +27,7 @@ protected CollectionJsonModelBuilder(CollectionModelBuildingOptions options) } /// - /// Builds and returns an from the given and . + /// Builds and returns a from the given and . /// [RequiresDynamicCode("This model building variant is not compatible with NativeAOT. See BuildDynamic() for dynamic mapping, and a third variant accepting source-generated delegates will be introduced in the future.")] [RequiresUnreferencedCode("This model building variant is not compatible with trimming. See BuildDynamic() for dynamic mapping, and a third variant accepting source-generated delegates will be introduced in the future.")] @@ -43,7 +43,7 @@ public virtual CollectionModel Build( } /// - /// Builds and returns an for dynamic mapping scenarios from the given . + /// Builds and returns a for dynamic mapping scenarios from the given . /// public virtual CollectionModel BuildDynamic( VectorStoreCollectionDefinition definition, diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModel.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModel.cs index 8cbcbe526f3c..544648621050 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModel.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModel.cs @@ -12,8 +12,8 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// -/// A model representing a record in a vector store collection. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// Represents a record in a vector store collection. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public sealed class CollectionModel @@ -26,32 +26,32 @@ public sealed class CollectionModel private DataPropertyModel? _singleFullTextSearchProperty; /// - /// The key properties of the record. + /// Gets the key properties of the record. /// public IReadOnlyList KeyProperties { get; } /// - /// The data properties of the record. + /// Gets the data properties of the record. /// public IReadOnlyList DataProperties { get; } /// - /// The vector properties of the record. + /// Gets the vector properties of the record. /// public IReadOnlyList VectorProperties { get; } /// - /// All properties of the record, of all types. + /// Gets all properties of the record, of all types. /// public IReadOnlyList Properties { get; } /// - /// All properties of the record, of all types, indexed by their model name. + /// Gets all properties of the record, of all types, indexed by their model name. /// public IReadOnlyDictionary PropertyMap { get; } /// - /// Whether any of the vector properties in the model require embedding generation. + /// Gets a value that indicates whether any of the vector properties in the model require embedding generation. /// public bool EmbeddingGenerationRequired { get; } @@ -102,12 +102,11 @@ public TRecord CreateRecord() } /// - /// Get the vector property with the provided name if a name is provided, and fall back - /// to a vector property in the schema if not. If no name is provided and there is more - /// than one vector property, an exception will be thrown. + /// Gets the vector property with the provided name if a name is provided, and falls back + /// to a vector property in the schema if not. /// - /// The search options. - /// Thrown if the provided property name is not a valid vector property name. + /// The search options, which defines the vector property name. + /// The provided property name is not a valid text data property name.ORNo name was provided and there's more than one vector property. public VectorPropertyModel GetVectorPropertyOrSingle(VectorSearchOptions searchOptions) { if (searchOptions.VectorProperty is not null) @@ -137,12 +136,11 @@ public VectorPropertyModel GetVectorPropertyOrSingle(VectorSearchOption } /// - /// Get the text data property, that has full text search indexing enabled, with the provided name if a name is provided, and fall back - /// to a text data property in the schema if not. If no name is provided and there is more than one text data property with - /// full text search indexing enabled, an exception will be thrown. + /// Gets the text data property with the provided name that has full text search indexing enabled, or falls back + /// to a text data property in the schema if no name is provided. /// /// The full text search property selector. - /// Thrown if the provided property name is not a valid text data property name. + /// The provided property name is not a valid text data property name.ORNo name was provided and there's more than one text data property with full text search indexing enabled. public DataPropertyModel GetFullTextDataPropertyOrSingle(Expression>? expression) { if (expression is not null) @@ -183,10 +181,10 @@ public DataPropertyModel GetFullTextDataPropertyOrSingle(Expression - /// Get the data or key property selected by provided expression. + /// Gets the data or key property selected by the provided expression. /// /// The property selector. - /// Thrown if the provided property name is not a valid data or key property name. + /// The provided property name is not a valid data or key property name. public PropertyModel GetDataOrKeyProperty(Expression> expression) => this.GetMatchingProperty(expression, data: true); diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuilder.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuilder.cs index f60f6ff2d647..f54ff49dad98 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuilder.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuilder.cs @@ -12,44 +12,44 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// /// Represents a builder for a . -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// -/// Note that this class is single-use only, and not thread-safe. +/// This class is single-use only, and not thread-safe. [Experimental("MEVD9001")] public abstract class CollectionModelBuilder { /// - /// Options for building the model. + /// Gets the options for building the model. /// protected CollectionModelBuildingOptions Options { get; } /// - /// The key properties of the record. + /// Gets the key properties of the record. /// protected List KeyProperties { get; } = []; /// - /// The data properties of the record. + /// Gets the data properties of the record. /// protected List DataProperties { get; } = []; /// - /// The vector properties of the record. + /// Gets the vector properties of the record. /// protected List VectorProperties { get; } = []; /// - /// All properties of the record, of all types. + /// Gets all properties of the record, of all types. /// protected IEnumerable Properties => this.PropertyMap.Values; /// - /// All properties of the record, of all types, indexed by their model name. + /// Gets all properties of the record, of all types, indexed by their model name. /// protected Dictionary PropertyMap { get; } = new(); /// - /// The default embedding generator to use for vector properties, when none is specified at the property or collection level. + /// Gets the default embedding generator to use for vector properties, when none is specified at the property or collection level. /// protected IEmbeddingGenerator? DefaultEmbeddingGenerator { get; private set; } @@ -245,7 +245,7 @@ protected virtual void ProcessTypeProperties(Type type, VectorStoreCollectionDef } /// - /// As part of building the model, this method processes the given . + /// Processes the given as part of building the model. /// protected virtual void ProcessRecordDefinition(VectorStoreCollectionDefinition definition, Type? type) { diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuildingOptions.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuildingOptions.cs index 518849528283..3fe17a327b70 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuildingOptions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/CollectionModelBuildingOptions.cs @@ -6,34 +6,34 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// /// Contains options affecting model building; passed to . -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public sealed class CollectionModelBuildingOptions { /// - /// Whether multiple key properties are supported. + /// Gets a value that indicates whether multiple key properties are supported. /// public required bool SupportsMultipleKeys { get; init; } /// - /// Whether multiple vector properties are supported. + /// Gets a value that indicates whether multiple vector properties are supported. /// public required bool SupportsMultipleVectors { get; init; } /// - /// Whether at least one vector property is required. + /// Gets a value that indicates whether at least one vector property is required. /// public required bool RequiresAtLeastOneVector { get; init; } /// - /// Indicates that an external serializer will be used (e.g. System.Text.Json). + /// Gets a value that indicates whether an external serializer will be used (for example, System.Text.Json). /// public bool UsesExternalSerializer { get; init; } /// - /// Indicates that the database requires the key property to have a special, reserved name. - /// When set, the model builder will manage the key storage name, and users may not customize it. + /// Gets the special, reserved name for the key property of the database. + /// When set, the model builder manages the key storage name, and users cannot customize it. /// public string? ReservedKeyStorageName { get; init; } } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/DataPropertyModel.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/DataPropertyModel.cs index 16bc08988b3c..b2d800245054 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/DataPropertyModel.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/DataPropertyModel.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// /// Represents a data property on a vector store record. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public class DataPropertyModel(string modelName, Type type) : PropertyModel(modelName, type) diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/Filter/FilterTranslationPreprocessor.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/Filter/FilterTranslationPreprocessor.cs index 6945c8de2887..2978e654c31f 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/Filter/FilterTranslationPreprocessor.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/Filter/FilterTranslationPreprocessor.cs @@ -10,7 +10,7 @@ namespace Microsoft.Extensions.VectorData.ProviderServices.Filter; /// /// A processor for user-provided filter expressions which performs various common transformations before actual translation takes place. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public class FilterTranslationPreprocessor : ExpressionVisitor diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/KeyPropertyModel.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/KeyPropertyModel.cs index 24b16165b8ea..341439020ce9 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/KeyPropertyModel.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/KeyPropertyModel.cs @@ -7,7 +7,7 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// /// Represents a key property on a vector store record. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public class KeyPropertyModel(string modelName, Type type) : PropertyModel(modelName, type) diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/PropertyModel.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/PropertyModel.cs index 5e7a45326230..d46b86c32878 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/PropertyModel.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/PropertyModel.cs @@ -10,7 +10,7 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// /// Represents a property on a vector store record. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public abstract class PropertyModel(string modelName, Type type) @@ -18,12 +18,12 @@ public abstract class PropertyModel(string modelName, Type type) private string? _storageName; /// - /// The model name of the property. If the property corresponds to a .NET property, this name is the name of that property. + /// Gets or sets the model name of the property. If the property corresponds to a .NET property, this name is the name of that property. /// public string ModelName { get; set; } = modelName; /// - /// The storage name of the property. This is the name to which the property is mapped in the vector store. + /// Gets or sets the storage name of the property. This is the name to which the property is mapped in the vector store. /// public string StorageName { @@ -35,20 +35,23 @@ public string StorageName // TODO: Spend more time thinking about this, there may be a less hacky way to handle it. /// - /// A temporary storage name for the property, for use during the serialization process by certain connectors. + /// Gets or sets the temporary storage name for the property, for use during the serialization process by certain connectors. /// [Experimental("MEVD9001")] public string? TemporaryStorageName { get; set; } /// - /// The CLR type of the property. + /// Gets or sets the CLR type of the property. /// public Type Type { get; set; } = type; /// + /// Gets or sets the reflection for the .NET property. + /// + /// /// The reflection for the .NET property. /// when using dynamic mapping. - /// + /// public PropertyInfo? PropertyInfo { get; set; } /// diff --git a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/VectorPropertyModel.cs b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/VectorPropertyModel.cs index adc47352e87a..8729d633cdd7 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/VectorPropertyModel.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/ProviderServices/VectorPropertyModel.cs @@ -13,7 +13,7 @@ namespace Microsoft.Extensions.VectorData.ProviderServices; /// /// Represents a vector property on a vector store record. -/// This is an internal support type meant for use by connectors only, and not for use by applications. +/// This is an internal support type meant for use by connectors only and not by applications. /// [Experimental("MEVD9001")] public class VectorPropertyModel(string modelName, Type type) : PropertyModel(modelName, type) @@ -21,7 +21,7 @@ public class VectorPropertyModel(string modelName, Type type) : PropertyModel(mo private int _dimensions; /// - /// The number of dimensions that the vector has. + /// Gets or sets the number of dimensions that the vector has. /// /// /// This property is required when creating collections, but can be omitted if not using that functionality. @@ -43,25 +43,25 @@ public int Dimensions } /// - /// The kind of index to use. + /// Gets or sets the kind of index to use. /// /// - /// The default varies by database type. See the documentation of your chosen database connector for more information. + /// The default varies by database type. For more information, see the documentation of your chosen database connector. /// /// public string? IndexKind { get; set; } /// - /// The distance function to use when comparing vectors. + /// Gets or sets the distance function to use when comparing vectors. /// /// - /// The default varies by database type. See the documentation of your chosen database connector for more information. + /// The default varies by database type. For more information, see the documentation of your chosen database connector. /// /// public string? DistanceFunction { get; set; } /// - /// If is set, contains the type representing the embedding stored in the database. + /// Gets or sets the type representing the embedding stored in the database if is set. /// Otherwise, this property is identical to . /// // TODO: sort out the nullability story here: EmbeddingType must be non-null after model building is complete, but can be null during @@ -70,7 +70,7 @@ public int Dimensions public Type EmbeddingType { get; set; } = null!; /// - /// The embedding generator to use for this property. + /// Gets or sets the embedding generator to use for this property. /// public IEmbeddingGenerator? EmbeddingGenerator { get; set; } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordAttributes/VectorStoreVectorAttribute.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordAttributes/VectorStoreVectorAttribute.cs index d84d5e133d55..4f898116c69f 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordAttributes/VectorStoreVectorAttribute.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordAttributes/VectorStoreVectorAttribute.cs @@ -37,7 +37,7 @@ public VectorStoreVectorAttribute(int Dimensions) public int Dimensions { get; private set; } /// - /// Gets the kind of index to use. + /// Gets or sets the kind of index to use. /// /// /// The default value varies by database type. See the documentation of your chosen database connector for more information. @@ -48,7 +48,7 @@ public VectorStoreVectorAttribute(int Dimensions) #pragma warning restore CA1019 /// - /// Gets the distance function to use when comparing vectors. + /// Gets or sets the distance function to use when comparing vectors. /// /// /// The default value varies by database type. See the documentation of your chosen database connector for more information. diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/DistanceFunction.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/DistanceFunction.cs index bba2b47b3498..068caed55807 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/DistanceFunction.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/DistanceFunction.cs @@ -7,16 +7,16 @@ namespace Microsoft.Extensions.VectorData; /// /// /// Not all Vector Store connectors support all distance functions, and some connectors might -/// support additional distance functions that aren't defined here. See the documentation -/// for each connector for more information on what is supported. +/// support additional distance functions that aren't defined here. +/// For more information on what's supported, see the documentation for each connector. /// public static class DistanceFunction { /// - /// The cosine (angular) similarity between two vectors. + /// Specifies the function that measures the cosine (angular) similarity between two vectors. /// /// - /// Measures only the angle between the two vectors, without taking into account the length of the vectors. + /// Cosine similarity measures only the angle between the two vectors, without taking into account the length of the vectors. /// ConsineSimilarity = 1 - CosineDistance. /// -1 means vectors are opposite. /// 0 means vectors are orthogonal. @@ -25,7 +25,7 @@ public static class DistanceFunction public const string CosineSimilarity = nameof(CosineSimilarity); /// - /// The cosine (angular) similarity between two vectors. + /// Specifies the function that measures the cosine (angular) distance between two vectors. /// /// /// CosineDistance = 1 - CosineSimilarity. @@ -36,7 +36,7 @@ public static class DistanceFunction public const string CosineDistance = nameof(CosineDistance); /// - /// Measures both the length and angle between two vectors. + /// Specifies the dot product similarity function, which measures both the length and angle between two vectors. /// /// /// The higher the value, the more similar the vectors. @@ -44,7 +44,7 @@ public static class DistanceFunction public const string DotProductSimilarity = nameof(DotProductSimilarity); /// - /// Measures both the length and angle between two vectors. + /// Specifies the negative dot product similarity function, which measures both the length and angle between two vectors. /// /// /// The value of NegativeDotProduct = -1 * DotProductSimilarity. @@ -53,7 +53,7 @@ public static class DistanceFunction public const string NegativeDotProductSimilarity = nameof(NegativeDotProductSimilarity); /// - /// Measures the Euclidean distance between two vectors. + /// Specifies the function that measures the Euclidean distance between two vectors. /// /// /// Also known as l2-norm. @@ -61,7 +61,7 @@ public static class DistanceFunction public const string EuclideanDistance = nameof(EuclideanDistance); /// - /// Measures the Euclidean squared distance between two vectors. + /// Specifies the function that measures the Euclidean squared distance between two vectors. /// /// /// Also known as l2-squared. @@ -69,12 +69,12 @@ public static class DistanceFunction public const string EuclideanSquaredDistance = nameof(EuclideanSquaredDistance); /// - /// The number of differences between vectors at each dimensions. + /// Specifies the function that measures the number of differences between vectors at each dimension. /// public const string HammingDistance = nameof(HammingDistance); /// - /// Measures the Manhattan distance between two vectors. + /// Specifies the function that measures the Manhattan distance between two vectors. /// public const string ManhattanDistance = nameof(ManhattanDistance); } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/IndexKind.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/IndexKind.cs index 088b31c87262..372f451e4c05 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/IndexKind.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/IndexKind.cs @@ -7,13 +7,13 @@ namespace Microsoft.Extensions.VectorData; /// /// /// Not all Vector Store connectors support all index types, and some connectors might -/// support additional index types that aren't defined here. See the documentation -/// for each connector for more information on what is supported. +/// support additional index types that aren't defined here. For more information on what's +/// supported, see the documentation for each connector. /// public static class IndexKind { /// - /// Hierarchical Navigable Small World, which performs an approximate nearest neighbour (ANN) search. + /// Specifies the Hierarchical Navigable Small World, which performs an approximate nearest neighbor (ANN) search. /// /// /// This search has lower accuracy than exhaustive k nearest neighbor, but is faster and more efficient. @@ -21,18 +21,18 @@ public static class IndexKind public const string Hnsw = nameof(Hnsw); /// - /// Brute force search to find the nearest neighbors. + /// Specifies the brute force search to find the nearest neighbors. /// /// /// This search calculates the distances between all pairs of data points, so it has a linear time complexity that grows directly proportional to the number of points. - /// It's also referred to as exhaustive k nearest neighbor in some databases. + /// It's also referred to as "exhaustive k nearest neighbor" in some databases. /// This search has high recall accuracy, but is slower and more expensive than HNSW. /// It works better with smaller datasets. /// public const string Flat = nameof(Flat); /// - /// Inverted File with Flat Compression. + /// Specifies an Inverted File with Flat Compression. /// /// /// This search is designed to enhance search efficiency by narrowing the search area through the use of neighbor partitions or clusters. @@ -41,7 +41,7 @@ public static class IndexKind public const string IvfFlat = nameof(IvfFlat); /// - /// Disk-based Approximate Nearest Neighbor algorithm designed for efficiently searching for approximate nearest neighbors (ANN) in high-dimensional spaces. + /// Specifies the Disk-based Approximate Nearest Neighbor algorithm, which is designed for efficiently searching for approximate nearest neighbors (ANN) in high-dimensional spaces. /// /// /// The primary focus of DiskANN is to handle large-scale datasets that can't fit entirely into memory, leveraging disk storage to store the data while maintaining fast search times. @@ -49,12 +49,12 @@ public static class IndexKind public const string DiskAnn = nameof(DiskAnn); /// - /// Index that compresses vectors using DiskANN-based quantization methods for better efficiency in the kNN search. + /// Specifies an index that compresses vectors using DiskANN-based quantization methods for better efficiency in the kNN search. /// public const string QuantizedFlat = nameof(QuantizedFlat); /// - /// Dynamic index allows to automatically switch from to indexes. + /// Specifies a dynamic index that switches automatically from to indexes. /// public const string Dynamic = nameof(Dynamic); } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreDataProperty.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreDataProperty.cs index a5cf2b387e97..0f1a7d764bde 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreDataProperty.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreDataProperty.cs @@ -16,7 +16,7 @@ public sealed class VectorStoreDataProperty : VectorStoreProperty /// Initializes a new instance of the class. /// /// The name of the property on the data model. If the record is mapped to a .NET type, this corresponds to the .NET property name on that type. - /// The type of the property. Required when using a record type of Dictionary<string, object?> (dynamic mapping), but can omitted when mapping any other .NET type. + /// The type of the property. Required when using a record type of Dictionary<string, object?> (dynamic mapping), but can be omitted when mapping any other .NET type. public VectorStoreDataProperty(string name, Type? type = null) : base(name, type) { diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreKeyProperty.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreKeyProperty.cs index ffa8cfc79664..12c849d16c9c 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreKeyProperty.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreKeyProperty.cs @@ -16,7 +16,7 @@ public sealed class VectorStoreKeyProperty : VectorStoreProperty /// Initializes a new instance of the class. /// /// The name of the property on the data model. If the record is mapped to a .NET type, this corresponds to the .NET property name on that type. - /// The type of the property. Required when using a record type of Dictionary<string, object?> (dynamic mapping), but can omitted when mapping any other .NET type. + /// The type of the property. Required when using a record type of Dictionary<string, object?> (dynamic mapping), but can be omitted when mapping any other .NET type. public VectorStoreKeyProperty(string name, Type? type = null) : base(name, type) { diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreProperty.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreProperty.cs index 2f79aba601cf..aa82d9f58605 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreProperty.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreProperty.cs @@ -36,7 +36,7 @@ private protected VectorStoreProperty(VectorStoreProperty source) } /// - /// Gets the name of the property on the data model. + /// Gets or sets the name of the property on the data model. /// public string Name { get; set; } @@ -45,14 +45,14 @@ private protected VectorStoreProperty(VectorStoreProperty source) /// /// /// For example, the property name might be "MyProperty" and the storage name might be "my_property". - /// This property is only respected by implementations that do not support a well-known + /// This property is only respected by implementations that don't support a well-known /// serialization mechanism like JSON, in which case the attributes used by that serialization system will /// be used. /// public string? StorageName { get; set; } /// - /// Gets the type of the property. + /// Gets or sets the type of the property. /// public Type? Type { get; set; } } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreVectorProperty.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreVectorProperty.cs index 8be0914cc7af..54762c7ebe81 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreVectorProperty.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordDefinition/VectorStoreVectorProperty.cs @@ -44,7 +44,7 @@ public VectorStoreVectorProperty(string name, Type type, int dimensions) /// /// /// If not set, embedding generation will be performed in the database, if supported by your connector. - /// Otherwise, if your database does not support embedding generation, only pre-generated embeddings can be used (e.g. ReadOnlyMemory<float>). + /// Otherwise, if your database does not support embedding generation, only pregenerated embeddings can be used (for example, ReadOnlyMemory<float>). /// public IEmbeddingGenerator? EmbeddingGenerator { get; set; } @@ -89,7 +89,7 @@ public int Dimensions public string? DistanceFunction { get; set; } /// - /// Gets or sets the desired embedding type (e.g. Embedding<Half>, for cases where the default (typically Embedding<float>) isn't suitable. + /// Gets or sets the desired embedding type (for example, Embedding<Half>) for cases where the default (typically Embedding<float>) isn't suitable. /// public Type? EmbeddingType { get; set; } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/RecordOptions/FilteredRecordRetrievalOptions.cs b/dotnet/src/Connectors/VectorData.Abstractions/RecordOptions/FilteredRecordRetrievalOptions.cs index 89e545d3a412..b6919be6dfd8 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/RecordOptions/FilteredRecordRetrievalOptions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/RecordOptions/FilteredRecordRetrievalOptions.cs @@ -10,7 +10,7 @@ namespace Microsoft.Extensions.VectorData; /// /// Defines options for calling . /// -/// Type of the record. +/// The type of the record. public sealed class FilteredRecordRetrievalOptions { private int _skip = 0; @@ -18,7 +18,7 @@ public sealed class FilteredRecordRetrievalOptions /// /// Gets or sets the number of results to skip before returning results, that is, the index of the first result to return. /// - /// Thrown when the value is less than 0. + /// The value is less than 0. public int Skip { get => this._skip; @@ -47,7 +47,7 @@ public int Skip public bool IncludeVectors { get; set; } /// - /// A builder for sorting. + /// Represents a builder for sorting. /// // This type does not derive any collection in order to avoid Intellisense suggesting LINQ methods. public sealed class OrderByDefinition @@ -101,13 +101,16 @@ internal SortInfo(Expression> propertySelector, bool isAs } /// - /// The expression to select the property to sort by. + /// Gets the expression to select the property to sort by. /// public Expression> PropertySelector { get; } /// - /// True if the sort is ascending; otherwise, false. + /// Gets a value that indicates whether the sort is ascending; otherwise, false. /// + /// + /// if the sort is ascending; otherwise, . + /// public bool Ascending { get; } } } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/HybridSearchOptions.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/HybridSearchOptions.cs index 81d18837f37b..ec1bb646a42e 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/HybridSearchOptions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/HybridSearchOptions.cs @@ -6,7 +6,7 @@ namespace Microsoft.Extensions.VectorData; /// -/// Options for hybrid search when using a dense vector and string keywords to do the search. +/// Defines options for hybrid search when using a dense vector and string keywords to do the search. /// public class HybridSearchOptions { @@ -29,24 +29,26 @@ public class HybridSearchOptions /// Gets or sets the target dense vector property to search on. /// Only needs to be set when the collection has multiple vector properties. /// - /// - /// If not provided will check if there is a vector property to use by default, and - /// will throw if either none or multiple exist. - /// + /// + /// If this property isn't set, checks if there is a vector property to use by default, and + /// throws if either none or multiple exist. + /// public Expression>? VectorProperty { get; set; } /// - /// Gets or sets the additional target property to do the text/keyword search on. + /// Gets or sets the additional target property to do the text or keyword search on. /// The property must have full text indexing enabled. - /// If not provided will look if there is a text property with full text indexing enabled, and - /// will throw if either none or multiple exist. /// + /// + /// If this property isn't set, checks if there is a text property with full text indexing enabled, and + /// throws an exception if either none or multiple exist. + /// public Expression>? AdditionalProperty { get; set; } /// /// Gets or sets the number of results to skip before returning results, that is, the index of the first result to return. /// - /// Thrown when the value is less than 0. + /// The value is less than 0. public int Skip { get => this._skip; diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IKeywordHybridSearchable.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IKeywordHybridSearchable.cs index a1ac8e0d45f5..d0bb9ee95c00 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IKeywordHybridSearchable.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IKeywordHybridSearchable.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.VectorData; /// -/// Contains a method for doing a hybrid search using a vector and keywords. +/// Contains a method for performing a hybrid search using a vector and keywords. /// /// The record data model to use for retrieving data from the store. public interface IKeywordHybridSearchable @@ -42,13 +42,13 @@ public interface IKeywordHybridSearchable /// /// /// To work with embeddings directly, pass in a or a .NET array of the appropriate type. Most providers support at least ReadOnlyMemory<float> and float[], - /// but some support other types (e.g. ReadOnlyMemory<Half>, ). Some providers may also support their own custom types as well, e.g. to represent sparse embeddings. + /// but some support other types (for example, ReadOnlyMemory<Half>, ). Some providers might also support their own custom types as well, for example, to represent sparse embeddings. /// Consult your provider's documentation for supported types. /// /// - /// If you're using directly in your code, that type returns an (e.g. Embedding{float}), + /// If you're using directly in your code, that type returns an (for example, Embedding{float}), /// which can also be passed in directly, as long as the provider supports the specific embedding type. However, consider registering your with the provider - /// instead and pass in the input type (e.g. ). + /// instead and pass in the input type (for example, ). /// /// /// @@ -66,9 +66,9 @@ IAsyncEnumerable> HybridSearchAsync( /// The found object, otherwise . /// is . /// - /// The purpose of this method is to allow for the retrieval of strongly-typed services that might be provided by the , + /// The purpose of this method is to allow for the retrieval of strongly typed services that might be provided by the , /// including itself or any services it might be wrapping. For example, to access the for the instance, - /// may be used to request it. + /// can be used to request it. /// object? GetService(Type serviceType, object? serviceKey = null); } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IVectorSearchable.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IVectorSearchable.cs index 56f2378f5d3f..8d6dc76e8daf 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IVectorSearchable.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/IVectorSearchable.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.VectorData; /// -/// An interface for performing vector searches on a vector store. +/// Defines an interface for performing vector searches on a vector store. /// /// The record data model to use for retrieving data from the store. public interface IVectorSearchable @@ -41,13 +41,13 @@ public interface IVectorSearchable /// /// /// To work with embeddings directly, pass in a or a .NET array of the appropriate type. Most providers support at least ReadOnlyMemory<float> and float[], - /// but some support other types (e.g. ReadOnlyMemory<Half>, ). Some providers may also support their own custom types as well, e.g. to represent sparse embeddings. + /// but some support other types (for example, ReadOnlyMemory<Half>, ). Some providers might also support their own custom types as well, for example, to represent sparse embeddings. /// Consult your provider's documentation for supported types. /// /// - /// If you're using directly in your code, that type returns an (e.g. Embedding{float}), + /// If you're using directly in your code, that type returns an (for example, Embedding{float}), /// which can also be passed in directly, as long as the provider supports the specific embedding type. However, consider registering your with the provider - /// instead and pass in the input type (e.g. ). + /// instead and pass in the input type (for example, ). /// /// /// @@ -64,9 +64,9 @@ IAsyncEnumerable> SearchAsync( /// The found object, otherwise . /// is . /// - /// The purpose of this method is to allow for the retrieval of strongly-typed services that might be provided by the , + /// The purpose of this method is to allow for the retrieval of strongly typed services that might be provided by the , /// including itself or any services it might be wrapping. For example, to access the for the instance, - /// may be used to request it. + /// can be used to request it. /// object? GetService(Type serviceType, object? serviceKey = null); } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/RecordSearchOptions.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/RecordSearchOptions.cs index fe05bb794772..527c7a9c884d 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/RecordSearchOptions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/RecordSearchOptions.cs @@ -28,16 +28,16 @@ public class VectorSearchOptions /// Gets or sets the vector property to search on. /// Only needs to be set when the collection has multiple vector properties. /// - /// - /// If not provided will check if there is a vector property to use by default, and - /// will throw if either none or multiple exist. - /// + /// + /// If this property isn't set provided, checks if there is a vector property to use by default, and + /// throws an exception if either none or multiple exist. + /// public Expression>? VectorProperty { get; set; } /// /// Gets or sets the number of results to skip before returning results, that is, the index of the first result to return. /// - /// Thrown when the value is less than 0. + /// The value is less than 0. public int Skip { get => this._skip; diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchExtensions.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchExtensions.cs index aa43a56709c5..65e931c99d4e 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchExtensions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchExtensions.cs @@ -9,7 +9,7 @@ public static class VectorSearchExtensions { /// /// Asks the for an object of the specified type - /// and throw an exception if one isn't available. + /// and throws an exception if one isn't available. /// /// The record data model to use for retrieving data from the store. /// The vector search. diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchFilter.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchFilter.cs index 1430a69b3740..3142b6db343f 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchFilter.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorSearch/VectorSearchFilter.cs @@ -24,7 +24,7 @@ public sealed class VectorSearchFilter public static VectorSearchFilter Default { get; } = new VectorSearchFilter(); /// - /// The filter clauses to 'and' together. + /// Gets the filter clauses to 'and' together. /// public IEnumerable FilterClauses => this._filterClauses; diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStore.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStore.cs index 9aceaf549f6e..ab284796fd6b 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStore.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStore.cs @@ -9,7 +9,7 @@ namespace Microsoft.Extensions.VectorData; /// -/// Represents a vector store which contains collections of records. +/// Represents a vector store that contains collections of records. /// /// /// This type can be used with collections of any schema type, but requires you to provide schema information when getting a collection. @@ -64,7 +64,7 @@ public abstract VectorStoreCollection GetCollection /// Deletes the collection from the vector store. /// - /// The name of the collection. + /// The name of the collection to delete. /// The to monitor for cancellation requests. The default is . /// A that completes when the collection has been deleted. public abstract Task EnsureCollectionDeletedAsync(string name, CancellationToken cancellationToken = default); @@ -75,16 +75,16 @@ public abstract VectorStoreCollection GetCollectionThe found object, otherwise . /// is . /// - /// The purpose of this method is to allow for the retrieval of strongly-typed services that might be provided by the , + /// The purpose of this method is to allow for the retrieval of strongly typed services that might be provided by the , /// including itself or any services it might be wrapping. For example, to access the for the instance, - /// may be used to request it. + /// can be used to request it. /// public abstract object? GetService(Type serviceType, object? serviceKey = null); /// /// Disposes the and releases any resources it holds. /// - /// True if called from , false if called from a finalizer. + /// if called from ; if called from a finalizer. protected virtual void Dispose(bool disposing) { } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollection.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollection.cs index 69d9ba026f40..cf5636215712 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollection.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollection.cs @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.VectorData; /// -/// Represents a named collection of records in a vector store, which can be used to search and manage records, and to create or delete the collection itself. +/// Represents a named collection of records in a vector store, and can be used to search and manage records, and to create or delete the collection itself. /// /// The data type of the record key. /// The record data model to use for adding, updating, and retrieving data from the store. @@ -155,7 +155,7 @@ public virtual async Task DeleteAsync(IEnumerable keys, CancellationToken /// /// /// Similarly, the error behavior can vary across databases: where possible, the batch should be upserted atomically, so that any errors cause the entire batch to be rolled - /// back. Where not supported, some records may be upserted while others are not. If key properties are set by the user, then the entire upsert operation is idempotent, + /// back. Where not supported, some records might be upserted while others are not. If key properties are set by the user, then the entire upsert operation is idempotent, /// and can simply be retried again if an error occurs. However, if store-generated keys are in use, the upsert operation is no longer idempotent; in that case, if the /// database doesn't guarantee atomicity, retrying could cause duplicate records to be created. /// @@ -174,7 +174,7 @@ public virtual async Task DeleteAsync(IEnumerable keys, CancellationToken /// The maximum number of results to return. /// Options for retrieving the records. /// The to monitor for cancellation requests. The default is . - /// The records matching given predicate. + /// The records that match the given predicate. /// The command fails to execute for any reason. public abstract IAsyncEnumerable GetAsync(Expression> filter, int top, FilteredRecordRetrievalOptions? options = null, CancellationToken cancellationToken = default); @@ -188,7 +188,7 @@ public abstract IAsyncEnumerable> SearchAsync /// Disposes the and releases any resources it holds. /// - /// True if called from , false if called from a finalizer. + /// if called from ; if called from a finalizer. protected virtual void Dispose(bool disposing) { } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionMetadata.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionMetadata.cs index 1351d8d14015..f36fe294ce63 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionMetadata.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionMetadata.cs @@ -5,21 +5,21 @@ namespace Microsoft.Extensions.VectorData; /// Provides metadata about an . public class VectorStoreCollectionMetadata { - /// The name of the vector store system. + /// Gets or sets the name of the vector store system. /// - /// Where possible, this maps to the "db.system.name" attribute defined in the - /// OpenTelemetry Semantic Conventions for database calls and systems, see . + /// Where possible, this value maps to the "db.system.name" attribute defined in the + /// OpenTelemetry Semantic Conventions for database calls and systems; see . /// Example: redis, sqlite, mysql. /// public string? VectorStoreSystemName { get; init; } /// - /// The name of the vector store (database). + /// Gets or sets the name of the vector store (database). /// public string? VectorStoreName { get; init; } /// - /// The name of a collection (table, container) within the vector store (database). + /// Gets or sets the name of a collection (table, container) within the vector store (database). /// public string? CollectionName { get; init; } } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionOptions.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionOptions.cs index cb3b211207c3..04f67aae662b 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionOptions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreCollectionOptions.cs @@ -4,7 +4,7 @@ namespace Microsoft.Extensions.VectorData; -/// Abstract base class for options passed to a collection.. +/// Defines an abstract base class for options passed to a collection. public abstract class VectorStoreCollectionOptions { /// @@ -24,17 +24,17 @@ protected VectorStoreCollectionOptions(VectorStoreCollectionOptions? source) } /// - /// An optional record definition that defines the schema of the record type. + /// Gets or sets an optional record definition that defines the schema of the record type. /// /// /// If not provided, the schema will be inferred from the record model class using reflection. /// In this case, the record model properties must be annotated with the appropriate attributes to indicate their usage. - /// See , and . + /// See , , and . /// public VectorStoreCollectionDefinition? Definition { get; set; } /// - /// The default embedding generator to use when generating vectors embeddings with this collection. + /// Gets or sets the default embedding generator to use when generating vectors embeddings with this collection. /// public IEmbeddingGenerator? EmbeddingGenerator { get; set; } } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreException.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreException.cs index ed6cb8a8ef7d..a90599b34142 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreException.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreException.cs @@ -33,16 +33,16 @@ public VectorStoreException(string? message, Exception? innerException) : base(m { } - /// The name of the vector store system. + /// Gets or sets the name of the vector store system. /// - /// Where possible, this maps to the "db.system.name" attribute defined in the - /// OpenTelemetry Semantic Conventions for database calls and systems, see . + /// Where possible, this value maps to the "db.system.name" attribute defined in the + /// OpenTelemetry Semantic Conventions for database calls and systems; see . /// Example: redis, sqlite, mysql. /// public string? VectorStoreSystemName { get; init; } /// - /// The name of the vector store (database). + /// Gets or sets the name of the vector store (database). /// public string? VectorStoreName { get; init; } diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreExtensions.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreExtensions.cs index d1f90f3ccbf8..ceeecb8166bb 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreExtensions.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreExtensions.cs @@ -9,7 +9,7 @@ public static class VectorStoreExtensions { /// /// Asks the for an object of the specified type - /// and throw an exception if one isn't available. + /// and throws an exception if one isn't available. /// /// The record data model to use for retrieving data from the store. /// The vector store. diff --git a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreMetadata.cs b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreMetadata.cs index 4da250603839..97571a0691bf 100644 --- a/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreMetadata.cs +++ b/dotnet/src/Connectors/VectorData.Abstractions/VectorStorage/VectorStoreMetadata.cs @@ -5,16 +5,16 @@ namespace Microsoft.Extensions.VectorData; /// Provides metadata about an . public class VectorStoreMetadata { - /// The name of the vector store system. + /// Gets or sets the name of the vector store system. /// - /// Where possible, this maps to the "db.system.name" attribute defined in the - /// OpenTelemetry Semantic Conventions for database calls and systems, see . + /// Where possible, this value maps to the "db.system.name" attribute defined in the + /// OpenTelemetry Semantic Conventions for database calls and systems; see . /// Example: redis, sqlite, mysql. /// public string? VectorStoreSystemName { get; init; } /// - /// The name of the vector store (database). + /// Gets or sets the name of the vector store (database). /// public string? VectorStoreName { get; init; } }