Implementowanie usługi Azure OpenAI z narzędziem RAG przy użyciu wyszukiwania wektorów w aplikacji platformy .NET

W tym samouczku omówiono integrację wzorca RAG przy użyciu modeli Open AI i możliwości wyszukiwania wektorów w aplikacji platformy .NET. Przykładowa aplikacja wykonuje wyszukiwania wektorowe na danych niestandardowych przechowywanych w usłudze Azure Cosmos DB dla bazy danych MongoDB i dodatkowo uściśli odpowiedzi przy użyciu modeli generacyjnych sztucznej inteligencji, takich jak GPT-35 i GPT-4. W poniższych sekcjach skonfigurujesz przykładową aplikację i zapoznasz się z kluczowymi przykładami kodu, które demonstrują te pojęcia.

Wymagania wstępne

.NET 8.0
Konto Azure
Usługa Azure Cosmos DB dla MongoDB (vCore)
Usługa Azure Open AI
- Implementacja modelu text-embedding-ada-002 do osadzania
- Wdrażanie modelu gpt-35-turbo w celu uzupełniania czatów

Omówienie aplikacji

Aplikacja Przewodnik po przepisie usługi Cosmos umożliwia wykonywanie wektorowych i opartych na sztucznej inteligencji wyszukiwań względem zestawu danych przepisu. Możesz wyszukać bezpośrednio dostępne przepisy lub poprosić aplikację o nazwy składników, aby znaleźć powiązane przepisy. Aplikacja i kolejne sekcje przeprowadzą Cię przez ten proces pracy, aby zademonstrować tego typu funkcjonalność.

Przekazywanie przykładowych danych do bazy danych Azure Cosmos DB dla MongoDB.
Utwórz osadzanie i indeks wektorowy dla przekazanych przykładowych danych przy użyciu modelu Azure OpenAI text-embedding-ada-002 .
Przeprowadź wyszukiwanie podobieństwa wektorów na podstawie monitów użytkownika.
Użyj modelu uzupełniania usługi Azure OpenAI gpt-35-turbo , aby utworzyć bardziej znaczące odpowiedzi na podstawie danych wyników wyszukiwania.

Wprowadzenie

Sklonuj następujące repozytorium GitHub:

git clone https://github.com/microsoft/AzureDataRetrievalAugmentedGenerationSamples.git

W folderze C#/CosmosDB-MongoDBvCore otwórz plik CosmosRecipeGuide.sln .

W pliku appsettings.json zastąp następujące wartości konfiguracji wartościami azure OpenAI i Azure CosmosDB for MongoDb:

"OpenAIEndpoint": "https://<your-service-name>.openai.azure.com/",
"OpenAIKey": "<your-API-key>",
"OpenAIEmbeddingDeployment": "<your-ADA-deployment-name>",
"OpenAIcompletionsDeployment": "<your-GPT-deployment-name>",
"MongoVcoreConnection": "<your-Mongo-connection-string>"

Uruchom aplikację, naciskając przycisk Start w górnej części programu Visual Studio.

Eksplorowanie aplikacji

Kiedy uruchamiasz aplikację po raz pierwszy, łączy się ona z Azure Cosmos DB i informuje, że żadne przepisy nie są jeszcze dostępne. Wykonaj kroki wyświetlane przez aplikację, aby rozpocząć podstawowy przepływ pracy.

Wybierz Przekaż przepisy do Cosmos DB i naciśnij Enter. To polecenie odczytuje przykładowe pliki JSON z projektu lokalnego i przekazuje je do konta usługi Cosmos DB.

Kod z klasy Utility.cs analizuje lokalne pliki JSON.

public static List<Recipe> ParseDocuments(string Folderpath)
{
    List<Recipe> recipes = new List<Recipe>();

    Directory.GetFiles(Folderpath)
        .ToList()
        .ForEach(f =>
        {
            var jsonString= System.IO.File.ReadAllText(f);
            Recipe recipe = JsonConvert.DeserializeObject<Recipe>(jsonString);
            recipe.id = recipe.name.ToLower().Replace(" ", "");
            recipes.Add(recipe);
        }
    );

    return recipes;
}

Metoda UpsertVectorAsync w pliku VCoreMongoService.cs przekazuje dokumenty do usługi Azure Cosmos DB dla bazy danych MongoDB.

public async Task UpsertVectorAsync(Recipe recipe)
    {
        BsonDocument document = recipe.ToBsonDocument();

        if (!document.Contains("_id"))
        {
            Console.WriteLine("UpsertVectorAsync: Document does not contain _id.");
            throw new ArgumentException("UpsertVectorAsync: Document does not contain _id.");
        }

        string? _idValue = document["_id"].ToString();

        try
        {
            var filter = Builders<BsonDocument>.Filter.Eq("_id", _idValue);
            var options = new ReplaceOptions { IsUpsert = true };
            await _recipeCollection.ReplaceOneAsync(filter, document, options);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Exception: UpsertVectorAsync(): {ex.Message}");
            throw;
        }
    }

Wybierz pozycję Wektoryzuj przepisy i zapisz je w usłudze Cosmos DB.

Elementy JSON przekazane do usługi Cosmos DB nie zawierają osadzania i dlatego nie są zoptymalizowane pod kątem funkcji RAG za pośrednictwem wyszukiwania wektorowego. Osadzanie to gęsta, liczbowa reprezentacja semantycznego znaczenia tekstu. Wyszukiwania wektorowe są w stanie znaleźć elementy z kontekstowo podobnymi osadzaniami.

Metoda GetEmbeddingsAsync w pliku OpenAIService.cs tworzy osadzanie dla każdego elementu w bazie danych.

public async Task<float[]?> GetEmbeddingsAsync(dynamic data)
{
    try
    {
        EmbeddingsOptions options = new EmbeddingsOptions(data)
        {
            Input = data
        };

        var response = await _openAIClient.GetEmbeddingsAsync(openAIEmbeddingDeployment, options);

        Embeddings embeddings = response.Value;
        float[] embedding = embeddings.Data[0].Embedding.ToArray();

        return embedding;
    }
    catch (Exception ex)
    {
        Console.WriteLine($"GetEmbeddingsAsync Exception: {ex.Message}");
        return null;
    }
}

Element CreateVectorIndexIfNotExists w pliku VCoreMongoService.cs tworzy indeks wektorowy, który umożliwia wykonywanie wyszukiwania podobieństwa wektorów.

public void CreateVectorIndexIfNotExists(string vectorIndexName)
{
    try
    {
        //Find if vector index exists in vectors collection
        using (IAsyncCursor<BsonDocument> indexCursor = _recipeCollection.Indexes.List())
        {
            bool vectorIndexExists = indexCursor.ToList().Any(x => x["name"] == vectorIndexName);
            if (!vectorIndexExists)
            {
                BsonDocumentCommand<BsonDocument> command = new BsonDocumentCommand<BsonDocument>(
                    BsonDocument.Parse(@"
                        { createIndexes: 'Recipe',
                            indexes: [{
                            name: 'vectorSearchIndex',
                            key: { embedding: 'cosmosSearch' },
                            cosmosSearchOptions: {
                                kind: 'vector-ivf',
                                numLists: 5,
                                similarity: 'COS',
                                dimensions: 1536 }
                            }]
                        }"));

                BsonDocument result = _database.RunCommand(command);
                if (result["ok"] != 1)
                {
                    Console.WriteLine("CreateIndex failed with response: " + result.ToJson());
                }
            }
        }
    }
    catch (MongoException ex)
    {
        Console.WriteLine("MongoDbService InitializeVectorIndex: " + ex.Message);
        throw;
    }
}

Wybierz opcję Zapytaj asystenta sztucznej inteligencji (wyszukaj przepis według nazwy lub opisu lub zadaj pytanie) w aplikacji, aby uruchomić zapytanie użytkownika.

Zapytanie użytkownika jest konwertowane na osadzanie przy użyciu usługi Open AI i modelu osadzania. Osadzanie jest następnie wysyłane do usługi Azure Cosmos DB dla bazy danych MongoDB i służy do wykonywania wyszukiwania wektorowego. Metoda VectorSearchAsync w pliku VCoreMongoService.cs wykonuje wyszukiwanie wektorów w celu znalezienia wektorów znajdujących się blisko podanego wektora i zwraca listę dokumentów z rdzeni wirtualnych usługi Azure Cosmos DB for MongoDB.

public async Task<List<Recipe>> VectorSearchAsync(float[] queryVector)
    {
        List<string> retDocs = new List<string>();
        string resultDocuments = string.Empty;

        try
        {
            //Search Azure Cosmos DB for MongoDB vCore collection for similar embeddings
            //Project the fields that are needed
            BsonDocument[] pipeline = new BsonDocument[]
            {
                BsonDocument.Parse(
                    @$"{{$search: {{
                            cosmosSearch:
                                {{ vector: [{string.Join(',', queryVector)}],
                                   path: 'embedding',
                                   k: {_maxVectorSearchResults}}},
                                   returnStoredSource:true
                                }}
                            }}"),
                BsonDocument.Parse($"{{$project: {{embedding: 0}}}}"),
            };

            var bsonDocuments = await _recipeCollection
                .Aggregate<BsonDocument>(pipeline).ToListAsync();

            var recipes = bsonDocuments
                .ToList()
                .ConvertAll(bsonDocument =>
                    BsonSerializer.Deserialize<Recipe>(bsonDocument));
            return recipes;
        }
        catch (MongoException ex)
        {
            Console.WriteLine($"Exception: VectorSearchAsync(): {ex.Message}");
            throw;
        }
    }

Metoda GetChatCompletionAsync generuje ulepszoną odpowiedź na czat na podstawie monitu użytkownika i powiązanych wyników wyszukiwania wektorów.

public async Task<(string response, int promptTokens, int responseTokens)> GetChatCompletionAsync(string userPrompt, string documents)
{
    try
    {
        ChatMessage systemMessage = new ChatMessage(
            ChatRole.System, _systemPromptRecipeAssistant + documents);
        ChatMessage userMessage = new ChatMessage(
            ChatRole.User, userPrompt);

        ChatCompletionsOptions options = new()
        {
            Messages =
            {
                systemMessage,
                userMessage
            },
            MaxTokens = openAIMaxTokens,
            Temperature = 0.5f, //0.3f,
            NucleusSamplingFactor = 0.95f,
            FrequencyPenalty = 0,
            PresencePenalty = 0
        };

        Azure.Response<ChatCompletions> completionsResponse =
            await openAIClient.GetChatCompletionsAsync(openAICompletionDeployment, options);
        ChatCompletions completions = completionsResponse.Value;

        return (
            response: completions.Choices[0].Message.Content,
            promptTokens: completions.Usage.PromptTokens,
            responseTokens: completions.Usage.CompletionTokens
        );

    }
    catch (Exception ex)
    {
        string message = $"OpenAIService.GetChatCompletionAsync(): {ex.Message}";
        Console.WriteLine(message);
        throw;
    }
}

Aplikacja używa również monitów inżynieryjnych, aby upewnić się, że usługa Open AI ogranicza i formatuje odpowiedź dla dostarczonych przepisów.

//System prompts to send with user prompts to instruct the model for chat session
private readonly string _systemPromptRecipeAssistant = @"
    You are an intelligent assistant for Contoso Recipes.
    You are designed to provide helpful answers to user questions about
    recipes, cooking instructions provided in JSON format below.

    Instructions:
    - Only answer questions related to the recipe provided below.
    - Don't reference any recipe not provided below.
    - If you're unsure of an answer, say ""I don't know"" and recommend users search themselves.
    - Your response  should be complete.
    - List the Name of the Recipe at the start of your response followed by step by step cooking instructions.
    - Assume the user is not an expert in cooking.
    - Format the content so that it can be printed to the Command Line console.
    - In case there is more than one recipe you find, let the user pick the most appropriate recipe.";

Sprzężenie zwrotne

Czy ta strona była pomocna?

Last updated on 2026-01-22