Использование соединителя Хранилища векторов MongoDB (предварительная версия)

Предупреждение

Функции хранилища векторов семантического ядра доступны в предварительной версии и улучшения, требующие критических изменений, могут по-прежнему возникать в ограниченных обстоятельствах перед выпуском.

Обзор

Соединитель векторного хранилища MongoDB можно использовать для доступа к данным и управления ими в MongoDB. Соединитель имеет следующие характеристики.

Область функций	Поддержка
Коллекция сопоставляется с	Коллекция MongoDB + индекс
Поддерживаемые типы свойств ключей	строка
Поддерживаемые типы свойств данных	строка INT длинный двойной точности с плавающей запятой десятичное bool Дата/время и перечисление каждого из этих типов
Поддерживаемые типы свойств вектора	ReadOnlyMemory<float> ReadOnlyMemory<double>
Поддерживаемые типы индексов	Н/П
Поддерживаемые функции расстояния	CosineSimilarity DotProductSimilarity EuclideanDistance
Поддерживаемые условия фильтров	EqualTo
Поддержка нескольких векторов в записи	Да
Поддерживается IsFilterable?	Да
Поддерживается ЛиFullTextSearchable?	No
Поддерживается StoragePropertyName?	Нет, используйте вместо этого BsonElementAttribute. Дополнительные сведения см. здесь.

Начало работы

Добавьте в проект пакет NuGet соединителя векторного хранилища MongoDB.

dotnet add package Microsoft.SemanticKernel.Connectors.MongoDB --prerelease

Хранилище векторов можно добавить в IServiceCollection контейнер внедрения зависимостей с помощью методов расширения, предоставляемых семантического ядра.

using Microsoft.SemanticKernel;

// Using IServiceCollection with ASP.NET Core.
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddMongoDBVectorStore(connectionString, databaseName);

Методы расширения, которые не принимают параметров, также предоставляются. Для них требуется, чтобы экземпляр MongoDB.Driver.IMongoDatabase регистрировался отдельно в контейнере внедрения зависимостей.

using Microsoft.Extensions.DependencyInjection;
using Microsoft.SemanticKernel;
using MongoDB.Driver;

// Using IServiceCollection with ASP.NET Core.
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton<IMongoDatabase>(
    sp =>
    {
        var mongoClient = new MongoClient(connectionString);
        return mongoClient.GetDatabase(databaseName);
    });
builder.Services.AddMongoDBVectorStore();

Вы можете создать экземпляр векторного хранилища MongoDB напрямую.

using Microsoft.SemanticKernel.Connectors.MongoDB;
using MongoDB.Driver;

var mongoClient = new MongoClient(connectionString);
var database = mongoClient.GetDatabase(databaseName);
var vectorStore = new MongoDBVectorStore(database);

Можно создать прямую ссылку на именованную коллекцию.

using Microsoft.SemanticKernel.Connectors.MongoDB;
using MongoDB.Driver;

var mongoClient = new MongoClient(connectionString);
var database = mongoClient.GetDatabase(databaseName);
var collection = new MongoDBVectorStoreRecordCollection<Hotel>(
    database,
    "skhotels");

Сопоставление данных

Соединитель Хранилища векторов MongoDB предоставляет схему по умолчанию при сопоставлении данных из модели данных в хранилище.

В этом средстве сопоставления выполняется прямое преобразование списка свойств модели данных в поля в MongoDB и используется MongoDB.Bson.Serialization для преобразования в схему хранилища. Это означает, что использование объекта MongoDB.Bson.Serialization.Attributes.BsonElement поддерживается, если требуется другое имя хранилища для имени свойства модели данных. Единственным исключением является ключ записи, сопоставленной с полем базы данных с именем _id, так как все записи MongoDB должны использовать это имя для идентификаторов.

Переопределение имени свойства

Для свойств данных и векторных свойств можно указать переопределение имен полей для использования в хранилище, которое отличается от имен свойств в модели данных. Это не поддерживается для ключей, так как ключ имеет фиксированное имя в MongoDB.

Переопределение имени свойства выполняется путем задания атрибута BsonElement свойств модели данных.

Ниже приведен пример модели данных с BsonElement набором.

using Microsoft.Extensions.VectorData;

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

    [BsonElement("hotel_name")]
    [VectorStoreRecordData(IsFilterable = true)]
    public string HotelName { get; set; }

    [BsonElement("hotel_description")]
    [VectorStoreRecordData(IsFullTextSearchable = true)]
    public string Description { get; set; }

    [BsonElement("hotel_description_embedding")]
    [VectorStoreRecordVector(4, DistanceFunction.CosineSimilarity)]
    public ReadOnlyMemory<float>? DescriptionEmbedding { get; set; }
}

Скоро

Дополнительные сведения в ближайшее время.

Скоро

Дополнительные сведения в ближайшее время.