데이터 모델 정의(미리 보기)

레코드를 upsert하거나 가져오는 모든 메서드는 강력한 형식의 모델 클래스를 사용합니다. 이러한 클래스의 속성은 각 속성의 용도를 나타내는 특성으로 데코레이팅됩니다.

다음은 이러한 특성으로 데코레이팅된 모델의 예입니다.

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

벡터 형식이 없는 on 속성(예: 형식의 속성)을 사용할 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 정적 값으로 제공됩니다. 개별 벡터 저장소 구현은 데이터베이스에서 비정상적인 형식을 지원하는 자체 인덱스 종류 및 거리 함수를 사용할 수도 있습니다.

레코드를 upsert하거나 가져오는 모든 메서드는 클래스 및 벡터 저장소 레코드 정의를 사용합니다.

이 작업은 필드에 대한 주석을 사용하여 고유한 클래스를 정의하거나 레코드 정의와 함께 클래스/형식을 사용하여 수행할 수 있습니다. 클래스에 대해 수행해야 하는 두 가지 작업은 첫 번째는 필드 형식으로 주석을 추가하는 것입니다. 두 번째는 클래스를 데코레이터로 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 정적 값으로 제공됩니다. 개별 벡터 저장소 구현은 데이터베이스에서 비정상적인 형식을 지원하는 자체 인덱스 종류 및 거리 함수를 사용할 수도 있습니다.

레코드를 upsert하거나 가져오는 모든 메서드는 강력한 형식의 모델 클래스를 사용합니다. 이러한 클래스의 필드는 각 필드의 용도를 나타내는 주석으로 데코레이팅됩니다.

다음은 이러한 주석으로 데코레이팅된 모델의 예입니다. 기본적으로 대부분의 기본 벡터 저장소는 Jackson을 사용하므로 모델 개체가 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 제공됩니다. 개별 벡터 저장소 구현은 데이터베이스에서 비정상적인 형식을 지원하는 자체 인덱스 종류 및 거리 함수를 사용할 수도 있습니다.

추가 정보는 곧 제공될 예정입니다.