Getting Started Omeka Classic plugin

Installation

Requirements

  • Omeka Classic 3.1 or later. Chatbot is built and tested on 3.2.2.
  • PHP 8.1 or later, with the cURL and OpenSSL extensions.
  • Omeka's background jobs: indexing runs in the background. They need the path to PHP's command-line program in application/config/config.ini (background.php.path), which most hosts set.
  • A Turso database: create one at turso.tech, and note its URL and an auth token.
  • An OpenAI API key, from platform.openai.com, with access to embeddings and chat completions.
  • Optional: Simple Pages and Exhibit Builder, to index their pages.

Installing

  1. Unzip Chatbot-1.0.0.zip and copy the Chatbot folder into your Omeka Classic plugins/ folder.
  2. Log in to the admin as a Super User and go to Settings > Plugins.
  3. Click Install next to Chatbot.

Installing creates three tables: the log, the rate limits and the indexing queue. Chatbot appears in the admin menu for Super Users and Admins.

Setting it up

  1. In Chatbot > Settings, enter the OpenAI API key, the Turso database URL and the Turso auth token, and click Save Changes. The top of the page tells you what is still missing.
  2. In Chatbot > Index, click Re-index now. Every public record is embedded and stored; the count of records waiting goes down as it works.
  3. Try a Test search on the same tab.
  4. In Settings, tick Floating button to show the chat on every public page, or put [chatbot] in a simple page. Visit the site and ask a question.

See Configuration for every setting.

Upgrading

Deactivate the plugin, replace the plugins/Chatbot folder with the new version, then click Upgrade (or Activate) on the Plugins page.

Uninstalling

Click Uninstall on the Plugins page, then delete the folder. Chatbot's tables and settings, including the saved keys, are deleted. The chunks in your Turso database are left there: delete the database in Turso if you no longer need it, or purge it from Chatbot > Index before uninstalling.

Log in for Support