Redis gebruiken voor geheugenopslag met de Semantische Kernel SDK

Dit artikel laat zien hoe u een Redis-database integreert met de RediSearch-module in de Semantic Kernel SDK en deze gebruikt voor geheugenopslag en het ophalen van geheugen.

Vectorarchieven vertegenwoordigen tekstinformatie die is opgeslagen naast een vooraf samengestelde insluitingsvector voor de hele tekst. Wanneer een LLM wordt gevraagd een geheugen in te roepen, worden deze vooraf ingesloten insluitingen gebruikt om efficiënt te evalueren of een geheugen relevant is voor de prompt. Nadat de LLM een overeenkomend geheugen heeft gevonden, wordt de tekstinformatie van het geheugen gebruikt als context voor de volgende stappen in de promptvoltooiing.

Geheugenopslag die wordt toegevoegd aan de Semantische Kernel SDK biedt een bredere context voor uw aanvragen. Hiermee kunt u ook gegevens op dezelfde manier opslaan als bij het opslaan van een traditionele database, maar query's uitvoeren in natuurlijke taal.

Vereisten

• Een Azure-account met een actief abonnement. Gratis een account maken
• .NET SDK
• Microsoft.SemanticKernel NuGet-pakket
• Microsoft.SemanticKernel.Connectors.Redis NuGet-pakket
• Microsoft.SemanticKernel.Plugins.Memory NuGet-pakket
• StackExchange.Redis NuGet-pakket
• Een Redis-database met de RediSearch-module, geïmplementeerd en toegankelijk voor uw .NET-toepassing

Geheugenopslag implementeren met behulp van een Redis-database

Voordat u uw Redis-database integreert met de Semantic Kernel SDK, moet u ervoor zorgen dat de RediSearch-module is ingeschakeld. Zie Redis-modules gebruiken met Azure Cache voor Redis voor module-informatie voor Azure Cache voor Redis.

1. Initialiseer een verbinding met uw Redis-database. Voorbeeld:

   // 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. Bouw de Kernel door op te maken ITextEmbeddingGenerationService. Voorbeeld:

   // 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. Verpakt de Redis-database in een RedisMemoryStore exemplaar en initialiseer vervolgens een SemanticTextMemory object met behulp van de service geheugenopslag en het insluiten van generatie. Voorbeeld:

   // 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. Voeg het semantische tekstgeheugen toe aan de Kernel hand van de TextMemoryPlugin klasse. Voorbeeld:

   // 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. Gebruik de Kernel invoegtoepassing om herinneringen op te slaan, op te halen en terug te halen. Voorbeeld:

   // 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. Gebruik geheugenherhaling als onderdeel van een prompt met behulp van de syntaxis {{...}}van de promptsjabloon. Voorbeeld:

   // 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}");
   

Gerelateerde inhoud

• [RAG gebruiken met SQL]
• [Gegevensopname van SharePoint]
• [Werken met vectordatabases]