diff --git a/docs/content/en/docs/Concepts/_index.md b/docs/content/en/docs/Concepts/_index.md index 9f8d141..d825768 100644 --- a/docs/content/en/docs/Concepts/_index.md +++ b/docs/content/en/docs/Concepts/_index.md @@ -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. --- diff --git a/docs/content/en/docs/Concepts/azure-cognitive-search.md b/docs/content/en/docs/Concepts/azure-cognitive-search.md index 051e571..ec5bdbe 100644 --- a/docs/content/en/docs/Concepts/azure-cognitive-search.md +++ b/docs/content/en/docs/Concepts/azure-cognitive-search.md @@ -5,7 +5,7 @@ description: > Used to build a rich search experience over private, heterogeneous content in web, mobile, and enterprise applications. categories: [Azure] tags: [docs, cognitive-search] -weight: 2 +weight: 4 --- Azure Cognitive Search (formerly known as "Azure Search") is a cloud search service that gives developers infrastructure, APIs, and tools for building a rich search experience over private, heterogeneous content in web, mobile, and enterprise applications. diff --git a/docs/content/en/docs/Concepts/azure-container-apps.md b/docs/content/en/docs/Concepts/azure-container-apps.md index 68ae058..a72c0a0 100644 --- a/docs/content/en/docs/Concepts/azure-container-apps.md +++ b/docs/content/en/docs/Concepts/azure-container-apps.md @@ -5,7 +5,7 @@ description: > Host the application in Azure Container Apps. categories: [Azure] tags: [docs, container-apps, serverless] -weight: 4 +weight: 5 --- Azure Container Apps is a managed serverless container service that enables executing code in containers without the overhead of managing virtual machines, orchestrators, or adopting a highly opinionated application framework. diff --git a/docs/content/en/docs/Concepts/azure-content-safety.md b/docs/content/en/docs/Concepts/azure-content-safety.md index 9e60955..8e51788 100644 --- a/docs/content/en/docs/Concepts/azure-content-safety.md +++ b/docs/content/en/docs/Concepts/azure-content-safety.md @@ -5,7 +5,7 @@ description: > Used to keep your content safe. Create better online experiences for everyone with powerful AI models that detect offensive or inappropriate content in text and images quickly and efficiently. categories: [Azure] tags: [docs, content-safety, azure, ai, content, safety] -weight: 2 +weight: 3 --- Azure AI Content Safety detects harmful user-generated and AI-generated content in applications and services. Azure AI Content Safety includes text and image APIs that allow you to detect material that is harmful. We also have an interactive Content Safety Studio that allows you to view, explore and try out sample code for detecting harmful content across different modalities. diff --git a/docs/content/en/docs/Concepts/azure-openai.md b/docs/content/en/docs/Concepts/azure-openai.md index 64ddf5c..c232c0c 100644 --- a/docs/content/en/docs/Concepts/azure-openai.md +++ b/docs/content/en/docs/Concepts/azure-openai.md @@ -5,7 +5,7 @@ description: > The core of the Generative AI solution. categories: [Azure] tags: [docs, openai] -weight: 1 +weight: 2 --- Azure OpenAI Service provides REST API access to OpenAI's powerful language models including the GPT-4, GPT-35-Turbo, and Embeddings model series. In addition, the new GPT-4 and gpt-35-turbo model series have now reached general availability. These models can be easily adapted to your specific task including but not limited to content generation, summarization, semantic search, and natural language to code translation. Users can access the service through REST APIs, Python SDK, or our web-based interface in the Azure OpenAI Studio. diff --git a/docs/content/en/docs/Concepts/semantic-kernel.md b/docs/content/en/docs/Concepts/semantic-kernel.md index 9e7f2b7..0c02dcd 100644 --- a/docs/content/en/docs/Concepts/semantic-kernel.md +++ b/docs/content/en/docs/Concepts/semantic-kernel.md @@ -5,7 +5,7 @@ description: > An open-source SDK that lets you easily combine AI services like OpenAI, Azure OpenAI, and Hugging Face with conventional programming languages like C# and Python. categories: [SDK] tags: [docs, tools] -weight: 3 +weight: 8 --- Semantic Kernel is an open-source SDK that lets you easily combine AI services like OpenAI, Azure OpenAI, and Hugging Face with conventional programming languages like C# and Python. By doing so, you can create AI apps that combine the best of both worlds. @@ -18,6 +18,14 @@ To help developers build their own Copilot experiences on top of AI plugins, we ![Image of Semantic Kernel](https://learn.microsoft.com/en-us/semantic-kernel/media/mind-and-body-of-semantic-kernel.png) -**AI Hub** uses Semantic Kernel to orchestrate the prompts, Azure OpenAI calls and Azure Cognitive Search queries and results. +## Semantic Kernel and the AI Hub -Learn more at the official documentation of [Semantic Kernel](https://learn.microsoft.com/en-us/semantic-kernel/overview/) \ No newline at end of file +At present, the **AI Hub** does not use the Semantic Kernel directly in its use case examples. However, it does demonstrate its usage through two specific examples that show how easely is to create OpenAI plugins using Semantic Kernel as an SDK. + +Here are the available plugin examples: + +1. **Call Analysis**: This plugin uses Semantic Kernel to implement features similar to those demonstrated in the [Call Center Analytics]({{< ref "/docs/Use Cases/call-center-analytics.md" >}}) use case. + +2. **Financial Product Comparison**: This plugin employs Semantic Kernel to combine native and prompt functions to compare a specific financial product with others in the market. It combines prompts with the [Web Search Engine Plugin](https://learn.microsoft.com/en-us/dotnet/api/microsoft.semantickernel.plugins.web.websearchengineplugin), which is further integrated with the [Bing Search connector](https://learn.microsoft.com/en-us/dotnet/api/microsoft.semantickernel.plugins.web.bing.bingconnector). + +For more information, please refer to the [OpenAI Plugins]({{< relref "/docs/OpenAI Plugins" >}}) section. You can also learn more about Semantic Kernel in its [official documentation](https://learn.microsoft.com/en-us/semantic-kernel/overview/). diff --git a/docs/content/en/docs/Contribution guidelines/_index.md b/docs/content/en/docs/Contribution guidelines/_index.md index 0c624e4..8e11bca 100644 --- a/docs/content/en/docs/Contribution guidelines/_index.md +++ b/docs/content/en/docs/Contribution guidelines/_index.md @@ -1,6 +1,6 @@ --- title: Contribution Guidelines -weight: 6 +weight: 7 description: How to contribute to the project --- diff --git a/docs/content/en/docs/Deployment/_index.md b/docs/content/en/docs/Deployment/_index.md index e76ec3f..0000c44 100644 --- a/docs/content/en/docs/Deployment/_index.md +++ b/docs/content/en/docs/Deployment/_index.md @@ -1,7 +1,7 @@ --- title: Deployment description: AI Hub — Steps to deploy the complete solution. -weight: 3 +weight: 4 --- ## High-level Architecture diff --git a/docs/content/en/docs/OpenAI Plugins/_index.md b/docs/content/en/docs/OpenAI Plugins/_index.md new file mode 100644 index 0000000..feef3a0 --- /dev/null +++ b/docs/content/en/docs/OpenAI Plugins/_index.md @@ -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. diff --git a/docs/content/en/docs/OpenAI Plugins/plugin-call-transcript.md b/docs/content/en/docs/OpenAI Plugins/plugin-call-transcript.md new file mode 100644 index 0000000..a49ff75 --- /dev/null +++ b/docs/content/en/docs/OpenAI Plugins/plugin-call-transcript.md @@ -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. diff --git a/docs/content/en/docs/OpenAI Plugins/plugin-financial-product-comparer.md b/docs/content/en/docs/OpenAI Plugins/plugin-financial-product-comparer.md new file mode 100644 index 0000000..7726e18 --- /dev/null +++ b/docs/content/en/docs/OpenAI Plugins/plugin-financial-product-comparer.md @@ -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. diff --git a/docs/content/en/docs/Reference/_index.md b/docs/content/en/docs/Reference/_index.md index d8716b6..68f6c3c 100644 --- a/docs/content/en/docs/Reference/_index.md +++ b/docs/content/en/docs/Reference/_index.md @@ -1,7 +1,7 @@ --- title: Resources & References description: Check out other resources and references -weight: 5 +weight: 6 --- ## Sample Repos: diff --git a/docs/content/en/docs/Use Cases/pbi-data-report.md b/docs/content/en/docs/Use Cases/pbi-data-report.md deleted file mode 100644 index b4e5215..0000000 --- a/docs/content/en/docs/Use Cases/pbi-data-report.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: PBI Data Report -date: 2023-11-16 -description: > - PBI Data Report ..... -categories: [Azure, PowerBI] -tags: [docs, powerbi ] -weight: 8 ---- - -lorem ipsum dolor sit amet \ No newline at end of file