Welcome to the Squirro Docs!

Profiles

Project Creator

Python Engineer

Frontend Developer

System Administrator

Data Scientist

Model Creator

Search Engineer

Cognitive Search User

Products

Insight Engine

Cognitive Search

Sales Insights

Squirro for Salesforce

Squirro for MS 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.

The current Squirro LTS release is 3.7.6 LTS.

The current biweekly release is 3.8.0.

Technical Docs

• Administration
  • Configuration
  • External Authentication
  • Operations
  • Troubleshooting
• AI Studio
  • How-To Guides
  • Step 1: Candidate Sets
  • Step 2: Ground Truth
  • Step 3: Models
  • Step 4: Validation
  • Step 5: Publish
  • Bulk Labeling
  • ML Enrichments for Pipeline Workflows
• 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
• 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
  • Visibility Conditions
• Data Loading
  • How-To Guides
  • Command Line Tool
  • Connectors
  • Data Types
  • Date Format
  • Data Loader Reference
  • Format Strings
  • Labels
  • Plugins
  • 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
  • Trend Detection Tutorial
• 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
• Project Templates
  • Configuration
  • Export and Import
  • Overview
• Search
  • Features
  • How-To Guides
  • Document Relevancy
  • Query Processing
  • Recommendations
  • Smart Filters
  • Synonyms
• User Interface
  • App and Nav Bar Styling
  • Connecting to Squirro
  • Explore Dashboard
  • 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