semantic-kernel/dotnet/samples/KernelSyntaxExamples/Example54_AzureChatCompletionWithData.cs

// Copyright (c) Microsoft. All rights reserved.

using System;
using System.Threading.Tasks;
using Microsoft.SemanticKernel;
using Microsoft.SemanticKernel.AI.ChatCompletion;
using Microsoft.SemanticKernel.Connectors.AI.OpenAI.ChatCompletionWithData;

/**
 * This example shows how to use Azure OpenAI Chat Completion with data.
 * More information: <see href="https://learn.microsoft.com/en-us/azure/ai-services/openai/use-your-data-quickstart"/>
 */
// ReSharper disable once InconsistentNaming
public static class Example54_AzureChatCompletionWithData
{
    public static async Task RunAsync()
    {
        // Uploaded content in Azure Blob Storage in .txt file:

        // Emily and David, two passionate scientists, met during a research expedition to Antarctica.
        // Bonded by their love for the natural world and shared curiosity,
        // they uncovered a groundbreaking phenomenon in glaciology that could
        // potentially reshape our understanding of climate change.

        await ExampleWithChatCompletion();
        await ExampleWithKernel();
    }

    private static async Task ExampleWithChatCompletion()
    {
        Console.WriteLine("=== Example with Chat Completion ===");

        var chatCompletion = new AzureChatCompletionWithData(GetCompletionWithDataConfig());
        var chatHistory = chatCompletion.CreateNewChat();

        // First question without previous context based on uploaded content.
        var ask = "How did Emily and David meet?";
        chatHistory.AddUserMessage(ask);

        // Chat Completion example
        var chatResult = (await chatCompletion.GetChatCompletionsAsync(chatHistory))[0];
        var chatMessage = await chatResult.GetChatMessageAsync();

        var response = chatMessage.Content;
        var toolResponse = chatResult.ModelResult.GetResult<ChatWithDataModelResult>().ToolContent;

        // Output
        // Ask: How did Emily and David meet?
        // Response: Emily and David, both passionate scientists, met during a research expedition to Antarctica.
        Console.WriteLine($"Ask: {ask}");
        Console.WriteLine($"Response: {response}");
        Console.WriteLine();

        // Chat history maintenance
        if (!string.IsNullOrEmpty(toolResponse))
        {
            chatHistory.AddMessage(AuthorRole.Tool, toolResponse);
        }

        chatHistory.AddAssistantMessage(response);

        // Second question based on uploaded content.
        ask = "What are Emily and David studying?";
        chatHistory.AddUserMessage(ask);

        // Chat Completion Streaming example
        Console.WriteLine($"Ask: {ask}");
        Console.WriteLine("Response: ");

        await foreach (var result in chatCompletion.GetStreamingChatCompletionsAsync(chatHistory))
        {
            await foreach (var message in result.GetStreamingChatMessageAsync())
            {
                // Output
                // Ask: What are Emily and David studying?
                // Response: They are passionate scientists who study glaciology,
                // a branch of geology that deals with the study of ice and its effects.
                Console.Write(message.Content);
            }
        }

        Console.WriteLine(Environment.NewLine);
    }

    private static async Task ExampleWithKernel()
    {
        Console.WriteLine("=== Example with Kernel ===");

        var ask = "How did Emily and David meet?";

        var completionWithDataConfig = GetCompletionWithDataConfig();

        IKernel kernel = new KernelBuilder()
            .WithAzureChatCompletionService(config: completionWithDataConfig)
            .Build();

        var semanticFunction = kernel.CreateSemanticFunction("Question: {{$input}}");

        // First question without previous context based on uploaded content.
        var response = await kernel.RunAsync(ask, semanticFunction);

        // Output
        // Ask: How did Emily and David meet?
        // Response: Emily and David, both passionate scientists, met during a research expedition to Antarctica.
        Console.WriteLine($"Ask: {ask}");
        Console.WriteLine($"Response: {response}");
        Console.WriteLine();

        // Second question based on uploaded content.
        ask = "What are Emily and David studying?";
        response = await kernel.RunAsync(ask, semanticFunction);

        // Output
        // Ask: What are Emily and David studying?
        // Response: They are passionate scientists who study glaciology,
        // a branch of geology that deals with the study of ice and its effects.
        Console.WriteLine($"Ask: {ask}");
        Console.WriteLine($"Response: {response}");
        Console.WriteLine();
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="AzureChatCompletionWithDataConfig"/> class.
    /// </summary>
    private static AzureChatCompletionWithDataConfig GetCompletionWithDataConfig()
    {
        return new AzureChatCompletionWithDataConfig
        {
            CompletionModelId = TestConfiguration.AzureOpenAI.ChatDeploymentName,
            CompletionEndpoint = TestConfiguration.AzureOpenAI.Endpoint,
            CompletionApiKey = TestConfiguration.AzureOpenAI.ApiKey,
            DataSourceEndpoint = TestConfiguration.ACS.Endpoint,
            DataSourceApiKey = TestConfiguration.ACS.ApiKey,
            DataSourceIndex = TestConfiguration.ACS.IndexName
        };
    }
}