diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordDataAttribute.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordDataAttribute.cs index 55a931df26b0..f31b5c38352e 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordDataAttribute.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordDataAttribute.cs @@ -11,6 +11,7 @@ namespace Microsoft.SemanticKernel.Data; /// /// 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. /// [Experimental("SKEXP0001")] [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)] diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordKeyAttribute.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordKeyAttribute.cs index d85a3dff6da2..32376956b853 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordKeyAttribute.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordKeyAttribute.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// 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. /// +/// +/// The characteristics defined here will influence how the property is treated by the vector store. +/// [Experimental("SKEXP0001")] [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)] public sealed class VectorStoreRecordKeyAttribute : Attribute diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordVectorAttribute.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordVectorAttribute.cs index 5c7563b96ebc..74a2a0796811 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordVectorAttribute.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordAttributes/VectorStoreRecordVectorAttribute.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// Attribute to mark a property on a record class as the vector. +/// Attribute to mark a property on a record class as a vector. /// +/// +/// The characteristics defined here will influence how the property is treated by the vector store. +/// [Experimental("SKEXP0001")] [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)] public sealed class VectorStoreRecordVectorAttribute : Attribute diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/DistanceFunction.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/DistanceFunction.cs index 9163ebb39c87..32601243966b 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/DistanceFunction.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/DistanceFunction.cs @@ -5,8 +5,13 @@ namespace Microsoft.SemanticKernel.Data; /// -/// 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. /// +/// +/// 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. +/// [Experimental("SKEXP0001")] public static class DistanceFunction { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/IndexKind.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/IndexKind.cs index 0a59454c42b7..364baaa8e727 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/IndexKind.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/IndexKind.cs @@ -5,8 +5,13 @@ namespace Microsoft.SemanticKernel.Data; /// -/// 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. /// +/// +/// 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. +/// [Experimental("SKEXP0001")] public static class IndexKind { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDataProperty.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDataProperty.cs index fc5717c07c09..9dec25aa4ce1 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDataProperty.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDataProperty.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// A description of a data property on a record for storage in a vector store. +/// Defines a data property on a vector store record. /// +/// +/// The characteristics defined here will influence how the property is treated by the vector store. +/// [Experimental("SKEXP0001")] public sealed class VectorStoreRecordDataProperty : VectorStoreRecordProperty { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDefinition.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDefinition.cs index 558bfc77b953..455bd5842c47 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDefinition.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordDefinition.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// 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. /// +/// +/// Each property contains additional information about how the property will be treated by the vector store. +/// [Experimental("SKEXP0001")] public sealed class VectorStoreRecordDefinition { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordKeyProperty.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordKeyProperty.cs index d95dc11ab072..6ba9725e2da4 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordKeyProperty.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordKeyProperty.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// A description of a key property on a record for storage in a vector store. +/// Defines a key property on a vector store record. /// +/// +/// The characteristics defined here will influence how the property is treated by the vector store. +/// [Experimental("SKEXP0001")] public sealed class VectorStoreRecordKeyProperty : VectorStoreRecordProperty { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordProperty.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordProperty.cs index 951b17afabaa..400ae7065355 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordProperty.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordProperty.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// 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. /// +/// +/// The characteristics defined here will influence how the property is treated by the vector store. +/// [Experimental("SKEXP0001")] public abstract class VectorStoreRecordProperty { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordVectorProperty.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordVectorProperty.cs index 86c13bf62056..4f4b3a1bce0a 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordVectorProperty.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordDefinition/VectorStoreRecordVectorProperty.cs @@ -6,8 +6,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// A description of a vector property on a record for storage in a vector store. +/// Defines a vector property on a vector store record. /// +/// +/// The characteristics defined here will influence how the property is treated by the vector store. +/// [Experimental("SKEXP0001")] public sealed class VectorStoreRecordVectorProperty : VectorStoreRecordProperty { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/DeleteRecordOptions.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/DeleteRecordOptions.cs index 6de2e07f66c4..4f034d125a6d 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/DeleteRecordOptions.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/DeleteRecordOptions.cs @@ -5,9 +5,11 @@ namespace Microsoft.SemanticKernel.Data; /// -/// Optional options when calling . -/// Reserved for future use. +/// Options when calling . /// +/// +/// This class does not currently include any options, but is added for future extensibility of the API. +/// [Experimental("SKEXP0001")] public class DeleteRecordOptions { diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/GetRecordOptions.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/GetRecordOptions.cs index 18e59ec7b9d9..5330e076acea 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/GetRecordOptions.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/GetRecordOptions.cs @@ -5,7 +5,7 @@ namespace Microsoft.SemanticKernel.Data; /// -/// Optional options when calling . +/// Options when calling . /// [Experimental("SKEXP0001")] public class GetRecordOptions diff --git a/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/UpsertRecordOptions.cs b/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/UpsertRecordOptions.cs index 8655cc25fde5..c1d9cba35b5d 100644 --- a/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/UpsertRecordOptions.cs +++ b/dotnet/src/SemanticKernel.Abstractions/Data/RecordOptions/UpsertRecordOptions.cs @@ -5,9 +5,12 @@ namespace Microsoft.SemanticKernel.Data; /// -/// Optional options when calling . +/// Options when calling . /// Reserved for future use. /// +/// +/// This class does not currently include any options, but is added for future extensibility of the API. +/// [Experimental("SKEXP0001")] public class UpsertRecordOptions {