定義您的資料模型 （預覽）

更新插入或取得記錄的所有方法都會使用強型別模型類別。 這些類別上的屬性會以指出每個屬性用途的屬性裝飾。

以下是以這些屬性裝飾的模型範例。

using Microsoft.Extensions.VectorData;

public class Hotel
{
    [VectorStoreKey]
    public ulong HotelId { get; set; }

    [VectorStoreData(IsIndexed = true)]
    public string HotelName { get; set; }

    [VectorStoreData(IsFullTextIndexed = true)]
    public string Description { get; set; }

    [VectorStoreVector(Dimensions: 4, DistanceFunction = DistanceFunction.CosineSimilarity, IndexKind = IndexKind.Hnsw)]
    public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }

    [VectorStoreData(IsIndexed = true)]
    public string[] Tags { get; set; }
}

屬性

VectorStoreKeyAttribute

使用這個屬性來指出您的屬性是記錄的索引鍵。

[VectorStoreKey]
public ulong HotelId { get; set; }

VectorStoreKeyAttribute 參數

VectorStoreDataAttribute

使用這個屬性表示您的屬性包含不是索引鍵或向量的一般數據。

[VectorStoreData(IsIndexed = true)]
public string HotelName { get; set; }

VectorStoreDataAttribute 參數

VectorStoreVectorAttribute

使用這個屬性表示您的屬性包含向量。

[VectorStoreVector(Dimensions: 4, DistanceFunction = DistanceFunction.CosineSimilarity, IndexKind = IndexKind.Hnsw)]
public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }

您也可以 VectorStoreVectorAttribute 在沒有向量型別的屬性上使用 ，例如 類型的 string屬性。 以這種方式裝飾屬性時， Microsoft.Exntesions.AI.IEmbeddingGenerator 必須將實例提供給向量存放區。 在插入記錄時，屬性中的 string 文字會自動轉換成向量，並儲存為資料庫中的向量。 無法使用這個機制來擷取向量。

[VectorStoreVector(Dimensions: 4, DistanceFunction = DistanceFunction.CosineSimilarity, IndexKind = IndexKind.Hnsw)]
public string DescriptionEmbedding { get; set; }

VectorStoreVectorAttribute 參數

常見的索引種類和距離函式類型會以 和 Microsoft.SemanticKernel.Data.IndexKind 類別上的Microsoft.SemanticKernel.Data.DistanceFunction靜態值的形式提供。 個別向量存放區實作也可以使用自己的索引類型和距離函式，其中資料庫支援不尋常的類型。

所有更新插入或取得記錄的方法都會使用 類別和向量存放區記錄定義。

這可以藉由使用欄位的註釋來定義您自己的類別，或使用類別/型別搭配記錄定義來完成。 類別需要做兩件事，第一件事是新增具有字段類型的批註，第二件事是使用 vectorstoremodel 裝飾項目來裝飾類別。

以下是使用這些批注裝飾的模型範例。

from dataclasses import dataclass, field
from typing import Annotated
from semantic_kernel.data import (
    DistanceFunction,
    IndexKind,
    VectorStoreRecordDataField,
    VectorStoreRecordDefinition,
    VectorStoreRecordKeyField,
    VectorStoreRecordVectorField,
    vectorstoremodel,
)

@vectorstoremodel
@dataclass
class Hotel:
    hotel_id: Annotated[str, VectorStoreRecordKeyField()] = field(default_factory=lambda: str(uuid4()))
    hotel_name: Annotated[str, VectorStoreRecordDataField(is_filterable=True)]
    description: Annotated[str, VectorStoreRecordDataField(is_full_text_searchable=True)]
    description_embedding: Annotated[list[float], VectorStoreRecordVectorField(dimensions=4, distance_function=DistanceFunction.COSINE, index_kind=IndexKind.HNSW)]
    tags: Annotated[list[str], VectorStoreRecordDataField(is_filterable=True)]

註釋

有三種類型的註釋可供使用，而且具有通用基類。

VectorStoreRecordField

這是所有批注的基類，不打算直接使用。

VectorStoreRecordField 參數

hotel_id: Annotated[str, VectorStoreRecordKeyField]

VectorStoreRecordKeyField

使用此批注來指出此屬性是記錄的索引鍵。

VectorStoreRecordKeyField()

VectorStoreRecordKeyField 參數

不會定義基類以外的其他參數。

VectorStoreRecordDataField

使用此批注來指出您的屬性包含不是索引鍵或向量的一般數據。

VectorStoreRecordDataField(is_filterable=True)

VectorStoreRecordDataField 參數

VectorStoreRecordVectorField

使用此批注來指出您的屬性包含向量。

VectorStoreRecordVectorField(dimensions=4, distance_function=DistanceFunction.COSINE, index_kind=IndexKind.HNSW)

VectorStoreRecordVectorField 參數

常見的索引種類和距離函式類型會以 和 semantic_kernel.data.IndexKind 類別上的semantic_kernel.data.DistanceFunction靜態值的形式提供。 個別向量存放區實作也可以使用自己的索引類型和距離函式，其中資料庫支援不尋常的類型。

更新插入或取得記錄的所有方法都會使用強型別模型類別。 這些類別上的欄位會以批註裝飾，指出每個欄位的用途。

以下是使用這些批注裝飾的模型範例。 根據預設，大部分現成的向量存放區都使用 Jackson，因此是確保傑克遜可以串行化的模型物件的良好作法，亦即類別是可見的、具有 getter、建構函式、註釋等。

import com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordData;
import com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordKey;
import com.microsoft.semantickernel.data.vectorstorage.annotations.VectorStoreRecordVector;
import com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction;
import com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind;

import java.util.List;

public class Hotel {
    @VectorStoreRecordKey
    private String hotelId;

    @VectorStoreRecordData(isFilterable = true)
    private String name;

    @VectorStoreRecordData(isFullTextSearchable = true)
    private String description;

    @VectorStoreRecordVector(dimensions = 4, indexKind = IndexKind.HNSW, distanceFunction = DistanceFunction.COSINE_DISTANCE)
    private List<Float> descriptionEmbedding;

    @VectorStoreRecordData(isFilterable = true)
    private List<String> tags;

    public Hotel() { }

    public Hotel(String hotelId, String name, String description, List<Float> descriptionEmbedding, List<String> tags) {
        this.hotelId = hotelId;
        this.name = name;
        this.description = description;
        this.descriptionEmbedding = descriptionEmbedding;
        this.tags = tags;
    }

    public String getHotelId() { return hotelId; }
    public String getName() { return name; }
    public String getDescription() { return description; }
    public List<Float> getDescriptionEmbedding() { return descriptionEmbedding; }
    public List<String> getTags() { return tags; }
}

註釋

VectorStoreRecordKey

使用此批注來指出您的欄位是記錄的索引鍵。

@VectorStoreRecordKey
private String hotelId;

VectorStoreRecordKey 參數

VectorStoreRecordData

使用此批注來指出您的字段包含不是索引鍵或向量的一般數據。

@VectorStoreRecordData(isFilterable = true)
private String name;

VectorStoreRecordData 參數

VectorStoreRecordVector

使用此批注來指出您的欄位包含向量。

@VectorStoreRecordVector(dimensions = 4, indexKind = IndexKind.HNSW, distanceFunction = DistanceFunction.COSINE_DISTANCE)
private List<Float> descriptionEmbedding;

VectorStoreRecordVector 參數

在和 com.microsoft.semantickernel.data.vectorstorage.definition.IndexKind 列舉上com.microsoft.semantickernel.data.vectorstorage.definition.DistanceFunction會提供常見的索引種類和距離函式類型。 個別向量存放區實作也可以使用自己的索引類型和距離函式，其中資料庫支援不尋常的類型。

更多信息即將推出。