Opensolr Chat Bot documentation

The open source chatbot that answers your visitors from your own Opensolr Index, mounted on one path of your own site.

Welcome!

The Opensolr Chat Bot Client puts a chatbot on your website that answers your visitors from your own Opensolr Index: the pages the Opensolr Web Crawler fetched from your site, or the documents you sent with Data Ingestion. It is free and open source under the MIT license, and it runs on your own site.

You can try it right here.

The chat button at the bottom right of this page is the Opensolr Chat Bot, answering from the Opensolr Index of opensolr.com.

01 · What your visitors get
  • Answers from your content. For every question it searches your site, answers from what that search finds, and links every page, product and PDF page it mentions. Products come with their prices, PDFs open at the exact page.
  • Written as it comes. The answer appears word by word. Before the first word, a line says what it is doing: Searching for: …, Reading the document ….
  • Dates it understands. It knows today’s date in your time zone, so it can look for the latest on a subject or for what was published in a period.
  • In the visitor’s language. Every visitor is answered in their own language.
  • Commands that answer at once. /search, /time, /rate, /vat, /translate and more, with a list that opens as soon as the visitor types /. See Commands.
  • A chat window that keeps up. The conversation is kept in the visitor’s browser, New chat starts over, the window can be resized, and on a phone it fills the screen. See Chat window.
02 · How it fits together
Your visitorThe chat windowTalks only to your siteYour siteThe chat path you mountHolds your API keyOpensolrSearches your indexWrites the answer
Your visitorThe chat windowTalks only to your siteYour siteThe chat path you mountHolds your API keyOpensolrSearches your indexWrites the answer

Your visitors talk only to your site. Your site keeps your Opensolr email and API key, asks Opensolr for each answer, and passes it on to the visitor as it is written.

The client is a small PHP package with no framework and no MySQL. It answers on one path of your own site, /opensolr-chat by default, and keeps its settings in a SQLite database in a folder of your choice. Your pages get one script tag.

03 · The shortest path
  1. Check the requirements: PHP 8.1 or newer, an Opensolr Index with your site in it, and a plan that includes AI.
  2. Install it with Composer and mount it on one path of your site.
  3. Set the admin password, sign in, connect your account and choose the index.
  4. Add one script tag to your pages.
04 · Beyond this documentation

The Opensolr Chat Bot Client is open source and MIT licensed. Questions about your Opensolr account, index or plan go to opensolr.com/contact; questions about the client itself belong on GitHub.

Opensolr Chat Bot Documentation