Définition de votre schéma de stockage à l’aide d’une définition d’enregistrement (préversion)

Voici un exemple de création d’une définition d’enregistrement.

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 },
    }
};

Lorsque vous créez une définition, vous devez toujours fournir un nom et un type pour chaque propriété de votre schéma, car cela est requis pour la création d’index et le mappage des données.

Pour utiliser la définition, passez-la à la méthode GetCollection.

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

Classes de configuration des propriétés d’enregistrement

VectorStoreRecordKeyProperty

Utilisez cette classe pour indiquer que votre propriété est la clé de l’enregistrement.

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

Paramètres de configuration VectorStoreRecordKeyProperty

VectorStoreRecordDataProperty

Utilisez cette classe pour indiquer que votre propriété contient des données générales qui ne sont pas une clé ou un vecteur.

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

Paramètres de configuration VectorStoreRecordDataProperty

VectorStoreRecordVectorProperty

Utilisez cette classe pour indiquer que votre propriété contient un vecteur.

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

Paramètres de configuration VectorStoreRecordVectorProperty

Voici un exemple de création d’une définition d’enregistrement, à utiliser avec un DataFrame pandas.

Il y a quelques points importants à noter, puis les définitions de champs elles-mêmes. Le premier est le container_mode paramètre. Lorsqu’il est défini sur True, cela indique que le modèle de données est un type de conteneur, comme un DataFrame, et que le modèle de données est donc un conteneur d’enregistrements, au lieu d’un seul, un enregistrement conteneur peut être utilisé de la même façon, la principale différence est que get et get_batch retournera le même type de données, avec un enregistrement unique pour un get ou plusieurs pour un get_batch. Lorsque vous souhaitez effectuer un upsert upsert et upsert_batch que vous pouvez utiliser indifféremment, en d’autres termes, le passage d’un conteneur pour upsert entraîner plusieurs upserts, au lieu d’un seul.

Le deuxième est l’ajout des méthodes et from_dict des to_dict méthodes utilisées pour effectuer la conversion entre le modèle de données et le schéma de stockage. Dans ce cas, la to_dict méthode est utilisée pour convertir le DataFrame en une liste d’enregistrements, et la from_dict méthode est utilisée pour convertir une liste d’enregistrements en dataFrame. Il peut également y avoir une serialize deserialize méthode (non illustrée dans l’exemple ci-dessous), pour plus d’informations sur la différence entre celles-ci, consultez la documentation de sérialisation.

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),
)

Lors de la création d’une définition, vous devez toujours fournir un nom (comme clé dans le fields dict) et taper pour chaque propriété de votre schéma, car cela est requis pour la création d’index et le mappage des données.

Pour utiliser la définition, passez-la à la méthode GetCollection ou à un constructeur de collection, ainsi qu’au type de modèle de données.

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

Voici un exemple de création d’une définition d’enregistrement.

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()
    )
);

Lorsque vous créez une définition, vous devez toujours fournir un nom et un type pour chaque champ de votre schéma, car cela est requis pour la création d’index et le mappage de données.

Pour utiliser la définition, passez-la à la méthode GetCollection.

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

Classes de configuration de champ d’enregistrement

VectorStoreRecordKeyField

Utilisez cette classe pour indiquer que votre champ est la clé de l’enregistrement.

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

Paramètres de configuration VectorStoreRecordKeyField

VectorStoreRecordDataField

Utilisez cette classe pour indiquer que votre propriété contient des données générales qui ne sont pas une clé ou un vecteur.

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

Paramètres de configuration VectorStoreRecordDataField

VectorStoreRecordVectorField

Utilisez cette classe pour indiquer que votre champ contient un vecteur.

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

Paramètres de configuration VectorStoreRecordVectorField