Getting Started with the KendoReact AIPrompt

This guide provides essential information about using the KendoReact AIPrompt component. You will learn how to install the Conversational UI package that provides the AIPrompt. Then, you will add a AIPrompt component to your project, style the component, and activate your license.

After completing this guide, you will be able to reproduce the following example.

Setting Up Your React Project

Before you install the KendoReact Conversational UI package, which contains the AIPrompt component, make sure that you have a running React project. The easiest way to set up a KendoReact project is to use the Create KendoReact App approach that is described in the Get Started with KendoReact article.

Installing the Conversational UI Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the AIPrompt component, start with the installation of the Conversational UI npm package and its dependencies. Use Node.js v5.0.0 or later.

Copy Codenpm install --save @progress/kendo-react-conversational-ui @progress/kendo-react-buttons @progress/kendo-react-intl @progress/kendo-svg-icons @progress/kendo-licensing

Importing the Component

After installing the package, import the AIPrompt component in the React App.

In the src/App.js file of your React project, import the AIPrompt, AIPromptView, AIPromptCommandsView and AIPromptOutputView from the Conversational UI package.

Copy Code// ES2015 module syntax
import { AIPrompt, AIPromptView,  AIPromptOutputView, AIPromptCommandsView} from '@progress/kendo-react-conversational-ui';

Copy Code// CommonJS format
const { AIPrompt, AIPromptView, AIPromptOutputView, AIPromptCommandsView } = require('@progress/kendo-react-conversational-ui');

Using the Component

1. Define the AIPrompt component and add the AIPromptView and AIPromptOutputView

   Copy Code  <AIPrompt>
        <AIPromptView/>
        <AIPromptOutputView>
        <AIPromptCommandsView/>
     </AIPrompt>

2. Next, define the activeView, handle the onActiveViewChange, onPromptRequest which is triggered when the user clicks the Generate button in the Prompt view and the onCommandExecute when the Command view is clicked. Finally pass promptViewDefaults, outputViewDefaults, commandsViewDefaults to the toolbarItems prop.

   Copy Code  <AIPrompt
        style={{ width: '400px', height: '400px' }}
        activeView={activeView}
        onActiveViewChange={handleActiveViewChange}
        onPromptRequest={handleOnRequest}
        onCommandExecute={handleCommandExecute}
        toolbarItems={[promptViewDefaults, outputViewDefaults, commandsViewDefaults]}
     >
        <AIPromptView promptSuggestions={suggestionsList} />
        <AIPromptOutputView outputs={outputs} showOutputRating={true} />
        <AIPromptCommandsView commands={promptCommands} />
     </AIPrompt>

3. To style the AIPrompt, install and import the Default theme, which is one of the four beautiful themes for KendoReact.

   3.1. Install the Default theme package.

   Copy Codenpm install --save @progress/kendo-theme-default

   3.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

   Copy Codeimport '@progress/kendo-theme-default/dist/all.css';

4. Build and run the application by typing the following command in the root folder of your project:

   Copy Codenpm start

5. Navigate to http://localhost:3000 to see the KendoReact AIPrompt component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The Conversational UI package requires you to install the following peer dependencies in your application:

Suggested Links

• Getting Started with the KendoReact Conversational UI Package
• API Reference of the KendoReact AIPrompt
• API Reference of the AIPromptProps