.Net: Adding improvements to xml docs based on suggestions from team.

dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordDataAttribute.cs

@@ -11,6 +11,7 @@ namespace Microsoft.SemanticKernel.Data;
 /// <remarks>
 /// Marking a property as 'data' means that the property is not a key, and not a vector, but optionally
 /// this property may have an associated vector field containing an embedding for this data.
+/// The characteristics defined here will influence how the property is treated by the vector store.
 /// </remarks>
 [Experimental("SKEXP0001")]
 [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]

dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordKeyAttribute.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Attribute to mark a property on a record class as the key under which data is stored in a vector store.
+/// Attribute to mark a property on a record class as the key under which the record is stored in a vector store.
 /// </summary>
+/// <remarks>
+/// The characteristics defined here will influence how the property is treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
 public sealed class VectorStoreRecordKeyAttribute : Attribute

dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordVectorAttribute.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Attribute to mark a property on a record class as the vector.
+/// Attribute to mark a property on a record class as a vector.
 /// </summary>
+/// <remarks>
+/// The characteristics defined here will influence how the property is treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)]
 public sealed class VectorStoreRecordVectorAttribute : Attribute

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/DistanceFunction.cs

@@ -5,8 +5,13 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Defines the distance functions that can be used to compare vectors.
+/// Defines a list of well known distance functions that can be used to compare vectors.
 /// </summary>
+/// <remarks>
+/// Not all Vector Store connectors support all distance functions and some connectors may
+/// support additional distance functions that are not defined here. See the documentation
+/// for each connector for more information on what is supported.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public static class DistanceFunction
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/IndexKind.cs

@@ -5,8 +5,13 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Defines the index types that can be used to index vectors.
+/// Defines a list of well known index types that can be used to index vectors.
 /// </summary>
+/// <remarks>
+/// Not all Vector Store connectors support all index types and some connectors may
+/// support additional index types that are not defined here. See the documentation
+/// for each connector for more information on what is supported.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public static class IndexKind
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDataProperty.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// A description of a data property on a record for storage in a vector store.
+/// Defines a data property on a vector store record.
 /// </summary>
+/// <remarks>
+/// The characteristics defined here will influence how the property is treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public sealed class VectorStoreRecordDataProperty : VectorStoreRecordProperty
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDefinition.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// A description of the properties of a record stored in a vector store, plus how the properties are used.
+/// A description of the properties of a record stored in a vector store.
 /// </summary>
+/// <remarks>
+/// Each property contains additional information about how the property will be treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public sealed class VectorStoreRecordDefinition
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordKeyProperty.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// A description of a key property on a record for storage in a vector store.
+/// Defines a key property on a vector store record.
 /// </summary>
+/// <remarks>
+/// The characteristics defined here will influence how the property is treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public sealed class VectorStoreRecordKeyProperty : VectorStoreRecordProperty
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordProperty.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// A description of a property on a record for storage in a vector store.
+/// Defines a base property class for properties on a vector store record.
 /// </summary>
+/// <remarks>
+/// The characteristics defined here will influence how the property is treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public abstract class VectorStoreRecordProperty
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordVectorProperty.cs

@@ -6,8 +6,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// A description of a vector property on a record for storage in a vector store.
+/// Defines a vector property on a vector store record.
 /// </summary>
+/// <remarks>
+/// The characteristics defined here will influence how the property is treated by the vector store.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public sealed class VectorStoreRecordVectorProperty : VectorStoreRecordProperty
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/DeleteRecordOptions.cs

@@ -5,9 +5,11 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Optional options when calling <see cref="IVectorStoreRecordCollection{TKey, TDataModel}.DeleteAsync"/>.
-/// Reserved for future use.
+/// Options when calling <see cref="IVectorStoreRecordCollection{TKey, TDataModel}.DeleteAsync"/>.
 /// </summary>
+/// <remarks>
+/// This class does not currently include any options, but is added for future extensibility of the API.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public class DeleteRecordOptions
 {

dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/GetRecordOptions.cs

@@ -5,7 +5,7 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Optional options when calling <see cref="IVectorStoreRecordCollection{TKey, TDataModel}.GetAsync"/>.
+/// Options when calling <see cref="IVectorStoreRecordCollection{TKey, TDataModel}.GetAsync"/>.
 /// </summary>
 [Experimental("SKEXP0001")]
 public class GetRecordOptions

dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/UpsertRecordOptions.cs

@@ -5,9 +5,12 @@
 namespace Microsoft.SemanticKernel.Data;
 
 /// <summary>
-/// Optional options when calling <see cref="IVectorStoreRecordCollection{TKey, TDataModel}.UpsertAsync"/>.
+/// Options when calling <see cref="IVectorStoreRecordCollection{TKey, TDataModel}.UpsertAsync"/>.
 /// Reserved for future use.
 /// </summary>
+/// <remarks>
+/// This class does not currently include any options, but is added for future extensibility of the API.
+/// </remarks>
 [Experimental("SKEXP0001")]
 public class UpsertRecordOptions
 {