Postupy: Vytvoření prvního procesu

Varování

sémantická architektura procesu jádra je experimentální, stále ve vývoji a může se změnit.

Přehled

Sémantická architektura procesu jádra je výkonná sada SDK pro orchestraci navržená tak, aby zjednodušila vývoj a provádění integrovaných procesů AI. Bez ohledu na to, jestli spravujete jednoduché pracovní postupy nebo složité systémy, vám tato architektura umožňuje definovat řadu kroků, které se dají spouštět strukturovaným způsobem, což zvyšuje možnosti vaší aplikace s lehkostí a flexibilitou.

Architektura Proces Frameworku je vytvořená pro rozšiřitelnost a podporuje různé provozní vzory, jako je postupné spouštění, paralelní zpracování, konfigurace sběrnice, konfigurace rozbočení a dokonce strategie mapování a redukce. Tato adaptabilnost je vhodná pro řadu reálných aplikací, zejména těch, které vyžadují inteligentní rozhodování a vícekrokové pracovní postupy.

Začínáme

Sémantická architektura procesu jádra se dá použít k infusování umělé inteligence do jakéhokoli obchodního procesu, o který si můžete myslet. Jako ilustrativní příklad, jak začít, se podíváme na vytvoření procesu generování dokumentace pro nový produkt.

Než začneme, ujistěte se, že máte nainstalované požadované balíčky sémantického jádra:

// 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

Ilustrativní příklad: Generování dokumentace pro nový produkt

V tomto příkladu použijeme sémantickou architekturu procesu jádra k vývoji automatizovaného procesu pro vytváření dokumentace pro nový produkt. Tento proces začne jednoduchý a bude se vyvíjet, jakmile probereme realističtější scénáře.

Začneme modelováním procesu dokumentace pomocí velmi základního toku:

1. GatherProductInfoStep: Shromážděte informace o produktu.
2. GenerateDocumentationStep: Požádejte LLM o vygenerování dokumentace z informací shromážděných v kroku 1.
3. PublishDocumentationStep: Publikujte dokumentaci.

Když teď rozumíme našim procesům, pojďme ho sestavit.

Definování kroků procesu

Každý krok procesu je definován třídou, která dědí z naší základní třídy kroku. Pro tento proces máme tři kroky:

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;
}

Výše uvedený kód definuje tři kroky, které potřebujeme pro náš proces. Tady je několik bodů:

• V rámci sémantického jádra definuje KernelFunction blok kódu, který může být vyvolán nativním kódem nebo velkým jazykovým modelem (LLM). V případě procesu jsou KernelFunctions vyvolatelnými členy kroku a každý krok vyžaduje, aby bylo definováno alespoň jedno KernelFunction.
• Procesní architektura podporuje bezstavové a stavové kroky. Stavové kroky automaticky zaznamenávají svůj průběh a udržují stav během více vyvolání. GenerateDocumentationStep poskytuje příklad, kde se třída GeneratedDocumentationState používá k uchování objektů ChatHistory a LastGeneratedDocument.
• Kroky mohou ručně generovat události voláním EmitEventAsync v objektu KernelProcessStepContext. Pokud chcete získat instanci KernelProcessStepContext stačí ji přidat jako parametr na kernelFunction a architektura ji automaticky vloží.

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

Výše uvedený kód definuje tři kroky, které potřebujeme pro náš proces. Tady je několik bodů:

• V rámci sémantického jádra definuje KernelFunction blok kódu, který může být vyvolán nativním kódem nebo velkým jazykovým modelem (LLM). V případě procesu jsou KernelFunctions vyvolatelnými členy kroku a každý krok vyžaduje, aby bylo definováno alespoň jedno KernelFunction.
• Procesní architektura podporuje bezstavové a stavové kroky. Stavové kroky automaticky zaznamenávají svůj průběh a udržují stav během více vyvolání. GenerateDocumentationStep poskytuje příklad, kde GeneratedDocumentationState třída slouží k zachování objektu ChatHistory.
• Kroky mohou ručně generovat události voláním emit_event v objektu KernelProcessStepContext. Pokud chcete získat instanci KernelProcessStepContext stačí ji přidat jako parametr na kernelFunction a architektura ji automaticky vloží.

Definování toku procesu

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

Tady se děje několik věcí, takže ho rozebereme krok za krokem.

1. Vytvořit stavitel: Procesy používají vzor stavitele ke zjednodušení propojení všech prvků. Tvůrce poskytuje metody pro správu kroků v rámci procesu a pro správu životního cyklu procesu.

2. Přidejte kroky: Kroky jsou přidány do procesu voláním metody AddStepFromType sestavovatele. To umožňuje rozhraní Process Framework spravovat životní cyklus kroků vytvořením instance podle potřeby. V tomto případě jsme do procesu přidali tři kroky a pro každý z nich jsme vytvořili proměnnou. Tyto proměnné nám poskytují přístup k jedinečné instanci každého kroku, kterou můžeme následně použít k definování koordinace událostí.

3. Orchestrace událostí: Tady se definuje směrování událostí z kroku do kroku. V tomto případě máme následující trasy:

   • Když se do procesu odešle externí událost s id = Start, tato událost a přidružená data se odešlou do infoGatheringStep kroku.
   • Když infoGatheringStep dokončí běh, odešlete vrácený objekt do kroku docsGenerationStep.
   • Nakonec, když docsGenerationStep dokončí spuštění, odešle vrácený objekt do kroku docsPublishStep.

Spropitné

směrování událostí v rámci procesního rozhraní: Možná vás zajímá, jak se události odesílané do kroků směrují do KernelFunctions v rámci kroku. Ve výše uvedeném kódu každý krok definoval pouze jeden KernelFunction a každý KernelFunction má pouze jeden parametr (jiný než Jádro a kontext kroku, které jsou speciální, více o tom později). Když se do docsPublishStep odešle událost obsahující vygenerovanou dokumentaci, bude předána jako parametr document do KernelFunction PublishDocumentation kroku docsGenerationStep, protože jiná možnost není. Kroky ale můžou mít více funkcí Jádra a KernelFunctions můžou mít více parametrů, v těchto pokročilých scénářích je potřeba zadat cílovou funkci a parametr.

# 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()

Tady se děje několik věcí, takže ho rozebereme krok za krokem.

1. Vytvořit stavitel: Procesy používají vzor stavitele ke zjednodušení propojení všech prvků. Tvůrce poskytuje metody pro správu kroků v rámci procesu a pro správu životního cyklu procesu.

2. Přidejte kroky: Kroky jsou přidány do procesu voláním add_step metody tvůrce, která přidá typ kroku do tvůrce. To umožňuje rozhraní Process Framework spravovat životní cyklus kroků vytvořením instance podle potřeby. V tomto případě jsme do procesu přidali tři kroky a pro každý z nich jsme vytvořili proměnnou. Tyto proměnné nám poskytují přístup k jedinečné instanci každého kroku, kterou můžeme následně použít k definování koordinace událostí.

3. Orchestrace událostí: Tady se definuje směrování událostí z kroku do kroku. V tomto případě máme následující trasy:

   • Když je do procesu odeslána externí událost s id = Start, tato událost a její přidružená data budou odeslána do info_gathering_step.
   • info_gathering_step Po dokončení spuštění odešle vrácený objekt do objektu docs_generation_step.
   • Nakonec po docs_generation_step dokončení spuštění odešle vrácený objekt do objektu docs_publish_step.

Spropitné

směrování událostí v rámci procesního rozhraní: Možná vás zajímá, jak se události odesílané do kroků směrují do KernelFunctions v rámci kroku. Ve výše uvedeném kódu každý krok definoval pouze jeden KernelFunction a každý KernelFunction má pouze jeden parametr (jiný než Jádro a kontext kroku, které jsou speciální, více o tom později). Pokud je událost obsahující vygenerovanou dokumentaci odeslána do docs_publish_step, bude předána parametru docs funkce KernelFunction publish_documentation, protože není jiná možnost. Kroky ale můžou mít více funkcí Jádra a KernelFunctions můžou mít více parametrů, v těchto pokročilých scénářích je potřeba zadat cílovou funkci a parametr.

Sestavení a spuštění procesu

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

Proces sestavíme a použijeme StartAsync ke spuštění. Náš proces očekává počáteční externí událost nazvanou Start ke spuštění procesu, a proto ji také poskytujeme. Spuštěním tohoto procesu se v konzole zobrazí následující výstup:

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()

Proces sestavíme a zavoláme start pomocí asynchronního správce kontextu, který ho spustí. Náš proces očekává počáteční externí událost nazvanou Start ke spuštění procesu, a proto ji také poskytujeme. Spuštěním tohoto procesu se v konzole zobrazí následující výstup:

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.

Co dál?

Náš první návrh procesu generování dokumentace funguje, ale ještě je co zlepšovat. Minimálně produkční verze by potřebovala:

• Agent pro kontrolu pravopisu, který vyhodnotí vygenerovanou dokumentaci a ověří, že splňuje naše standardy kvality a přesnosti.
• Proces schvalování, kdy je dokumentace zveřejněna až po schválení člověkem (člověk v procesu rozhodování).

Přidejte pravopisného asistenta do našeho procesu...