Documentation

Getting Started 4

Settings 5

BuddyBot Settings Submenu: A Comprehensive Guide

The BuddyBot settings page allows users to configure essential features for optimizing the BuddyBot’s functionality. This guide explains how to set up the OpenAI API key, manage visitor chat options, and configure session expiration and cleanup settings. Refer to the screenshot provided for visual guidance.

OpenAI API Key Configuration

Purpose

The OpenAI API key is required for BuddyBot to function, as it connects the Buddybot to OpenAI’s services for generating responses.

Steps to Configure

  1. Enter Your API Key:
    • Paste your OpenAI API key into the text field labeled “OpenAI API Key.”
    • Click the Change Key button to save your changes.
  2. Changing the API Key:
    • If you need to update or replace your existing API key, simply enter the new key in the same field and click Change Key.
  3. Don’t Have an API Key?

Visitor Chat Settings

Enable Visitor Chat

This option allows non-logged-in users (visitors) to interact with BuddyBot.

  • When Enabled:
    • Visitors can start conversations with BuddyBot without needing an account.
    • Their chat history will be temporarily stored for the session duration.
  • When Disabled:
    • Only logged-in users can access BuddyBot.
    • Visitors attempting to interact with BuddyBot will see an error message prompting them to log in first.

Use Case

Enable this feature if your website serves a broad audience, including casual visitors who may benefit from interacting with BuddyBot without creating an account.

Visitor Session Management

Visitor Session Expiry Time

  • Purpose: Set the time duration (in hours) after which a visitor’s conversation will expire.
  • Default Value: 24 hours.
  • Effect: Once a session expires:
    • The conversation is either deleted or marked as expired (depending on other settings).

This setting helps balance user experience with database efficiency by clearing inactive sessions.

Delete Expired Conversations

  • Enable this option to automatically delete expired conversations when a user’s session cookie expires.
  • A daily cron job will run to remove expired conversations, ensuring your database remains clean and optimized.

Recommendation: Enable this feature if your website handles a large volume of visitors or conversations, as it prevents unnecessary data buildup.

Saving Settings

After configuring all options, click the blue Save Options button at the bottom of the settings page. This ensures all changes are applied successfully.

Conclusion

The BuddyBot settings page provides comprehensive control over how your Buddybot interacts with users. By configuring the OpenAI API key, enabling visitor chat, managing session expiration, and cleaning expired conversations, you can optimize BuddyBot’s functionality for both logged-in users and visitors. These settings ensure a seamless user experience while maintaining database efficiency.

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *