SquirroGPT Web Quick-Start Guide#
This guide provides an introduction to SquirroGPT Chat Web and instructions on how to install and use the application.
The application is available from start.squirro.com.
Note
SquirroGPT is offered in two version, Web and Data. This guide covers the Web version. For information on SquirroGPT Data, see SquirroGPT Data Quick-Start Guide.
Introduction
SquirroGPT is a preconfigured Squirro application that allows you crawl your website and then query your data through an interface powered by Squirro’s information retrieval stack and a state-of-the-art large language model (LLM).
After installing the application and crawling your site, you’ll be presented with an intuitive digital assistant interface that allows you to interact with your data using natural language queries and embed a version of the digital assistant on your website.
Who This Guide is Designed For
This quick-start guide is designed for end users who wish to try the SquirroGPT Web application found at start.squirro.com.
Process Overview
The following steps are needed to install and use SquirroGPT:
Register for a SquirroID.
Install the application in the Squirro cloud.
Crawl your website.
Chat with SquirroGPT through the web application.
Embed a digital assistant on your website using a code snippet.
Register for a SquirroID#
To install a copy of SquirroGPT, you’ll first need a SquirroID.
If you don’t have one yet, see How to Register for a Squirro ID for instructions.
Take SquirroGPT for a Test Drive#
If you want to quickly see what SquirroGPT can do without installing the application as described in this guide, you can now Test Drive a SquirroGPT application.
This allows you to safely and securely upload your own data or crawl your own website and see how SquirroGPT works.
To learn more, see How to Launch a Test Drive.
Install the Application in the Squirro Cloud#
To install your copy of SquirroGPT in the Squirro cloud, follow the steps below:
Navigate to start.squirro.com.
Click the tile for SquirroGPT - Web, as shown in the screenshot below:
Click Install App.
Select the instance you’d like to install your application on, or scroll to the bottom and click Add a new instance to create a new instance the application will be added to.
Click Send Form to submit your information and install your new application.
When it’s done installing, you can click your new instance, which will open with your new SquirroGPT application.
Note: If you have any issues installing SquirroGPT, simply contact the friendly folks over at Squirro Support for help.
Crawl Your Website(s)#
To use SquirroGPT Web, you’ll need to start by crawling your website to ingest all of its data.
To do so, follow the steps below:
Log in and open your freshly installed SquirroGPT Web application. You should see the following welcome screen with a Connect Data button:
Click Connect Data, which launches the following screen:
Click Crawl a Website.
Enter your url starting with
https://, for examplehttps://docs.squirro.com. While it crawls, you will see messaging within the UI letting you know that the crawler is working, as shown in the example screenshot below:
Note: The crawler operates based on the primary url of the website. If you have multiple websites, you’ll need to add a new data source for each unique url.
Important
After crawling your website verify that your files have been uploaded properly by checking the Items display in the bottom-left corner of the UI. This section will show you how many pages are correctly indexed and alert you if there are any issues.
Reference: To learn about advanced web crawler options, see the Web Crawler Connector documentation.
Understanding the Admin Interface#
After opening your project, you’ll be presented with a digital assistant interface that allows you to interact with your data.
Note
The different parts of the SquirroGPT UI are labeled and explained below:
Create a New Chat: Start a fresh chat with SquirroGPT.
Chat Selection: When multiple chats are present, select between them here. Hovering over the chat will display a menu that will allow you to rename or delete the chat.
Indexed Items: Displays the number of files you’ve indexed. If green, your documents have indexed correctly. If red, your documents have not indexed correctly. Click the server icon to view your connected data sources.
Connect More Data Sources: Crawl additional websites.
Embed Chat: Opens the modal window that provides customization and embedding options for the SquirroGPT digital assistant.
Invite Users: Opens the modal window that allows you to invite additional users to your project.
Queries Remaining: Number of queries remaining on your free trial or monthly subscription plan.
Change Subscription Info: Links to a Squirro contact form where you can request changes to your SquirroGPT subscription.
Contact Squirro Support: Open a Squirro support ticket directly from the UI.
Additional Menu Items: Click the three-dot menu to access additional menu items, including the ability to clear all chats and a link to this documentation.
Chat Areas: Your queries and SquirroGPT’s responses will appear here.
Answer Grounding: When SquirroGPT generates an answer, it will display the grounding strictness used.
Copy Answer and Provide Feedback: Click the copy icon to copy the generated answer, or click the three dots to provide feedback on the quality of the SquirroGPT response.
Sources: When the generated answer can be tied to a specific source (or sources), the source(s) will be displayed here. Click a source to open it.
Grounding: Select between levels of grounding strictness. See the explanation for this feature in the section below.
Chat Input: Type your chat query here, or click the Microphone icon to speak your query.
Grounding#
SquirroGPT allows you to choose one of three evidence-grounding options for each chat query submitted.
These options include the following:
With Project Data Strict: Adheres as strongly as possible to the retrieved sources, limiting answers generated from the LLM’s internal knowledge.
With Project Data Lenient: If it feels it needs to, supplements the information from the provided sources with its internal knowledge to provide a more comprehensive answer. This can be useful to fill in small information gaps in the retrieved documents. The risk in using this option is an elevated chance of hallucinations.
Without Project Data: Forwards the user question (along with the current chat history) to the underlying LLM to retrieve an answer. This can be a useful tool to showcase what the answers would have been without Squirro’s source grounding.
Understanding the Digital Assistant UI#
The digital assistant interface is the interface that will be embedded on your website in one of the three following ways:
As a floating action button (most popular)
As an iFrame
Within an existing target button
The screenshot below shows the digital assistant interface when embedded using a floating action button, with the different parts of the UI labeled and explained below:
Digital Assistant UI
Digital Assistant Title: This title is configurable within the Embed Appearance tab.
Resize Icon: Allows you to toggle between small and large chat sizes.
Close Icon: Closes the chat window (but retains the chat icon if you’ve embedded the chat as a button).
User Query: The user’s query.
Chat Avater: The avatar of the digital assistant. This is configurable within the Embed Appearance tab.
Chat Name: The name associated with SquirroGPT responses. This is configurable within the Embed Appearance tab.
Copy Icon: Click to copy the generated answer.
Feedback Menu: Click to provide feedback on the quality of the SquirroGPT response.
Response: The SquirroGPT-generated response to the user query.
Sources: When the generated answer can be tied to a specific source (or sources), the source(s) will be displayed here.
Chat Input: Type your chat query here and push enter or click the send icon to submit your query.
Digital Assistant Icon: The icon that appears when you embed the digital assistant as a floating action button. This is configurable within the Embed Appearance tab.
Embedding the Digital Assistant#
Once you have crawled your website(s), you can embed a version of the digital assistant on your website (or wherever you’d like).
To do so, follow the steps below:
Log in to your Squirro project.
Navigate to your chat interface (via Dashboards.)
Click Embed Chat to launch the embed modal window, as shown in the screenshot below:
Select your preferred option of the three, which will launch the customization and embedding configurations for your selected option.
Embed as Floating Action Button#
This will embed SquirroGPT as a digital assistant in the corner of your website.
There are three tabs in the embed window, as shown in the screenshot below:
In this tab, you can customize the chat title, name, avatar, and color scheme.
You can also choose the size and position of the digital assistant window that appears when the user clicks the button.
Lastly, you can select the chat icon that appears as well as its color.
In this tab, you can set your welcome, choose whether or not to show sources with answers using the toggle, and set custom starter questions.
This tab contains the code snippet you’ll need to embed the digital assistant on your website.
Copy the code to your clipboard, then paste it in the <head> element of your site or web application.
Embed iFrame#
This will embed SquirroGPT as a digital assistant via iFrame.
There are three tabs in the embed window, as shown in the screenshot below:
In this tab, you can customize the chat title, name, avatar, and color scheme.
In this tab, you can set your welcome, choose whether or not to show sources with answers using the toggle, and set custom starter questions.
This tab contains the code snippet you’ll need to embed the digital assistant on your website. Here you can also specify the iFrame dimensions width and height.
Copy the code to your clipboard, then paste it in the <head> element of your site or web application.
Embed in Target Button#
This will embed SquirroGPT as a digital assistant that’s launched when a user clicks a pre-existing button on your website.
There are three tabs in the embed window, as shown in the screenshot below:
In this tab, you can customize the chat title, name, avatar, and color scheme.
You can also choose the size and position of the digital assistant window that appears when the user clicks the button.
In this tab, you can set your welcome, choose whether or not to show sources with answers using the toggle, and set custom starter questions.
This tab contains the code snippets you’ll need to embed the digital assistant on your website. For this option, it’s a two-step process.
Copy the Embed Chat Button code to your clipboard, then paste it in the
<head>element of your site or web application.After pasting the code in Step 1, copy the Trigger SquirroGPT from a Target Button code to your clipboard, then locate your custom button in your website code and add the code snippet to the
onclick event.
How to Use SquirroGPT#
As an end user, getting started with SquirroGPT is easy. Simply type your query into the chat input field and start a conversation.
While using it is easy, getting the most out of the experience can sometimes require a knowledge of best practices.
Caution
Even with best practices, like all generative technology, SquirroGPT may produce inaccurate information about people, places, or facts. Please validate answers against the source material.
To learn more about how to get the most out of SquirroGPT, see Take SquirroGPT for a Test Drive.
Adding Users#
Note
The term instance and server are used interchangeably. They refer to your root installation of the Squirro platform in the Squirro-managed cloud referred to as Squirro Self-Service.
Adding users is a two-step process:
Users must first register for a SquirroID at start.squirro.com.
Once they have a SquirroID, you must add them to your instance.
1 - Registering for a SquirroID#
Any users you wish to add to your project must first register for a SquirroID.
Reference: For instructions on obtaining a SquirroID, see How to Register for a Squirro ID.
2 - Adding Users to Your Instance#
Users are added to your server via the Cluster page, also known as the My Instances page.
To add users to your instance, follow the steps below:
Once logged in to Squirro with your SquirroID, navigate to the Cluster page by clicking the navigation menu in the top-right corner of the UI.
Hover over your instance, and click the three-dot menu that appears, as shown in the screenshot below:
Click Users.
Click Invite Users to add users by email address.
Enter the user’s email address and select the role of Admins and click Send.
Note: At initial launch of SquirroGPT, new users must be added as Admins.
Warning
Users may not be automatically notified that they have been added to the project. It is recommended to manually notify users after adding them to the project.
Notes on Data Security#
Note the following regarding data security:
SquirroGPT runs on a single tenant utilizing Squirro’s public cloud infrastructure.
On uploading, your data is indexed and enriched.
Your data is encrypted both in transit and at rest.
SquirroGPT combines an information retrieval stack with a large language model (LLM).
During chat generation, portions of your data are exposed to said LLM but are not transferred or stored in the LLM.
Limitations#
Free Trial Limitations#
SquirroGPT is available as a free trial application subject to the following fair usage policy.
Users may:
Perform up to a maximum of 1000 trial SquirroGPT interactions.
Upload up to a maximum of 1000 documents (web pages) per application, with a maximum of 1GB of documents per user.
Use the application free for up to a maximum of 14 days.
Add up to a maximum of 10 trial users.
Professional Limitations#
SquirroGPT professional limitations are as follows:
Up to 10,000 SquirroGPT interactions per month (with a per interaction fee applying afterward).
Crawl as many web pages as you’d like, as long as individual pages don’t exceed 50MB and the total storage does not exceed 5GB/month up to 50GB total.
No limit to anonymous web users using embedded digital assistants (though usage is still limited by total interactions as per the first bullet point).
Reference: See SquirroGPT Pricing for more information on available plans and pricing.
Troubleshooting#
If you encounter any issues while using SquirroGPT, contact Technical Support via Squirro Support for help.