Link Search Menu Expand Document

Chat with AI chatbot

Table of contents


The SDKs chat with AI bridges your APP with the conversational platform of Bold360 ai. Provides a messaging-based user experience in which the Bold360 ai engine gathers information from the customer in a way similar to what a human agent would do in a regular conversation. Based on customer input and the engine’s search capabilities, the Conversational Bot provides the customer relevant information.

The main key for creating a chat is the account.


Use this account to create chat sessions with AI.

With the account you can configure the chatbot that will be created, provide extra details when needed and define other configurations for the chat session.

Creating account

val account = BotAccount(API_KEY, ACCOUNT_NAME,
                        KNOWLEDGE_BASE, SERVER)
  • API_KEY - As was configured to your account.
  • ACCOUNT_NAME [mandatory] - As was configured to your account.
  • KNOWLEDGE_BASE [mandatory] - The knowledge base that should be used for this chat.
  • SERVER [mandatory] - As was configured to your account.

Configure UserId

The UserId is used for reports and analitics. UserId should be managed and applied by the application on the chat creation, if not provided, the SDK creates a new id. In order to relate analitic content to the same user, the same UserId should be provided.

val account = BotAccount(...).apply{
    userId = SAVED_USER_ID

Hosting application can get the newly created UserId on AccountInfoProvider.update and keep it for later use.

override fun update(account: AccountInfo) {

Configure Contexts

If your account supports context based answers, you may want to configure those on your account to be used during the chat.

// Create contexts map 
val contexts = mapOf("ContextKey1" to "ContextValue1",
                    "ContextKey2" to "ContextValue2", ... )

// set on constructor:
val account = BotAccount(API_KEY, ACCOUNT_NAME,
                        KNOWLEDGE_BASE, SERVER, contexts)

// or later in time, before chat creation:                           
account.contexts = contexts

Configure Initialization Entities

Custom Entities, are pices of information that should be provided by the application/user during the chat, instead of using a form, we use the conversation to gather those details. Some entities are static and are not going to change during the chat, therefore can be provided on the chat creation. Those entities are provided on the account.

 account.initializationEntities = mapOf("EntityKey1" to "EntityValue1",
                                     "EntityKey2" to "EntityValue2", ... )

AI Chat continuity

Chatbot continuity has no special meaning as in live chat. Previous conversationId can be provided, for the initiated chat session, and if valid will be used, otherwise a new chat session will be created. The created conversationId is available for Hosting app managment via AccountInfoProvider.update.

override fun update(account: AccountInfo) { // conversationId

How to

  • Customize and override chat Welcome Message

    Bold360 console configured welcome message article, can be overridden, or provided if none configured, on the account.

      botAccount.welcomeMessage = ARTICLE_ID 
      // if id is not valid, no message will be displayed
      botAccount.welcomeMessage = BotAccount.None 
      // prevent welcome message display