AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt 1.0.0-beta.7

AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt - Beta

OpenAISuggestionPrompt

The OpenAISuggestionPrompt is a utility for generating suggestion questions based on a prompt using Azure OpenAI services. This prompt can be integrated into your Bot Framework applications to provide question prompts for conversational applications.

Installation

To get started with the OpenAISuggestionPrompt, you can install the NuGet package from the following link:

NuGet Package

Implementation in Bot Framework SDK

To implement the OpenAISuggestionPrompt in your Bot Framework SDK application, follow these steps:

1. Add the OpenAISuggestionPrompt dialog to your bot's dialog set, providing the necessary configuration parameters:

   AddDialog(new OpenAISuggestionPrompt(
       nameof(OpenAISuggestionPrompt),
       Settings.Key, // OpenAI Key
       Settings.EndPoint, // OpenAI endpoint
       Settings.DeploymentName, // OpenAI DeploymentName
       maxTokens: 100, // OpenAI maxtokens
       noOfSuggestion: 3 // Number of questions to be generated
   ));
   
   

Key: Your OpenAI API Key.

Endpoint: The OpenAI service endpoint.

DeploymentName: Your OpenAI Deployment Name.

maxTokens: Maximum tokens for OpenAI.

noOfSuggestion: The number of questions to be generated.

2. Set the prompt for generating questions using the OpenAISuggestionPrompt. For example:

var options = new PromptOptions()
{
   Prompt = MessageFactory.Text(
       "A bot framework is a set of tools and services that help developers create and manage conversational applications, such as chatbots or virtual assistants")
};

3. Add the OpenAISuggestionPrompt to your bot's dialog stack:

return await stepContext.PromptAsync(nameof(OpenAISuggestionPrompt), options, cancellationToken);

Now, your bot is ready to generate suggestion questions based on the provided prompt using the OpenAISuggestionPrompt. You can customize the prompt and other settings according to your specific application requirements.

Feel free to explore the NuGet package and integrate this tool into your Bot Framework SDK projects to enhance your conversational applications with suggestion questions.