Condividi tramite

Procedura: Creare il primo processo

Avvertimento

Il Semantic Kernel Process Framework è sperimentale, ancora in sviluppo e soggetto a modifiche.

Panoramica

Semantic Kernel Process Framework è un POTENTE SDK di orchestrazione progettato per semplificare lo sviluppo e l'esecuzione di processi integrati con intelligenza artificiale. Sia che si gestiscono flussi di lavoro semplici o sistemi complessi, questo framework consente di definire una serie di passaggi che possono essere eseguiti in modo strutturato, migliorando le funzionalità dell'applicazione con facilità e flessibilità.

Progettato per l'estendibilità, Process Framework supporta modelli operativi diversi, ad esempio l'esecuzione sequenziale, l'elaborazione parallela, le configurazioni fan-in e fan-out e persino strategie map-reduce. Questa adattabilità lo rende adatto a un'ampia gamma di applicazioni reali, in particolare quelle che richiedono flussi di lavoro intelligenti e in più passaggi.

Iniziare

Il framework del processo del kernel semantico può essere usato per integrare l'intelligenza artificiale in quasi qualsiasi processo aziendale che si possa immaginare. Come esempio illustrativo per iniziare, si esaminerà la creazione di un processo per generare la documentazione per un nuovo prodotto.

Prima di iniziare, assicurarsi di avere installato i pacchetti semantic kernel necessari:

// Install the Semantic Kernel Process Framework Local Runtime package
dotnet add package Microsoft.SemanticKernel.Process.LocalRuntime --version 1.46.0-alpha
// or
// Install the Semantic Kernel Process Framework Dapr Runtime package
dotnet add package Microsoft.SemanticKernel.Process.Runtime.Dapr --version 1.46.0-alpha

pip install semantic-kernel==1.20.0

Esempio illustrativo: generazione di documentazione per un nuovo prodotto

In questo esempio si utilizzerà il framework del processo del kernel semantico per sviluppare un processo automatizzato per la creazione della documentazione per un nuovo prodotto. Questo processo inizierà in modo semplice e si evolverà man mano che si tratta di scenari più realistici.

Si inizierà modellando il processo di documentazione con un flusso molto semplice:

  1. GatherProductInfoStep: raccogliere informazioni sul prodotto.
  2. GenerateDocumentationStep: chiedere a un LLM di generare la documentazione dalle informazioni raccolte nel passaggio 1.
  3. PublishDocumentationStep: pubblicare la documentazione.

Diagramma di flusso del nostro primo processo: A[Richiesta di documentazione sulle funzionalità] --> B[Chiedi a LLM di scrivere la documentazione] --> C[Pubblica la documentazione al pubblico]

Dopo aver compreso i processi, è possibile crearlo.

Definire i passaggi del processo

Ogni passaggio di un processo viene definito da una classe che eredita dalla classe del passaggio di base. Per questo processo sono disponibili tre passaggi:

using Microsoft.SemanticKernel.ChatCompletion;
using Microsoft.SemanticKernel;

// A process step to gather information about a product
public class GatherProductInfoStep: KernelProcessStep
{
    [KernelFunction]
    public string GatherProductInformation(string productName)
    {
        Console.WriteLine($"{nameof(GatherProductInfoStep)}:\n\tGathering product information for product named {productName}");

        // For example purposes we just return some fictional information.
        return
            """
            Product Description:
            GlowBrew is a revolutionary AI driven coffee machine with industry leading number of LEDs and programmable light shows. The machine is also capable of brewing coffee and has a built in grinder.

            Product Features:
            1. **Luminous Brew Technology**: Customize your morning ambiance with programmable LED lights that sync with your brewing process.
            2. **AI Taste Assistant**: Learns your taste preferences over time and suggests new brew combinations to explore.
            3. **Gourmet Aroma Diffusion**: Built-in aroma diffusers enhance your coffee's scent profile, energizing your senses before the first sip.

            Troubleshooting:
            - **Issue**: LED Lights Malfunctioning
                - **Solution**: Reset the lighting settings via the app. Ensure the LED connections inside the GlowBrew are secure. Perform a factory reset if necessary.
            """;
    }
}

// A process step to generate documentation for a product
public class GenerateDocumentationStep : KernelProcessStep<GeneratedDocumentationState>
{
    private GeneratedDocumentationState _state = new();

    private string systemPrompt =
            """
            Your job is to write high quality and engaging customer facing documentation for a new product from Contoso. You will be provide with information
            about the product in the form of internal documentation, specs, and troubleshooting guides and you must use this information and
            nothing else to generate the documentation. If suggestions are provided on the documentation you create, take the suggestions into account and
            rewrite the documentation. Make sure the product sounds amazing.
            """;

    // Called by the process runtime when the step instance is activated. Use this to load state that may be persisted from previous activations.
    override public ValueTask ActivateAsync(KernelProcessStepState<GeneratedDocumentationState> state)
    {
        this._state = state.State!;
        this._state.ChatHistory ??= new ChatHistory(systemPrompt);

        return base.ActivateAsync(state);
    }

    [KernelFunction]
    public async Task GenerateDocumentationAsync(Kernel kernel, KernelProcessStepContext context, string productInfo)
    {
        Console.WriteLine($"[{nameof(GenerateDocumentationStep)}]:\tGenerating documentation for provided productInfo...");

        // Add the new product info to the chat history
        this._state.ChatHistory!.AddUserMessage($"Product Info:\n{productInfo.Title} - {productInfo.Content}");

        // Get a response from the LLM
        IChatCompletionService chatCompletionService = kernel.GetRequiredService<IChatCompletionService>();
        var generatedDocumentationResponse = await chatCompletionService.GetChatMessageContentAsync(this._state.ChatHistory!);

        DocumentInfo generatedContent = new()
        {
            Id = Guid.NewGuid().ToString(),
            Title = $"Generated document - {productInfo.Title}",
            Content = generatedDocumentationResponse.Content!,
        };

        this._state!.LastGeneratedDocument = generatedContent;

        await context.EmitEventAsync("DocumentationGenerated", generatedContent);
    }

    public class GeneratedDocumentationState
    {
        public DocumentInfo LastGeneratedDocument { get; set; } = new();
        public ChatHistory? ChatHistory { get; set; }
    }
}

// A process step to publish documentation
public class PublishDocumentationStep : KernelProcessStep
{
    [KernelFunction]
    public DocumentInfo PublishDocumentation(DocumentInfo document)
    {
        // For example purposes we just write the generated docs to the console
        Console.WriteLine($"[{nameof(PublishDocumentationStep)}]:\tPublishing product documentation approved by user: \n{document.Title}\n{document.Content}");
        return document;
    }
}

// Custom classes must be serializable
public class DocumentInfo
{
    public string Id { get; set; } = string.Empty;
    public string Title { get; set; } = string.Empty;
    public string Content { get; set; } = string.Empty;
}

Il codice precedente definisce i tre passaggi necessari per il processo. Ci sono alcuni punti da evidenziare qui:

  • In Kernel semantico un KernelFunction definisce un blocco di codice che è chiamabile dal codice nativo o da un LLM. Nel caso del framework di elaborazione, KernelFunctionsono i membri chiamabili di un passaggio e ogni passaggio richiede almeno una KernelFunction da definire.
  • Il Framework di Processi include il supporto per le fasi senza stato e con stato. I passaggi con stato registrano automaticamente i progressi e mantengono lo stato attraverso più chiamate. GenerateDocumentationStep fornisce un esempio di questo in cui la classe GeneratedDocumentationState viene usata per conservare gli oggetti ChatHistory e LastGeneratedDocument.
  • I passaggi possono generare manualmente eventi invocando EmitEventAsync sull'oggetto KernelProcessStepContext. Per ottenere un'istanza di KernelProcessStepContext aggiungerla semplicemente come parametro in KernelFunction e il framework lo inserisce automaticamente.
import asyncio
from typing import ClassVar

from pydantic import BaseModel, Field

from semantic_kernel import Kernel
from semantic_kernel.connectors.ai.chat_completion_client_base import ChatCompletionClientBase
from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion
from semantic_kernel.contents import ChatHistory
from semantic_kernel.functions import kernel_function
from semantic_kernel.processes import ProcessBuilder
from semantic_kernel.processes.kernel_process import KernelProcessStep, KernelProcessStepContext, KernelProcessStepState
from semantic_kernel.processes.local_runtime import KernelProcessEvent, start


# A process step to gather information about a product
class GatherProductInfoStep(KernelProcessStep):
    @kernel_function
    def gather_product_information(self, product_name: str) -> str:
        print(f"{GatherProductInfoStep.__name__}\n\t Gathering product information for Product Name: {product_name}")

        return """
Product Description:

GlowBrew is a revolutionary AI driven coffee machine with industry leading number of LEDs and 
programmable light shows. The machine is also capable of brewing coffee and has a built in grinder.

Product Features:
1. **Luminous Brew Technology**: Customize your morning ambiance with programmable LED lights that sync 
    with your brewing process.
2. **AI Taste Assistant**: Learns your taste preferences over time and suggests new brew combinations 
    to explore.
3. **Gourmet Aroma Diffusion**: Built-in aroma diffusers enhance your coffee's scent profile, energizing 
    your senses before the first sip.

Troubleshooting:
- **Issue**: LED Lights Malfunctioning
    - **Solution**: Reset the lighting settings via the app. Ensure the LED connections inside the 
        GlowBrew are secure. Perform a factory reset if necessary.
        """


# A sample step state model for the GenerateDocumentationStep
class GeneratedDocumentationState(BaseModel):
    """State for the GenerateDocumentationStep."""

    chat_history: ChatHistory | None = None


# A process step to generate documentation for a product
class GenerateDocumentationStep(KernelProcessStep[GeneratedDocumentationState]):
    state: GeneratedDocumentationState = Field(default_factory=GeneratedDocumentationState)

    system_prompt: ClassVar[str] = """
Your job is to write high quality and engaging customer facing documentation for a new product from Contoso. You will 
be provided with information about the product in the form of internal documentation, specs, and troubleshooting guides 
and you must use this information and nothing else to generate the documentation. If suggestions are provided on the 
documentation you create, take the suggestions into account and rewrite the documentation. Make sure the product 
sounds amazing.
"""

    async def activate(self, state: KernelProcessStepState[GeneratedDocumentationState]):
        self.state = state.state
        if self.state.chat_history is None:
            self.state.chat_history = ChatHistory(system_message=self.system_prompt)
        self.state.chat_history

    @kernel_function
    async def generate_documentation(
        self, context: KernelProcessStepContext, product_info: str, kernel: Kernel
    ) -> None:
        print(f"{GenerateDocumentationStep.__name__}\n\t Generating documentation for provided product_info...")

        self.state.chat_history.add_user_message(f"Product Information:\n{product_info}")

        chat_service, settings = kernel.select_ai_service(type=ChatCompletionClientBase)
        assert isinstance(chat_service, ChatCompletionClientBase)  # nosec

        response = await chat_service.get_chat_message_content(chat_history=self.state.chat_history, settings=settings)

        await context.emit_event(process_event="documentation_generated", data=str(response))


# A process step to publish documentation
class PublishDocumentationStep(KernelProcessStep):
    @kernel_function
    async def publish_documentation(self, docs: str) -> None:
        print(f"{PublishDocumentationStep.__name__}\n\t Publishing product documentation:\n\n{docs}")

Il codice precedente definisce i tre passaggi necessari per il processo. Ci sono alcuni punti da evidenziare qui:

  • In Kernel semantico un KernelFunction definisce un blocco di codice che è chiamabile dal codice nativo o da un LLM. Nel caso del framework di elaborazione, KernelFunctionsono i membri chiamabili di un passaggio e ogni passaggio richiede almeno una KernelFunction da definire.
  • Il Framework di Processi include il supporto per le fasi senza stato e con stato. I passaggi con stato registrano automaticamente i progressi e mantengono lo stato attraverso più chiamate. Il GenerateDocumentationStep fornisce un esempio di questo oggetto in cui viene usata la classe GeneratedDocumentationState per rendere persistente l'oggetto ChatHistory.
  • I passaggi possono generare manualmente eventi invocando emit_event sull'oggetto KernelProcessStepContext. Per ottenere un'istanza di KernelProcessStepContext aggiungerla semplicemente come parametro in KernelFunction e il framework lo inserisce automaticamente.

Definire il flusso di processo

// Create the process builder
ProcessBuilder processBuilder = new("DocumentationGeneration");

// Add the steps
var infoGatheringStep = processBuilder.AddStepFromType<GatherProductInfoStep>();
var docsGenerationStep = processBuilder.AddStepFromType<GenerateDocumentationStep>();
var docsPublishStep = processBuilder.AddStepFromType<PublishDocumentationStep>();

// Orchestrate the events
processBuilder
    .OnInputEvent("Start")
    .SendEventTo(new(infoGatheringStep));

infoGatheringStep
    .OnFunctionResult()
    .SendEventTo(new(docsGenerationStep));

docsGenerationStep
    .OnFunctionResult()
    .SendEventTo(new(docsPublishStep));

Ci sono alcune cose in corso qui, quindi analizziamolo passo dopo passo.

  1. Creare il generatore: i processi usano un modello di generatore per semplificare il cablaggio di tutto. Il costruttore fornisce metodi per la gestione delle fasi all'interno di un processo e per la gestione del ciclo di vita del processo.

  2. Aggiungere i passaggi: i passaggi vengono aggiunti al processo chiamando il metodo AddStepFromType del generatore. Ciò consente a Process Framework di gestire il ciclo di vita dei passaggi creando istanze in base alle esigenze. In questo caso sono stati aggiunti tre passaggi al processo e sono stati creati una variabile per ognuno di essi. Queste variabili ci forniscono un accesso all'istanza univoca di ciascuna fase, che possiamo utilizzare per definire l'orchestrazione degli eventi.

  3. Orchestrare gli eventi: qui viene definito il routing degli eventi di ciascun passaggio. In questo caso sono disponibili le route seguenti:

    • Quando un evento esterno con id = Start viene inviato al processo, questo evento e i relativi dati associati verranno inviati al passaggio infoGatheringStep.
    • Al termine dell'esecuzione di infoGatheringStep, invia l'oggetto restituito al passaggio docsGenerationStep.
    • Infine, al termine dell'esecuzione del docsGenerationStep, inviare l'oggetto restituito al passaggio docsPublishStep.

Consiglio

Routing degli eventi nel Process Framework: Potresti chiederti come vengono indirizzati gli eventi inviati alle fasi a KernelFunctions all'interno della fase. Nel codice precedente, ogni passaggio ha definito solo un singolo KernelFunction e ogni KernelFunction ha un solo parametro (diverso da Kernel e il contesto del passaggio che sono speciali, più avanti). Quando l'evento contenente la documentazione generata viene inviato al docsPublishStep verrà passato al parametro document della PublishDocumentation KernelFunction del passaggio docsGenerationStep perché non esiste alcuna altra scelta. Tuttavia, i passaggi possono avere più KernelFunctions e KernelFunctions possono avere più parametri, in questi scenari avanzati è necessario specificare la funzione e il parametro di destinazione.

# Create the process builder
process_builder = ProcessBuilder(name="DocumentationGeneration")

# Add the steps
info_gathering_step = process_builder.add_step(GatherProductInfoStep)
docs_generation_step = process_builder.add_step(GenerateDocumentationStep)
docs_publish_step = process_builder.add_step(PublishDocumentationStep)

# Orchestrate the events
process_builder.on_input_event("Start").send_event_to(target=info_gathering_step)

info_gathering_step.on_function_result().send_event_to(
    target=docs_generation_step, function_name="generate_documentation", parameter_name="product_info"
)

docs_generation_step.on_event("documentation_generated").send_event_to(target=docs_publish_step)

# Configure the kernel with an AI Service and connection details, if necessary
kernel = Kernel()
kernel.add_service(AzureChatCompletion())

# Build the process
kernel_process = process_builder.build()

Ci sono alcune cose in corso qui, quindi analizziamolo passo dopo passo.

  1. Creare il generatore: i processi usano un modello di generatore per semplificare il cablaggio di tutto. Il costruttore fornisce metodi per la gestione delle fasi all'interno di un processo e per la gestione del ciclo di vita del processo.

  2. Aggiungere i passaggi: i passaggi vengono aggiunti al processo chiamando il add_step metodo del generatore, che aggiunge il tipo di passaggio al generatore. Ciò consente a Process Framework di gestire il ciclo di vita dei passaggi creando istanze in base alle esigenze. In questo caso sono stati aggiunti tre passaggi al processo e sono stati creati una variabile per ognuno di essi. Queste variabili ci forniscono un accesso all'istanza univoca di ciascuna fase, che possiamo utilizzare per definire l'orchestrazione degli eventi.

  3. Orchestrare gli eventi: qui viene definito il routing degli eventi di ciascun passaggio. In questo caso sono disponibili le route seguenti:

    • Quando un evento esterno con id = Start viene inviato al processo, questo evento e i relativi dati associati verranno inviati all'oggetto info_gathering_step.
    • Al termine dell'esecuzione info_gathering_step, invia l'oggetto restituito a docs_generation_step.
    • Infine, al termine dell'esecuzione di docs_generation_step, inviare l'oggetto restituito a docs_publish_step.

Consiglio

Routing degli eventi nel Process Framework: Potresti chiederti come vengono indirizzati gli eventi inviati alle fasi a KernelFunctions all'interno della fase. Nel codice precedente, ogni passaggio ha definito solo un singolo KernelFunction e ogni KernelFunction ha un solo parametro (diverso da Kernel e il contesto del passaggio che sono speciali, più avanti). Quando l'evento contenente la documentazione generata viene inviato a docs_publish_step, verrà passato nel parametro docs della KernelFunction publish_documentation di docs_generation_step perché non esiste un'altra scelta. Tuttavia, i passaggi possono avere più KernelFunctions e KernelFunctions possono avere più parametri, in questi scenari avanzati è necessario specificare la funzione e il parametro di destinazione.

Compilare ed eseguire il processo

// Configure the kernel with your LLM connection details
Kernel kernel = Kernel.CreateBuilder()
    .AddAzureOpenAIChatCompletion("myDeployment", "myEndpoint", "myApiKey")
    .Build();

// Build and run the process
var process = processBuilder.Build();
await process.StartAsync(kernel, new KernelProcessEvent { Id = "Start", Data = "Contoso GlowBrew" });

Costruiamo il processo e chiamiamo StartAsync per eseguirlo. Il processo prevede un evento esterno iniziale denominato Start per avviare le cose e quindi forniamo anche questo. L'esecuzione di questo processo mostra l'output seguente nella console:

GatherProductInfoStep: Gathering product information for product named Contoso GlowBrew
GenerateDocumentationStep: Generating documentation for provided productInfo
PublishDocumentationStep: Publishing product documentation:

# GlowBrew: Your Ultimate Coffee Experience Awaits!

Welcome to the world of GlowBrew, where coffee brewing meets remarkable technology! At Contoso, we believe that your morning ritual shouldn't just include the perfect cup of coffee but also a stunning visual experience that invigorates your senses. Our revolutionary AI-driven coffee machine is designed to transform your kitchen routine into a delightful ceremony.

## Unleash the Power of GlowBrew

### Key Features

- **Luminous Brew Technology**
  - Elevate your coffee experience with our cutting-edge programmable LED lighting. GlowBrew allows you to customize your morning ambiance, creating a symphony of colors that sync seamlessly with your brewing process. Whether you need a vibrant wake-up call or a soothing glow, you can set the mood for any moment!

- **AI Taste Assistant**
  - Your taste buds deserve the best! With the GlowBrew built-in AI taste assistant, the machine learns your unique preferences over time and curates personalized brew suggestions just for you. Expand your coffee horizons and explore delightful new combinations that fit your palate perfectly.

- **Gourmet Aroma Diffusion**
  - Awaken your senses even before that first sip! The GlowBrew comes equipped with gourmet aroma diffusers that enhance the scent profile of your coffee, diffusing rich aromas that fill your kitchen with the warm, inviting essence of freshly-brewed bliss.

### Not Just Coffee - An Experience

With GlowBrew, it's more than just making coffee-it's about creating an experience that invigorates the mind and pleases the senses. The glow of the lights, the aroma wafting through your space, and the exceptional taste meld into a delightful ritual that prepares you for whatever lies ahead.

## Troubleshooting Made Easy

While GlowBrew is designed to provide a seamless experience, we understand that technology can sometimes be tricky. If you encounter issues with the LED lights, we've got you covered:

- **LED Lights Malfunctioning?**
  - If your LED lights aren't working as expected, don't worry! Follow these steps to restore the glow:
    1. **Reset the Lighting Settings**: Use the GlowBrew app to reset the lighting settings.
    2. **Check Connections**: Ensure that the LED connections inside the GlowBrew are secure.
    3. **Factory Reset**: If you're still facing issues, perform a factory reset to rejuvenate your machine.

With GlowBrew, you not only brew the perfect coffee but do so with an ambiance that excites the senses. Your mornings will never be the same!

## Embrace the Future of Coffee

Join the growing community of GlowBrew enthusiasts today, and redefine how you experience coffee. With stunning visual effects, customized brewing suggestions, and aromatic enhancements, it's time to indulge in the delightful world of GlowBrew-where every cup is an adventure!

### Conclusion

Ready to embark on an extraordinary coffee journey? Discover the perfect blend of technology and flavor with Contoso's GlowBrew. Your coffee awaits!

# Configure the kernel with an AI Service and connection details, if necessary
kernel = Kernel()
kernel.add_service(AzureChatCompletion())

# Build the process
kernel_process = process_builder.build()

# Start the process
async with await start(
    process=kernel_process,
    kernel=kernel,
    initial_event=KernelProcessEvent(id="Start", data="Contoso GlowBrew"),
) as process_context:
    _ = await process_context.get_state()

Costruiamo il processo e chiamiamo start con il gestore del contesto asincrono per eseguirlo. Il processo prevede un evento esterno iniziale denominato Start per avviare le cose e quindi forniamo anche questo. L'esecuzione di questo processo mostra l'output seguente nella console:

GatherProductInfoStep
         Gathering product information for Product Name: Contoso GlowBrew
GenerateDocumentationStep
         Generating documentation for provided product_info...
PublishDocumentationStep
         Publishing product documentation:

# GlowBrew AI-Driven Coffee Machine: Elevate Your Coffee Experience

Welcome to the future of coffee enjoyment with GlowBrew, the AI-driven coffee machine that not only crafts the perfect cup but does so with a light show that brightens your day. Designed for coffee enthusiasts and tech aficionados alike, GlowBrew combines cutting-edge brewing technology with an immersive lighting experience to start every day on a bright note.

## Unleash the Power of Luminous Brew Technology

With GlowBrew, your mornings will never be dull. The industry-leading number of programmable LEDs offers endless possibilities for customizing your coffee-making ritual. Sync the light show with the brewing process to create a visually stimulating ambiance that transforms your kitchen into a vibrant café each morning.

## Discover New Flavor Dimensions with the AI Taste Assistant

Leave the traditional coffee routines behind and say hello to personalization sophistication. The AI Taste Assistant learns and adapts to your unique preferences over time. Whether you prefer a strong espresso or a light latte, the assistant suggests new brew combinations tailored to your palate, inviting you to explore a world of flavors you never knew existed.

## Heighten Your Senses with Gourmet Aroma Diffusion

The moment you step into the room, let the GlowBrew’s built-in aroma diffusers captivate your senses. This feature is designed to enrich your coffee’s scent profile, ensuring every cup you brew is a multi-sensory delight. Let the burgeoning aroma energize you before the very first sip.

## Troubleshooting Guide: LED Lights Malfunctioning

Occasionally, you might encounter an issue with the LED lights not functioning as intended. Here’s how to resolve it efficiently:

- **Reset Lighting Settings**: Start by using the GlowBrew app to reset the lighting configurations to their default state.
- **Check Connections**: Ensure that all LED connections inside your GlowBrew machine are secure and properly connected.
- **Perform a Factory Reset**: If the problem persists, perform a factory reset on your GlowBrew to restore all settings to their original state.

Experience the art of coffee making like never before with the GlowBrew AI-driven coffee machine. From captivating light shows to aromatic sensations, every feature is engineered to enhance your daily brew. Brew, savor, and glow with GlowBrew.

Che cos'è avanti?

La prima bozza del processo di generazione della documentazione funziona, ma lascia molto da desiderare. Come minimo, sarebbe necessaria una versione di produzione:

  • Un correttore di bozze che valuterà la documentazione generata e verificherà che soddisfi i nostri standard di qualità e accuratezza.
  • Processo di approvazione in cui la documentazione viene pubblicata solo dopo l'approvazione di un essere umano (human-in-the-loop).

Aggiungere un correttore di bozze al nostro processo