Partage via

Utiliser Redis pour le stockage de souvenirs avec le kit SDK Semantic Kernel

  • Article

Cet article montre comment intégrer une base de données Redis avec le module RediSearch dans le SDK Semantic Kernel et comment s’en servir à des fins de stockage et de récupération de souvenirs.

Les magasins de vecteurs représentent des informations textuelles qui ont été stockées avec un vecteur d'intégration précalculé pour l'ensemble du texte. Lorsqu’un LLM est invité à rappeler un souvenir, il se sert de ces incorporations précalculées pour évaluer efficacement si un souvenir est pertinent par rapport au prompt. Une fois que le LLM a trouvé un souvenir correspondant, il utilise les informations textuelles du souvenir pour les prochaines étapes de la l’exécution du prompt.

Le stockage de souvenirs, qui est ajouté au kit SDK Semantic Kernel, permet d’élargir le contexte pour vos requêtes. Il vous permet également de stocker des données à la manière d’une base de données classique, mais de l’interroger en utilisant un langage naturel.

Prérequis

Implémenter le stockage de souvenirs en utilisant une base de données Redis

Avant d’intégrer votre base de données Redis au kit SDK Semantic Kernel, vérifiez que le module RediSearch est activé. Pour obtenir des informations sur les modules pour Azure Cache pour Redis, consultez Utiliser des modules Redis avec Azure Cache pour Redis.

  1. Initialisez une connexion à votre base de données Redis. Par exemple :

    // Retrieve the Redis connection config.
IConfigurationRoot config = new ConfigurationBuilder().AddUserSecrets<Program>().Build();
string redisConfig = config["REDIS_CONFIG"]!;

// Initialize a connection to the Redis database.
ConnectionMultiplexer connectionMultiplexer = await ConnectionMultiplexer.ConnectAsync(
    redisConfig
);
IDatabase database = connectionMultiplexer.GetDatabase();

  2. Générez le Kernel en incluant ITextEmbeddingGenerationService. Par exemple :

    // Retrieve the Azure OpenAI config and secrets saved during deployment.
string endpoint = config["AZURE_OPENAI_ENDPOINT"]!;
string embeddingModel = config["AZURE_OPENAI_EMBEDDING_NAME"]!;
string completionModel = config["AZURE_OPENAI_GPT_NAME"]!;
string key = config["AZURE_OPENAI_KEY"]!;

// Build the Kernel; must add an embedding generation service.
Kernel kernel = Kernel
    .CreateBuilder()
    .AddAzureOpenAITextEmbeddingGeneration(embeddingModel, endpoint, key)
    .AddAzureOpenAIChatCompletion(completionModel, endpoint, key)
    .Build();

  3. Enveloppez la base de données Redis dans une instance RedisMemoryStore, puis initialisez un objet SemanticTextMemory en utilisant le magasin de souvenirs et le service de génération d’incorporations. Par exemple :

    // Retrieve the desired vector size for the memory store.
// If unspecified, the default vector size is 1536.
int vectorSize = int.Parse(config["REDIS_MEMORY_VECTOR_SIZE"]!);

// Initialize a memory store using the redis database
IMemoryStore memoryStore = new RedisMemoryStore(database, vectorSize);

// Retrieve the embedding service from the Kernel.
ITextEmbeddingGenerationService embeddingService =
    kernel.Services.GetRequiredService<ITextEmbeddingGenerationService>();

// Initialize a SemanticTextMemory using the memory store and embedding generation service.
SemanticTextMemory textMemory = new(memoryStore, embeddingService);

  4. Ajoutez la mémoire textuelle sémantique à Kernel en utilisant la classe TextMemoryPlugin. Par exemple :

    // Initialize a TextMemoryPlugin using the text memory.
TextMemoryPlugin memoryPlugin = new(textMemory);

// Import the text memory plugin into the Kernel.
KernelPlugin memory = kernel.ImportPluginFromObject(memoryPlugin);

  5. Utilisez Kernel et le plug-in pour enregistrer, récupérer et rappeler les souvenirs. Par exemple :

    // Retrieve the desired memory collection name.
string memoryCollectionName = config["REDIS_MEMORY_COLLECTION_NAME"]!;

// Save a memory with the Kernel.
await kernel.InvokeAsync(
    memory["Save"],
    new()
    {
        [TextMemoryPlugin.InputParam] = "My family is from New York",
        [TextMemoryPlugin.CollectionParam] = memoryCollectionName,
        [TextMemoryPlugin.KeyParam] = "info1",
    }
);

// Retrieve a memory with the Kernel.
FunctionResult result = await kernel.InvokeAsync(
    memory["Retrieve"],
    new()
    {
        [TextMemoryPlugin.CollectionParam] = memoryCollectionName,
        [TextMemoryPlugin.KeyParam] = "info1",
    }
);

// Get the memory string from the function result; returns a null value if no memory is found.
Console.WriteLine(
    $"Retrieved memory: {result.GetValue<string>() ?? "ERROR: memory not found"}"
);

// Alternatively, recall similar memories with the Kernel.
// Can configure the memory collection, number of memories to recall, and relevance score.
result = await kernel.InvokeAsync(
    memory["Recall"],
    new()
    {
        [TextMemoryPlugin.InputParam] = "Ask: where do I live?",
        [TextMemoryPlugin.CollectionParam] = memoryCollectionName,
        [TextMemoryPlugin.LimitParam] = "2",
        [TextMemoryPlugin.RelevanceParam] = "0.79",
    }
);

// If memories are recalled, the function result can be deserialized as a string[].
string? resultStr = result.GetValue<string>();
string[]? parsedResult = string.IsNullOrEmpty(resultStr)
    ? null
    : JsonSerializer.Deserialize<string[]>(resultStr);
Console.WriteLine(
    $"Recalled memories: {(parsedResult?.Length > 0 ? resultStr : "ERROR: memory not found")}"
);

  6. Utilisez le rappel de souvenirs dans un prompt en employant la syntaxe de modèle de prompt {{...}}. Par exemple :

    // Create a prompt that includes memory recall.
// The {{...}} syntax represents an expression to Semantic Kernel.
// For more information on this syntax see:
// https://learn.microsoft.com/semantic-kernel/prompts/prompt-template-syntax
string memoryRecallPrompt = """ 
    Consider only the facts below when answering questions:

    BEGIN FACTS
    About me: {{recall 'where did I grow up?'}}
    END FACTS

    Question: What are some fun facts about my home state?
    """;

// Invoke the prompt with the Kernel.
// Must configure the memory collection, number of memories to recall, and relevance score.
resultStr = await kernel.InvokePromptAsync<string>(
    memoryRecallPrompt,
    new()
    {
        [TextMemoryPlugin.CollectionParam] = memoryCollectionName,
        [TextMemoryPlugin.LimitParam] = "2",
        [TextMemoryPlugin.RelevanceParam] = "0.79",
    }
);

// If the memory recall fails, the model will indicate it has missing information in its output.
// Otherwise the output will incorporate your memory as context.
Console.WriteLine($"Output: {resultStr}");

Contenu connexe

  • [Utiliser RAG avec SQL]
  • [Ingestion de données à partir de SharePoint]
  • [Utilisation de bases de données vectorielles]