matthewbolanos/todo-ai-plugin

Sample for creating an OpenAI plugin

Semantic Kernel ChatGPT plugin starter

This project provides starter code to create a ChatGPT plugin. It includes the following components:

• An endpoint that serves up an ai-plugin.json file for ChatGPT to discover the plugin
• A generator that automatically converts prompts into semantic function endpoints
• The ability to add additional native functions as endpoints to the plugin

To learn more about using this starter, see the Semantic Kernel documentation that describes how to create a ChatGPT plugin.

Prerequisites

• .NET 6 is required to run this starter.
• Azure Functions Core Tools is required to run this starter.
• Install the recommended extensions
  • C#
  • Semantic Kernel Tools

Configuring the starter

To configure the starter, you need to provide the following information:

• Define the properties of the plugin in the appsettings.json file.
• Enter the API key for your AI endpoint in the local.settings.json file.

For Debugging the console application alone, we suggest using .NET Secret Manager to avoid the risk of leaking secrets into the repository, branches and pull requests.

Using appsettings.json

Add the ID of your list.

1. Go to https://app-web-cuniu3csaexyy.azurewebsites.net (or your own instance of the todo app)
2. Create a new list
3. Copy the list ID from the URL
4. Paste the list ID into the listId property

Configure an OpenAI endpoint

1. Copy settings.json.openai-example to ./appsettings.json
2. Edit the kernel object to add your OpenAI endpoint configuration
3. Edit the aiPlugin object to define the properties that get exposed in the ai-plugin.json file

Configure an Azure OpenAI endpoint

1. Copy settings.json.azure-example to ./appsettings.json
2. Edit the kernel object to add your Azure OpenAI endpoint configuration
3. Edit the aiPlugin object to define the properties that get exposed in the ai-plugin.json file

Using local.settings.json

1. Copy local.settings.json.example to ./azure-function/local.settings.json
2. Edit the Values object to add your OpenAI endpoint configuration in the apiKey property

Running the starter

To run the Azure Functions application just hit F5.

To build and run the Azure Functions application from a terminal use the following commands:

cd azure-function
dotnet build
cd bin/Debug/net6.0
func host start