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

This is a prerelease version of AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt.
dotnet add package AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt --version 1.0.0-beta.7
NuGet\Install-Package AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt -Version 1.0.0-beta.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt" Version="1.0.0-beta.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt --version 1.0.0-beta.7
#r "nuget: AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt, 1.0.0-beta.7"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt as a Cake Addin
#addin nuget:?package=AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt&version=1.0.0-beta.7&prerelease

// Install AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt as a Cake Tool
#tool nuget:?package=AzureAI.Community.OpenAI.Bot.Builder.SuggestionPrompt&version=1.0.0-beta.7&prerelease

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.

  1. 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")
};
  1. 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.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-beta.7 189 10/31/2023
1.0.0-beta.6 45 10/31/2023
1.0.0-beta.5 60 10/31/2023
1.0.0-beta.4 58 10/31/2023
1.0.0-beta.3 77 10/30/2023