Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmedbham committed May 1, 2023
2 parents 99f51b9 + 776a2b0 commit 66fa531
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/modules/Module3/bookcreatorflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Book Creator detailed flow
parent: Module 3 - Semantic Kernel
has_children: false
nav_order: 3
---

## Module 3: Book Creator application detailed flow

The following sequence diagram illustrates the interactions of the Book creator Client app and the Semantic Kernel API exposed via the dotnet C# function.


The function API exposes only 2 endpoints

- /skills/{skillName}/invoke/{functionName}

- /planner/execute/{maxSteps}


![Semantic Kernel Use cases](../../assets/images/module3/book-creator-sequence.png)

1. The childrensBookSkill is a predefined skill that with a templated prompt that can be found in the samples/skills folder, a skill may have one to many sub-skills or functions.
2. The planner skill is also a specialized skill that can leverage additional skills, embeddings and connectors.
3. The planner execute API used the templated values of the previous steps/instructions from the planner to fulfill the user's Ask.
6 changes: 3 additions & 3 deletions docs/modules/Module3/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ nav_order: 1

## What is Semantic Kernel?

Semantic Kernel is an Open source, Lightweight SDK that allows you to easily integrate Large Language Models (LLMs) like ChatGPT into your applications.
Semantic Kernel (SK) is an Open source, Lightweight SDK that allows you to easily integrate Large Language Models (LLMs) like ChatGPT into your application.

SK provides the developer with controls over AI LLM constructs such as prompts, embeddings and allows you to provide rich context to your application specific use cases that you would not have by just using OpenAI/Azure OpenAI APIs.
Semantic Kernel provides the developer with controls over AI LLM constructs such as prompts, embeddings and allows you to provide rich context to your application specific use cases that you would otherwise not have by just using OpenAI/Azure OpenAI APIs.

## Why is Semantic Kernel needed?

Expand All @@ -28,7 +28,7 @@ SK provides the developer with controls over AI LLM constructs such as prompts,

## Semantic Kernel - building blocks

- Planner - The planner is responsible for fulfilling a specific ASK, the planner has access to a pre-defined library of pre-made skills and can also call upon memories to best situate the ASK's context and connectors to call APIs and to leverage other external capabilities if needed.
- Planner - The planner is responsible for fulfilling a specific user ASK, the planner has access to a pre-defined library of pre-made skills and can also call upon memories to best situate the ASK's context and connectors to call APIs and to leverage other external capabilities if needed.

- Memories – Also referred to as Embeddings and provides ability to provide specific context to an ASK or Prompt.

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/Module3/lab-module3.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ has_children: false
nav_order: 2
---

# Module 3: Lab - Book Creator application
## Module 3: Lab - Book Creator application

The Book creator sample application shows how `planner`, `skills` and `memories` are used to enrich content for a specific use case and allows you to enter in a children's book topic. Then the `Planner` creates a plan for the functions (skills) to run based on the Ask. You can see the execution plan along with the results. The `Writer` Skill functions are chained together based on the user ask.

Expand Down

0 comments on commit 66fa531

Please sign in to comment.