使用記錄定義來定義記憶體架構 （預覽）

以下是如何建立記錄定義的範例。

using Microsoft.Extensions.VectorData;

var hotelDefinition = new VectorStoreRecordDefinition
{
    Properties = new List<VectorStoreRecordProperty>
    {
        new VectorStoreRecordKeyProperty("HotelId", typeof(ulong)),
        new VectorStoreRecordDataProperty("HotelName", typeof(string)) { IsFilterable = true },
        new VectorStoreRecordDataProperty("Description", typeof(string)) { IsFullTextSearchable = true },
        new VectorStoreRecordVectorProperty("DescriptionEmbedding", typeof(float)) { Dimensions = 4, DistanceFunction = DistanceFunction.CosineDistance, IndexKind = IndexKind.Hnsw },
    }
};

建立定義時，您一律必須提供架構中每個屬性的名稱和類型，因為這是建立索引和數據對應的必要專案。

若要使用定義，請將它傳遞至 GetCollection 方法。

var collection = vectorStore.GetCollection<ulong, Hotel>("skhotels", hotelDefinition);

Record 屬性組態類別

VectorStoreRecordKeyProperty

使用此類別指出您的屬性是記錄的索引鍵。

new VectorStoreRecordKeyProperty("HotelId", typeof(ulong)),

VectorStoreRecordKeyProperty 組態設定

VectorStoreRecordDataProperty

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

new VectorStoreRecordDataProperty("HotelName", typeof(string)) { IsFilterable = true },

VectorStoreRecordDataProperty 組態設定

VectorStoreRecordVectorProperty

使用此類別表示您的屬性包含向量。

new VectorStoreRecordVectorProperty("DescriptionEmbedding", typeof(float)) { Dimensions = 4, DistanceFunction = DistanceFunction.CosineDistance, IndexKind = IndexKind.Hnsw },

VectorStoreRecordVectorProperty 組態設定

以下是如何建立記錄定義的範例，以搭配 pandas DataFrame 使用。

有幾個重要事項要注意，其他則欄位定義本身。 第一個是 container_mode 參數。 當設定為 True 時，這表示數據模型是容器類型，例如 DataFrame，因此數據模型是記錄的容器，而不是單一的容器記錄，可以完全相同的方式使用容器記錄，主要差異在於 get ，而且 get_batch 會傳回相同的數據類型。 具有的單一記錄 get ，以及一或多個 的 get_batch記錄。 當您想要執行 upsert， upsert 而且 upsert_batch 可以交替使用時，換句話說，將容器傳遞至 upsert 會導致多個 upsert，而不是單一插入。

第二個是 新增 to_dict 和 from_dict 方法，用來在數據模型與記憶體架構之間轉換。 在此情況下，方法 to_dict 會用來將 DataFrame 轉換成記錄清單，而 from_dict 方法會用來將記錄清單轉換成 DataFrame。 您也可以有 和 serialize deserialize 方法（如下列範例所示），如需有關串行 化文件之間差異的詳細數據。

from semantic_kernel.data import (
    VectorStoreRecordDataField,
    VectorStoreRecordDefinition,
    VectorStoreRecordKeyField,
    VectorStoreRecordVectorField,
)

hotel_definition = VectorStoreRecordDefinition(
    fields={
        "hotel_id": VectorStoreRecordKeyField(property_type="str"),
        "hotel_name": VectorStoreRecordDataField(property_type="str", is_filterable=True),
        "description": VectorStoreRecordDataField(
            property_type="str", has_embedding=True, embedding_property_name="description_embedding"
        ),
        "description_embedding": VectorStoreRecordVectorField(property_type="list[float]"),
    },
    container_mode=True,
    to_dict=lambda record, **_: record.to_dict(orient="records"),
    from_dict=lambda records, **_: DataFrame(records),
)

建立定義時，您一律必須提供名稱（如聽寫中的 fields 索引鍵），以及架構中每個屬性的類型，因為這是建立索引和數據對應的必要專案。

若要使用定義，請將它傳遞給 GetCollection 方法或集合建構函式，以及數據模型類型。

collection = vector_store.get_collection(
    collection_name="skhotels", 
    data_model_type=pd.DataFrame, 
    data_model_definition=hotel_definition,
)

以下是如何建立記錄定義的範例。

var hotelDefinition = VectorStoreRecordDefinition.fromFields(
    Arrays.asList(
        VectorStoreRecordKeyField.builder().withName("hotelId").withFieldType(String.class).build(),
        VectorStoreRecordDataField.builder()
            .withName("name")
            .withFieldType(String.class)
            .isFilterable(true).build(),
        VectorStoreRecordDataField.builder()
            .withName("description")
            .withFieldType(String.class)
            .isFullTextSearchable(true).build(),
        VectorStoreRecordVectorField.builder().withName("descriptionEmbedding")
            .withDimensions(4)
            .withIndexKind(IndexKind.HNSW)
            .withDistanceFunction(DistanceFunction.COSINE_DISTANCE)
            .withFieldType(List.class).build()
    )
);

建立定義時，您一律必須提供架構中每個欄位的名稱和類型，因為這是建立索引和數據對應的必要專案。

若要使用定義，請將它傳遞至 GetCollection 方法。

var collection = vectorStore.getCollection("skhotels",
        JDBCVectorStoreRecordCollectionOptions.builder()
            .withRecordDefinition(hotelDefinition)
            .build()
    );

記錄欄位組態類別

VectorStoreRecordKeyField

使用此類別指出您的欄位是記錄的索引鍵。

VectorStoreRecordKeyField.builder().withName("hotelId").withFieldType(String.class).build(),

VectorStoreRecordKeyField 組態設定

VectorStoreRecordDataField

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

VectorStoreRecordDataField.builder()
    .withName("name")
    .withFieldType(String.class)
    .isFilterable(true).build(),

VectorStoreRecordDataField 組態設定

VectorStoreRecordVectorField

使用此類別指出您的欄位包含向量。

VectorStoreRecordVectorField.builder().withName("descriptionEmbedding")
    .withDimensions(4)
    .withIndexKind(IndexKind.HNSW)
    .withDistanceFunction(DistanceFunction.COSINE_DISTANCE)
    .withFieldType(List.class).build(),

VectorStoreRecordVectorField 組態設定