-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Solved Issue 25: Update Semantic Kernel documentation (#49)
* Initial documents update. * Properly reorder pages to match current deployment. * Improved content. * Added description for the available plugins. * Added missing tags to `Financial Product Comparer Plugin`
- Loading branch information
Showing
13 changed files
with
75 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Concepts | ||
weight: 4 | ||
weight: 5 | ||
description: > | ||
Understand the core components of the solution: Azure Open AI, Azure Cognitive Search, Content Safety and more. | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: Contribution Guidelines | ||
weight: 6 | ||
weight: 7 | ||
description: How to contribute to the project | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: OpenAI Plugins | ||
description: AI Hub — OpenAI plugins examples. | ||
weight: 3 | ||
--- | ||
|
||
OpenAI Plugins are powerful tools that connect systems (like ChatGPT) to third-party applications. Think of a plugin like a new skill you teach to your phone or computer. It’s a mini-program that lets your software do something new, like asking a chatbot questions. These plugins enable AI applications powered by LLMs to interact with APIs defined by developers, enhancing their capabilities and allowing it to perform a wide range of actions beyond the training of the inherent AI model. | ||
|
||
On the other hand, Microsoft’s Semantic Kernel is an open-source SDK that lets you easily build AI-related projects, especially OpenAI plugins. It provides the following features: | ||
|
||
1. **Interoperability**: Semantic Kernel has adopted the OpenAI plugin specification as the standard for plugins. This creates an ecosystem of interoperable plugins that can be used across all major AI apps and services like ChatGPT, Bing, and Microsoft 365. Any plugins you build with Semantic Kernel can be exported, so they are usable in these platforms. | ||
|
||
2. **Importing Plugins**: Semantic Kernel makes it easy to import plugins defined with an OpenAI specification. Your code can use Semantic Kernel to leverage these plugins into your application. | ||
|
||
3. **Native and Prompts Functions**: In any plugin, you can create two types of functions: prompts and native functions. With native functions, you can use C# or Python code to directly build features to manipulate data or perform other operations beyond the capabilities of an LLM; and with prompts, you can create reusable semantic instructions for a wide variaety of LLMs, not just OpenAI, with templates to handle variables, conditionals and loops. |
23 changes: 23 additions & 0 deletions
23
docs/content/en/docs/OpenAI Plugins/plugin-call-transcript.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: Call Transcript Plugin | ||
description: AI plugin that analyzes a call given the transcript | ||
weight: 2 | ||
categories: [Semantic Kernel, OpenAI] | ||
tags: [openai, plugins, semantic-kernel] | ||
--- | ||
|
||
Use this plugin to analyze a call using the provided transcript. It offers functionality that is quite similar to the use case example of [Call Center Analytics]({{< ref "/docs/Use Cases/call-center-analytics.md" >}}). | ||
|
||
To test this plugin, send a `POST` request to its REST API at `/plugins/transcript` with the following request body: | ||
|
||
- `transcript`: the text with the call transcript. | ||
|
||
Upon successful execution, OpenAI will return a response with the following information extracted and formatted as bullet points: | ||
|
||
- Reason for the call | ||
- Name of the agent | ||
- Name of the caller | ||
- Caller's sentiment | ||
- A summary of the call | ||
|
||
Please note that the information provided may vary depending on the content of the supplied call transcript. |
18 changes: 18 additions & 0 deletions
18
docs/content/en/docs/OpenAI Plugins/plugin-financial-product-comparer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Financial Product Comparer Plugin | ||
description: AI plugin that compares a financial product with what is available on the market. | ||
weight: 3 | ||
categories: [Semantic Kernel, OpenAI] | ||
tags: [openai, plugins, semantic-kernel] | ||
--- | ||
|
||
Use this plugin to compare a given financial product with others available in the market by retrieving information via Bing. | ||
|
||
To test this plugin, send a `POST` request to its REST API at `/plugins/compare` with the following request body: | ||
|
||
- `product`: the name of the financial product to compare | ||
- `queryPrompt`: the query used to retrive comparable products from Bing | ||
|
||
Upon successful execution, OpenAI will return a response in natural language with the comparison description of the provided product with the information found on Bing using the also provided query. | ||
|
||
Upon successful execution, OpenAI will return a response in natural language, providing a detailed comparison of the specified product with the information retrieved from Bing using the provided query. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.