FAQ Bot Creation Guide

This document provides a structured guide for developing a basic FAQ bot within the ixHello platform using Studio Mode. This process leverages Generative AI capabilities for efficient question answering.

Prerequisites

Before commencing bot creation, ensure the following prerequisites are met:

• Access to ixHello Studio Mode.

• Familiarity with basic ixHello navigation.

Step-by-Step Implementation

The following steps outline the creation of a functional FAQ bot:

1. Generative AI-Connection

• Navigate to Integration > Connect System.

• Click Add New Connection.

• Select Generative AI from the dropdown menu.

• Provide a descriptive instance name (e.g., genAI_instance).

• Click Save Settings. A successful connection will be indicated.

2. Content Category Creation

• Navigate to Content > Content Categories.

• Click Add New Category.

• Enter a unique category name (e.g., FAQ Category v1).

• Provide a concise description (e.g., "Category for Simple FAQ Chatbot"). An optional content icon can be added.

• Click Add.

3. Custom App Development

• Navigate to Apps > Custom Apps.

• Click New Custom App.

• Enter the following details:

  • Name: FAQ bot v1

  • Custom App Type: Search

  • Category: Select the FAQ Category v1 created in the previous step.

  • Check the box: This is a Generative AI App

  • Click Save

4. Data Source Configuration

• Within your newly created Custom App, navigate to the Data Sources tab.

• Click Create New Data Source.

• Enter the following:

  • Name: genAIdataSource

  • Integration Configuration: Select your Generative AI connection (created in Step 1).

  • Click Save.

5. Method Definition

• In your Custom App, navigate to the Methods tab.

• Click Create New Method.

• Enter:

  • Method Name: chatcompletion

  • Request Type: chatcompletion-rag

• Configure the parameters:

  • Model: Select your preferred Generative AI model (e.g., OpenAI gpt-4).

  • systemMessage: Provide instructions for the bot's behavior (e.g., " You are a FAQ bot. Answer the following frequently asked questions exactly as provided: 1. Q: What is my room number? A: Your room number is 101. 2. Q: What is the Wi-Fi password? A: The Wi-Fi password is Guests$2025. Enjoy your stay connected!").

  • userQuestion: {{UserInput}}

  • streaming: False

  • sessionTime: 10

  • OrganizationID: {{Context.OrganizationID}}

  • EmployeeID: {{Context.EmployeeID}}

• Configure Method Output:

  • Result Type: ListofRecords

  • Record Limit: 10

• Configure Method Result:

  • Record JsonPath: $.choices[0].message

  • Valid Result Template: {{Records}}

  • Record Template: {{content}}

  • Empty Result Template: "Is there anything else I can assist you with?"

  • Uncheck: Automatically prompt for next question

  • Click Save & Test. This will initiate a test API call.

1. Retrieving Employee and Organization IDs

• Navigate to Account Setup

• Go to Account Setup > Profile.

• Copy Your IDs

• Locate your EmployeeID and OrganizationID and copy them.

• Paste these IDs into the corresponding parameter fields in the test method dialog.

• Method test results

7. Intent Creation

• In your Custom App, navigate to the Intents tab.

• Click Create New Intent.

• Enter:

  • Name: chatIntent

  • Intent Type: Search

  • Intent Action: Execute Method

  • Data Source: genAIdataSource

  • Data Source Method: chatcompletion

  • Dialog Delegation Strategy: ManualDelegation

  • Check the checkbox for Set this intent as a fallback Intent.

  • Click Save.

1. Slot Creation

• In your Custom App, navigate to the Slots tab.

• Click Create New Slot.

• Enter:

  • Name: UserInput

  • Slot Order: 1

  • Type: Text

  • Intent: chatIntent

  • Click Save.

1. Utterance Definition

• In your Custom App, navigate to the Utterances tab.

• Click Create New Utterance.

• Enter:

  • Value: Ask a question

  • Intent: chatIntent

  • Click Save.

1. Input Configuration

• In your Custom App, navigate to the Input tab.

• Click Create New Input.

• Enter:

  • Name: ChatInput

  • Custom Intent: chatIntent

  • Data Source: genAIdataSource

  • Data Source Method: chatcompletion

  • Click Save

• Add input parameter

  • Input Parameter Name: UserInput

  • Parameter: UserInput

  • Data Type: Text

  • Click on save.

1. Application Publishing

• In your Custom App, navigate to the Publish tab.

• Click Add App Publishing.

• Enter:

  • External App Name: FAQ bot v1

  • App Description: FAQ bot v1

  • App Type: Search

  • Channel: Generative AI

  • Check: Enable API Access (Optional: Check boxes for basic/showcase mode visibility)

  • Click Save

1. Testing

• Thoroughly test your newly published bot to ensure functionality and accuracy.

Congratulations!

You have scuccessfully completed building a simple FAQ bot.