Toggle navigation sidebar
Toggle in-page Table of Contents
Overview
Squirro Profiles
System Administrator
Project Creator
Data Scientist
Model Creator
Python Engineer
Frontend Developer
Cognitive Search User
Squirro Products
Squirro Insight Engine
Squirro Cognitive Search
Squirro Sales Insights
Squirro for Salesforce
Squirro for Microsoft Outlook
Installation Guides
Squirro for Salesforce Installation
Salesforce Federated Search Installation
Microsoft Outlook Installation
Squirro A to Z
Squirro Glossary
Glossary of Industry Terms
Index
Get Technical
Administration
Configuration
Configuration Files
cluster.ini
common.ini
configuration.ini
convert.ini
datasource.ini
digestmailer.ini
emailsender.ini
filtering.ini
fingerprint.ini
frontend.ini
ingester.ini
topic.ini
Configuration Service
Configuration Interpolation
Securing Configuration Files
Securing Elasticsearch and MariaDB
Securing Redis Instance over SSL
Secure Configuration Guide
SSL Certificates
Changing the Default Language
Email Templates
Operations
Accessing Servers
Cluster Status
Monitoring
Activity Tracking
Managing Elasticsearch
Services
How Squirro Scales
Business Continuity Planning
Backing Up and Restoring Databases
Fixing MySQL/MariaDB Replication
External Authentication
Architecture for Authentication
SAML SSO for Squirro
Enabling and Disabling UI User Management
Query Templates
ADFS Setup
Azure Active Directory Setup
Google SAML Setup
Okta SAML Setup
Troubleshooting
Internet Explorer Compatibility Mode
Created Smart Filters Showing as Empty
Flushing Caches
Inserting Big Data into the MySQL Server
Investigating Performance Issues
Python Performance Profiling Using PySpy
Too Many Connections (MySQL)
APIs and SDKs
Squirro Client
SquirroClient Setup Class
User Management
UserApiMixin
APIs by Topic
CommunitiesMixin
CommunitySubscriptionsMixin
CommunityTypesMixin
ConfigurationMixin
ContributingRecordsMixin
DashboardsMixin
EmailTemplatesMixin
EnrichmentsMixin
EntitiesMixin
FacetsMixin
FileUploadMixin
GlobalTempMixin
MLCandidateSetMixin
MLGroundTruthMixin
MLModelsMixin
MLPublishMixin
MLSentenceSplitterMixin
MLTemplatesMixin
MLUserFeedbackMixin
MachineLearningMixin
ObjectsMixin
PipelineSectionsMixin
PipelineStatusMixin
PipelineWorkflowMixin
ProjectGuideFilesMixin
ProjectTranslationsMixin
ProjectsMixin
SavedSearchesMixin
SmartAnswersMixin
SmartfiltersMixin
SourcesMixin
SubscriptionsMixin
SuggestImageMixin
SynonymsMixin
TasksMixin
ThemesMixin
TopicApiBaseMixin
TrendDetectionMixin
WidgetsAndAssetsMixin
DocumentUploader Class
ItemUploader Class
Squirro Toolbox
Install In a Python Environment
squirro_asset CLI Reference
Bulk Exporter
Toolbox Differences Between macOS / Linux / Windows
JavaScript SDK
Plugin Repository
Item Format
Data Modeling
Catalyst Data Model
Architecture
Communities
Communities Tutorial
Setting Up Community Types
How to Set Up Communities Using KEE
CSV and Excel Formatting for Upload
Managing Communities
Visualizing Communities
Communities Augmentation
Community Auto-Subscription
Data Loading
UI Data Loader
Data Connectors
Built-In Data Connectors
1-Click Data Connectors
Atlassian Confluence Connector
Atlassian Jira Connector
Dropbox Connector
Google Drive Connector
Google Gmail Connector
Microsoft Exchange Connector
Microsoft One Drive Connector
Microsoft Sharepoint Connector
Salesforce Sales Cloud Connector
Salesforce Service Cloud Connector
Squirro Connector
Webz.io Connector
Data Loader Command Line Interface Tool
Data Loader Plugins
Data Loader Templates
Data Loader Plugin Boilerplate
API for Caching and Custom State Management
Data Loader Plugin Configuration
Data Loader Plugin Reference
Data Loader Plugin Dependencies
Example Data Loader Plugin
Incremental Loading
Data Loader Plugin Preview
Labels
Data Loading How-To Guides
Data Loader Command Line Interface Tool Tutorial
Writing a Custom Data Loader Plugin
How To Write a Custom 1-Click Connector
Data Processing Pipeline
Pipeline Overview
Pipeline Editor
Built-In Steps
Enrich Steps
Unshorten Link
Duplicate Detection
Content Augmentation
Content Extraction
PDF OCR
Noise Removal
Near Duplicate Detection
Thumbnail Extraction
Language Detection
PDF Conversion
Relate (KEE)
Discover (NLP Tagger)
Classify (from AI Studio)
Predict (Trend Detection)
Recommend
Automate
Index Steps
Content Standardization
Cache Cleaning
Indexing
Search Tagging and Alerting
Flow (Change Pipeline)
Custom Steps
Pipelets (Custom Step)
Squirro Scripts
Pipeline Reruns
Pipeline Prioritization
Indexing Common Formats
Trend Detection
Trend Detection Tutorial
Processing Errors
Installation and Upgrade
System Requirements
Installing Squirro on Linux
Squirro Cluster Expansion
Upgrading Squirro
Upgrading Configuration Conflicts
Upgrading Earlier Versions
Integrations
Atlassian (Confluence & Jira)
Dashboards
Embedding Dashboards
Custom Loaders
Custom Loaders API
Custom Sections API
Microsoft Dynamics, Sharepoint, and Office
Newsletters
OpenSearch API
PegaSystems - Pega
ServiceNow Insights
Qlik Sense
Tableau
Known Entity Extraction
KEE Studio Plugin
KEE Studio Plugin Tutorial
KEE CLI Tool
KEE CLI Tool Tutorial
KEE Configuration
Tokenizers and Filters
Testing
libNLP
Base Types
Query Processing
CustomSpacyNormalizer
LanguageDetection
LemmaExpander
POSBooster
QueryClassifier
QueryModifier
QuerySyntaxParser
QueryZeroShotClassifier
SemanticTermExpander
How to Create Custom Query-Processing Steps
Step Types
Standard Types
Analyzers Package
make_analyzer
Analyzer
ProximityValidation
Classifiers Package
make_classifier
BERTSentiment
Classifier
CosineSimilarityClassifier
FastTextClassifier
KFoldValidation
SklearnClassifier
SmartfilterClassifier
VaderSentiment
Debuggers Package
make_debugger
Debugger
LogFieldsDebugger
Embedders Package
make_embedder
BowEmbedder
Embedder
SklearnTFIDFEmbedder
TermsExtractionEmbedder
TransformerEmbedder
External Package
make_step
EndpointStep
MlflowMaasEndpointStep
NlpServiceQuestionAnswering
NlpServiceSpacy
Filters Package
make_filter
AggregateFilter
BlacklistFilter
CopyFilter
DocJoinFilter
DocSplitFilter
EmptyFilter
Filter
JoinFilter
MergeFilter
ProximityFilter
RegexFilter
SplitFilter
SquirroEntityFilter
ThresholdFilter
VoteFilter
WhitelistFilter
Flow Package
make_flow_step
ConditionStep
Loaders Package
make_loader
CSVLoader
FileLoader
JSONLoader
Loader
SquirroGroundtruthLoader
SquirroItemLoader
SquirroQueryLoader
Normalizers Package
make_normalizer
CharacterNormalizer
EmailParseNormalizer
HTMLNormalizer
LowercaseNormalizer
Normalizer
PunctuationNormalizer
SentimentTermNormalizer
SpacyNormalizer
StopwordsNormalizer
Projectors Package
make_projector
Projector
SklearnProjector
Runtimes Package
make_runtime_step
ONNXRuntime
Runtime
Savers Package
make_saver
CSVSaver
JSONSaver
Saver
SquirroEntityCleaner
SquirroItemSaver
Tokenizers Package
make_tokenizer
HtmlTokenizer
PdfSentencesTokenizer
SentencesNLTKTokenizer
SpacesTokenizer
Tokenizer
Utils
Standard Types
Cache Package
get_document_cache_client
get_model_cache_client
Cache
CacheDocument
CacheWithExpiration
ExpiringCache
MemoryCache
ModelCacheClient
Model Management Package
InMemModel
ModelNotInMemoryException
Transformers Package
get_transformer
Huggingface_Transformers
SentenceTransformer
Tensorflow_Transformer
Transformer
Troubleshooting & FAQ
Machine Learning
Model-as-a-Service
Example MLFlow Model
Pipelets
Development Workflow
Writing Pipelets
Rerunning a Pipelet
Pipelets Reference
Pipelets Tutorial
How to Access File Contents in Pipelets
How to Use Pipelets With the Squirro Data Loader
Troubleshooting and FAQ
Search
Document Relevancy
Query Processing
Query Syntax
Typeahead Suggestions
Question Answering
Other People Ask?
How-To Guides
How To Set Up a Cognitive Search Application
Business Environment Monitoring Quick-Start Guide
How to use Best-Bets Labels to Map Query Terms
How to Use The “Other People Ask” Feature
How to use the “Question Answering” Feature
How to handle User Query Terms correctly
How to Use Scoring Profiles to Customize Document Relevancy Scoring
Project Templates
Project Templates Overview
Project Configuration
Project Export & Import
User Interface
UI Overview
Squirro Roles & Permissions
Cluster Roles and Permissions for Self-Service
Squirro Spaces
Squirro Monitoring
How-To Guides
How to Register for a Squirro ID
How to Access a Squirro Online Demo
Widgets
Backbone Custom Widgets
Custom Widgets Life Cycle
Squirro Widget SDK
Core Widgets
Properties
Factories
Utils
Tutorials
Getting Started
Accessing Data
Common Knowledge
FAQ
Debugging
Models, Views, & Collections
JavaScript
Limitations & Workarounds
React Custom Widgets
Getting Started with React
Creating React Custom Widgets
Customizing React Custom Widgets
Squirro Storybook
Available Libraries
Available React Hooks
Styling React Components
React How-Tos and Walkthroughs
How To Opt In To React Widgets
How To Style React Widgets
Items Widget Styling Walkthrough
Adding Tooltips to Tabs Widget Walkthrough
Engage
Forum
Support
Redefining AI Podcast
Other
Website
Security
Terms & Conditions
Utils
Utils
#
Provides access to utils defined in libNLP.
Standard Types
base
checkpoint
classification_metrics
config
email_parsing
pdf_extract
sentence_splitting
squirro_utils
stopwords
tqdm
Cache Package
Functions
get_document_cache_client
get_model_cache_client
Classes
Cache
CacheDocument
CacheWithExpiration
ExpiringCache
MemoryCache
ModelCacheClient
Model Management Package
Classes
InMemModel
ModelNotInMemoryException
Transformers Package
Functions
get_transformer
Classes
Huggingface_Transformers
SentenceTransformer
Tensorflow_Transformer
Transformer
