Welcome to the Squirro Docs!

Squirro 3.10.6 LTS is now available!

Squirro’s latest long-term support release (LTS) is available as of July 26, 2024. For information on the latest features and improvements, see the 3.10.6 - Release Notes.

SquirroGPT Chat

Start chatting with Squirro Docs by clicking the icon in the bottom-right corner.

Navigate to the product page to learn more about SquirroGPT or jump directly to the SquirroGPT Data or SquirroGPT Web quick-start guides for installation and setup instructions.

Profiles

Project Creator

Project Creator

Python Engineer

Python Engineer

Frontend Developer

Frontend Developer

System Admin / DevOps

System Administrator/DevOps Engineer

Data Scientist

Data Scientist

Model Creator

Model Creator

Search Engineer

Search Engineer

Cognitive Search User

Cognitive Search User

Products

Insight Engine

Squirro Insight Engine

Cognitive Search

Squirro Cognitive Search

SquirroGPT

SquirroGPT

Sales Insights

Squirro Sales Insights

Squirro for Salesforce

Squirro for Salesforce

Squirro for MS Outlook

Squirro for Microsoft Outlook

Learn More at the Squirro Academy

Visit the Squirro Academy for technical and non-technical training and certification e-learning courses. Take guided courses, or learn at your own pace!

Navigate Your Own Way

You can navigate this site by selecting a profile that best fits your role on the Squirro platform, exploring content by individual Squirro product, or diving directly into Squirro’s technical content by topic.

If you have any questions about using Squirro or troubleshooting platform issues, head on over to the Squirro Forum for answers.

If you need further help, don’t hesitate to contact the friendly folks at Squirro Support.

Technical Docs

• Administration
  • Configuration
  • External Authentication
  • Operations
  • Troubleshooting
• Agent Framework
• AI Guardrails
• AI Studio
  • How-To Guides
  • Step 1: Ground Truth
  • Step 2: Models
  • Step 3: Publish and Deploy
  • Share Labeling Permissions
  • Bulk Labeling
  • ML Enrichments for Pipeline Workflows
  • Squirro Client Reference
• APIs and SDKs
  • SquirroClient (Python SDK)
  • Squirro Toolbox
  • Authentication
  • Catalyst Data Model
  • Common Headers
  • Common Status Codes
  • Data Modeling
  • Item Format
  • JavaScript SDK
  • Plugin Repository
  • Custom Sections API
• Architecture
  • Architecture Diagrams
  • General Concepts
• Collections
• Communities
  • Augmentation
  • Auto-Subscription
  • Communities Tutorial
  • CSV and Excel Formatting for Upload
  • Managing Communities
  • Setting Up Community Types
  • How To Set Up Using KEE
  • Visualizing Communities
• Dashboards
  • Dashboard Editor
  • Dashboard Store
  • Dashboard Types
  • Layers
  • Mobile Dashboard Editor
  • Permissions
  • Query Parameterization
  • Upgrading Dashboards Manually
  • Visibility Conditions
• Data Loading
  • How-To Guides
  • Command Line Tool
  • Connectors
  • Data Types
  • Date Format
  • Data Loader Reference
  • Format Strings
  • Labels
  • Plugins
  • Troubleshooting
  • UI Data Loader
• Data Processing Pipeline
  • Built-In Steps
  • Custom Steps
  • Indexing Common Formats
  • Content Streamers
  • Pipeline Editor
  • Pipeline Overview
  • Prioritization
  • Processing Errors
  • Reset Project
  • Reruns
  • Trend Detection
• Integrations
  • Atlassian (Confluence & Jira)
  • Embedding Dashboards
  • Microsoft Dynamics, Sharepoint, and Office
  • Newsletters
  • OpenSearch API
  • PegaSystems - Pega
  • Qlik Sense
  • ServiceNow Insights
  • Tableau
• Known Entity Extraction
  • Command Line Tool
  • Command Line Tool Tutorial
  • Configuration
  • Studio Plugin
  • Studio Plugin Tutorial
  • Testing
  • Tokenizers and Filters
• libNLP
  • Base Types
  • How to Create Custom Query-Processing Steps
  • Query Processing
  • Step Types
  • Troubleshooting & FAQ
  • Utils
• Machine Learning
  • Example MLFlow Model
  • How To Publish ML Models Using the Squirro Client
  • Model-as-a-Service
  • Significant Terms Extraction
• Pipelets
  • How-To Guides
  • Additional Labeling Pipelet
  • Development Workflow
  • Pipelets and the Dataloader
  • Pipelets Reference
  • Rerunning a Pipelet
  • Scaling Pipelet Execution
  • Time Formats Pipelet
  • Troubleshooting and FAQ
  • Writing Pipelets
• Privacy Layer
• Project Templates
  • Configuration
  • Export and Import
  • Overview
• Search
  • Features
  • How-To Guides
  • Document Relevancy
  • Query Processing
  • Recommendations
  • Smart Filters
  • Searchable File Types
  • Synonyms
• User Interface
  • App and Nav Bar Styling
  • Connecting to Squirro
  • Note Taking
  • Overview
  • Project Browser
  • Reference Screen
  • Roles & Permissions
  • Spaces
  • Squirro Monitoring
  • Studio
  • Themes
• Widgets
  • Built-In Widgets
  • Custom Widgets
  • How to Create a Custom Widget
  • Managing Widgets in the UI
  • Squirro Widget SDK
  • React Custom Widgets
  • Backbone Custom Widgets