Hello World Bot Creation Guide

This document provides a structured guide for developing the "Hello World Bot" within the ix Hello 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 ix Hello Studio Mode

• Familiarity with basic ix Hello navigation.

Step-by-Step Implementation

The following steps outline the creation of the "Hello World Bot":

1. Generative AI-Connection

• Navigate to Integration > Connect System.

• Click Add New Connection.

• Select Generative AI from the dropdown menu and click Next.

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

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

1. Content Category Creation

• Navigate to Content > Content Categories.

• Click Add New Category.

• Enter a unique category name (e.g., Hello World Category).

• Provide a concise description (e.g., "Category for Hello World Bot"). An optional content icon can be added.

• Click Add.

1. Custom App Development

• Navigate to Apps > Custom Apps.

• Click New Custom App.

• Enter the following details:

  • Name: Hello World Bot

  • Custom App Type: Search

  • Category: Select the Hello World Category created in the previous step.

  • Check the box: This is a Generative AI App

  • Click Save

1. 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

1. Method Definition

• In your Custom App, navigate to the Methods tab

• Click Create New Method

• Enter:

  • Method Name: chatcompletion

  • Request Type: chatcompletion

• 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 the Hello World Bot. Answer the following question: What is the capital of India?").

  • 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

Results:

1. Retrieving Employee and Organization IDs

• Navigate to Account Setup > Profile.

• Locate and copy your EmployeeID and OrganizationID.

• Paste these IDs into the corresponding parameter fields in the test method dialog (Step 5).

1. Intent Creation

• In your Custom App, navigate to the Intents tab

• Click Create New Intent

• Enter:

  • Name: HelloWorldIntent

  • 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

  • CustomApp: Hello World Bot

  • Intent: HelloWorldIntent

  • Click Save.

1. Utterance Definition

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

• Click Create New Utterance.

• Enter:

  • Value: "What is the capital of India?"

  • Intent: HelloWorldIntent

  • Click Save

1. Input Configuration

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

• Click Create New Input.

• Enter:

  • Name: ChatInput

  • Custom Intent: HelloWorldIntent

  • Data Source: genAIdataSource

  • Data Source Method: chatcompletion

  • Click Save.

• Add input parameter:

  • Input Parameter Name: UserInput

  • Parameter: UserInput

  • Data Type: Text

  • Click Save.

1. Application Publishing

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

• Click Add App Publishing.

• Enter:

  • External App Name: (Choose a descriptive name, e.g., Hello World Bot)

  • App Description: (Provide a brief description, e.g., "A bot that answers basic questions about the Hello World tutorial.")

  • App Type: Search

  • Channel: Generative AI

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

  • Click Save.

Testing

Thoroughly test your newly published Hello World Bot to ensure functionality and accuracy. Use various questions to confirm that the bot provides the correct responses.

Conclusion

This guide provides a foundation for building the Hello World Bot. Ensure to refer to the ix Hello documentation for more advanced features and customization options. If you experience any issues or require further assistance, do not hesitate to reach out to your support team.