Merge pull request #106 from dmytrostruk/update-process-framework-starter

Added more Process Framework starter projects

Author: dmytrostruk

sk-process-framework/declarative/ProductDocumentation/README.md

@@ -0,0 +1,39 @@
+# Process Framework: Product Documentation declarative example
+
+This project example demonstrates how to define, preview, and execute a process of generating product documentation using declarative AI Agents as process steps.
+
+Note: it is recommended to work with this example using [Semantic Kernel Tools](https://marketplace.visualstudio.com/items?itemName=ms-semantic-kernel.semantic-kernel) VS Code extension.
+
+## Getting Started
+
+1. Open the [product-documentation.process.yaml](./product-documentation.process.yaml) file in VS Code to start working with processes.
+
+## Features
+
+### Select an AI Model
+
+To select an AI model:
+- Open the Semantic Kernel extension in the side panel of Visual Studio Code.
+- In the "AI Endpoints" section, choose your preferred AI provider and model.
+
+![Select AI Model](images/select-model.jpeg)
+
+### Preview a Process
+
+To preview a process:
+- Open the [product-documentation.process.yaml](./product-documentation.process.yaml) file.
+- Click the **Preview Process** button in the top bar of the process file.
+
+![Preview Process](images/preview-process.jpeg)
+
+### Debug a Process
+
+To debug a process:
+- Open the [product-documentation.process.yaml](./product-documentation.process.yaml) file.
+- Click the **Debug Process** button in the top bar of the process file.
+
+![Debug Process](images/debug-process.jpeg)
+
+## Reporting Issues
+
+If you encounter any issues or have suggestions, please report them on our [GitHub repository](https://github.com/microsoft/semantic-kernel).

sk-process-framework/declarative/ProductDocumentation/images/debug-process.jpeg

@@ -0,0 +1,46 @@
+workflow:
+  id: ProductDocumentation
+  inputs:
+    events:
+      cloud_events:
+        - type: input_message_received
+          data_schema: 
+            type: string
+  nodes:
+    - id: ProductDocumentationAgent
+      type: declarative
+      description: Generates an information about the product
+      agent: 
+        type: chat_completion_agent 
+        name: ProductDocumentationAgent 
+        description: Generates an information about the product
+        instructions: Generate a short information about coffee machine product. 
+      on_complete:
+        - on_condition:
+            type: default
+            emits:
+              - event_type: GeneratedInformation.OnResult
+    - id: SummarizationAgent
+      type: declarative
+      description: Summarizes the provided information
+      agent: 
+        type: chat_completion_agent 
+        name: SummarizationAgent 
+        description: Summarizes the provided information
+        instructions: Summarize the provided information in 3 sentences. 
+      on_complete:
+        - on_condition:
+            type: default
+            emits:
+              - event_type: ProcessCompleted
+  orchestration:
+    - listen_for:
+        event: input_message_received
+        from: _workflow_
+      then:
+        - node: ProductDocumentationAgent
+    - listen_for:
+        event: GeneratedInformation.OnResult
+        from: ProductDocumentationAgent
+      then:
+        - node: SummarizationAgent

sk-process-framework/declarative/ProductDocumentation/images/preview-process.jpeg

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.SemanticKernel.Process.Core" Version="1.47.0-alpha" />
+    <PackageReference Include="Microsoft.SemanticKernel.Process.Core" Version="1.51.0-alpha" />
   </ItemGroup>
 
 </Project>

sk-process-framework/declarative/ProductDocumentation/images/select-model.jpeg

@@ -1,6 +1,6 @@
-# Process Framework: Product Documentation application example
+# Process Framework: Product Documentation .NET example
 
-This project example demonstrates how to define, preview, and execute a process of generating product documentation.
+This project example demonstrates how to define, preview, and execute a process of generating product documentation using .NET classes as process steps.
 
 Note: it is recommended to work with this example using [Semantic Kernel Tools](https://marketplace.visualstudio.com/items?itemName=ms-semantic-kernel.semantic-kernel) VS Code extension.
 
@@ -19,6 +19,14 @@ Note: it is recommended to work with this example using [Semantic Kernel Tools](
 
 ## Features
 
+### Select an AI Model
+
+To select an AI model:
+- Open the Semantic Kernel extension in the side panel of Visual Studio Code.
+- In the "AI Endpoints" section, choose your preferred AI provider and model.
+
+![Select AI Model](images/select-model.jpeg)
+
 ### Preview a Process
 
 To preview a process:
@@ -27,13 +35,13 @@ To preview a process:
 
 ![Preview Process](images/preview-process.jpeg)
 
-### Execute a Process
+### Debug a Process
 
-To execute a process:
+To debug a process:
 - Open the [product-documentation.process.yaml](./product-documentation.process.yaml) file.
-- Click the **Execute Process** button in the top bar of the process file.
+- Click the **Debug Process** button in the top bar of the process file.
 
-![Execute Process](images/execute-process.jpeg)
+![Debug Process](images/debug-process.jpeg)
 
 ### Process Node Logic
 

sk-process-framework/declarative/ProductDocumentation/product-documentation.process.yaml

@@ -24,7 +24,7 @@ public override ValueTask ActivateAsync(KernelProcessStepState<GeneratedDocument
     }
 
     [KernelFunction]
-    public async Task<string?> GenerateDocumentationAsync(Kernel kernel, KernelProcessStepContext context, string productInfo)
+    public async Task<string?> GenerateDocumentationAsync(Kernel kernel, string productInfo)
     {
         // Add the new product info to the chat history
         this._state.ChatHistory!.AddUserMessage($"Product Info:\n\n{productInfo}");
@@ -35,8 +35,6 @@ public override ValueTask ActivateAsync(KernelProcessStepState<GeneratedDocument
 
         var documentationString = generatedDocumentationResponse.Content!.ToString();
 
-        await context.EmitEventAsync("DocumentationGenerated", documentationString);
-
         return documentationString;
     }
 }