logo

Overview

  • Getting Started with Squirro
  • Squirro Profiles
    • System Administrator/DevOps Engineer
    • Project Creator
    • Data Scientist
    • Model Creator
    • Search Engineer
    • Python Engineer
    • Frontend Developer
    • Cognitive Search User
  • Squirro Products
    • Squirro Insight Engine
    • Squirro Cognitive Search
    • SquirroGPT
    • 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
  • Squirro Academy

Getting Squirro

  • Installation and Upgrade
    • Cluster Expansion
    • Elasticsearch Migration
    • Installing Squirro Using Ansible
    • Installing Squirro on Linux
    • System Requirements
    • Upgrading
    • Upgrading Configuration Conflicts
    • Upgrading Earlier Versions
  • Squirro Self-Service
    • How-To Guides
      • SquirroGPT Data Guide
      • SquirroGPT Web Guide
      • Install an Application
      • Open a Demo
      • Launch a Test Drive
      • Register for a Squirro ID
    • Cluster Roles and Permissions
    • Email Domain-Based Permissions
    • Instances
    • Upgrading an Instance
  • Release Notes
    • 3.9.1 (Latest Biweekly Release)
      • Squirro 3.9.x Release Notes
        • 3.9.0 Release Notes
        • 3.9.1 Release Notes
      • 3.9.2 Release Notes
    • 3.8.7 LTS (Latest LTS Release)
      • Squirro 3.8.x Release Notes
        • 3.8.0 - Release Notes
        • 3.8.1 - Release Notes
        • 3.8.2 - Release Notes
        • 3.8.3 - Release Notes
        • 3.8.4 - Release Notes
        • 3.8.5 - Release Notes
      • 3.8.6 LTS Release Notes
      • 3.8.7 LTS Release Notes
    • 3.7.6 LTS
      • 3.7.6 LTS - Release Notes
      • 3.7.5 LTS Release Notes
      • Squirro 3.7.x Release Notes
        • 3.7.1 - Release Notes
        • 3.7.2 - Release Notes
        • 3.7.3 - Release Notes
        • 3.7.4 - Release Notes
    • 3.6.8 LTS
      • 3.6.8 LTS Release Notes
      • Squirro 3.6.8 LTS - Cognitive Search Improvements
      • Squirro 3.6.x Release Notes
        • 3.6.0 - Release Notes
        • 3.6.1 - Release Notes
        • 3.6.2 - Release Notes
        • 3.6.3 - Release Notes
        • 3.6.4 - Release Notes
        • 3.6.5 - Release Notes
        • 3.6.6 - Release Notes
    • 3.5.8 LTS
      • 3.5.8 LTS Release Notes
      • 3.5.8 LTS - Cognitive Search Improvements
      • 3.5.9 LTS - Release Notes
      • 3.5.x Release Notes
        • 3.5.7 Release Notes
        • 3.5.6 Release Notes
        • 3.5.5 Release Notes
        • 3.5.4 Release Notes
        • 3.5.3 Release Notes
        • 3.5.2 Release Notes
        • 3.5.1 Release Notes
        • 3.5.0 Release Notes
    • 3.4.7 LTS
      • 3.4.7 LTS Release Notes
        • 3.4.X Release Notes
      • 3.4.X Release Notes
        • 3.4.0 Release Notes
        • 3.4.1 Release Notes
        • 3.4.2 Release Notes
        • 3.4.3 Release Notes
        • 3.4.4 Release Notes
        • 3.4.5 Release Notes
        • 3.4.6 Release Notes
    • Older Release Notes
    • SquirroGPT Release Highlights
    • Squirro Release Process

Technical Docs

  • 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
      • Default Language
      • Email Templates
      • Enable Proxy Server for Outgoing Calls
      • High Performance Configuration
      • Interpolation
      • Securing Configuration Files
      • Secure Configuration Guide
      • Securing Redis Instance over SSL
      • SSL Certificates
    • External Authentication
      • Architecture for Authentication
      • Query Templates
      • User Management in the UI
      • SAML SSO for Squirro
      • - ADFS Setup
      • - Azure Setup
      • - Google Setup
      • - Okta Setup
    • Operations
      • Accessing Servers
      • Activity Tracking
      • Business Continuity Planning
      • Cluster Status
      • Database Backup and Restore
      • Reindexing Elasticsearch
      • Elasticsearch Management
      • Fixing MySQL/MariaDB Replication
      • How Squirro Scales
      • Monitoring
      • Services
    • Troubleshooting
      • Internet Explorer Compatibility
      • Investigating Performance Issues
      • MySQL Big Data Management
      • MySQL Too Many Connections
      • Flushing Caches
      • Python Performance Profiling Using PySpy
      • Smart Filters Showing as Empty
  • AI Studio
    • How-To Guides
      • Bulk Labeling
      • Create Document-Level Models
      • Create Sentence-Level Models
      • Integrating a Custom ML CLassifier
      • Interact with Squirro Using Jupyter Notebook
    • 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)
      • APIs by Topic
        • CommunitiesMixin
        • CommunitySubscriptionsMixin
        • CommunityTypesMixin
        • ConfigurationMixin
        • ContributingRecordsMixin
        • DashboardsMixin
        • EmailTemplatesMixin
        • EnrichmentsMixin
        • EntitiesMixin
        • FacetsMixin
        • FileUploadMixin
        • GlobalTempMixin
        • MLCandidateSetMixin
        • MLGroundTruthMixin
        • MLModelsMixin
        • MLPublishMixin
        • MLSentenceSplitterMixin
        • MLTemplatesMixin
        • MLUserFeedbackMixin
        • MachineLearningMixin
        • NotesMixin
        • ObjectsMixin
        • PipelineSectionsMixin
        • PipelineStatusMixin
        • PipelineWorkflowMixin
        • ProjectGuideFilesMixin
        • ProjectTranslationsMixin
        • ProjectsMixin
        • SavedSearchesMixin
        • SmartAnswersMixin
        • SmartfiltersMixin
        • SourcesMixin
        • SubscriptionsMixin
        • SuggestImageMixin
        • SynonymsMixin
        • TasksMixin
        • ThemesMixin
        • TopicApiBaseMixin
        • TrendDetectionMixin
        • WidgetsAndAssetsMixin
      • DocumentUploader Class
      • Installation
      • ItemUploader Class
      • Setup Class
      • SquirroClient Tutorial
      • User Management
        • UserApiMixin
    • Squirro Toolbox
      • Bulk Exporter
      • Install In a Python Environment
      • squirro_asset CLI Reference
      • Toolbox Differences Between macOS / Linux / Windows
    • 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
      • Community 360 Dashboard
      • Explore Dashboard
      • Global Search Dashboard
      • Layout Master Dashboard
    • Layers
    • Mobile Dashboard Editor
    • Permissions
    • Query Parameterization
    • Upgrading Dashboards Manually
    • Visibility Conditions
  • Data Loading
    • How-To Guides
      • CLI Tool Tutorial
      • Creating a Custom Connector
      • Creating a Custom Plugin
      • Labels Tutorial
      • UI Data Loading Guide
    • Command Line Tool
    • Connectors
      • Built-In Data Connectors
        • CSV Connector
        • Documents Connector
        • Excel Connector
        • Squirro Connector
        • Web Crawler Connector
      • Cloud Connectors
        • Dropbox Connector
        • Google Drive Connector
        • Microsoft One Drive Connector
      • Enterprise Connectors
        • Atlassian Confluence Connector
        • Atlassian Jira Connector
        • Google Gmail Connector
        • Microsoft Exchange Connector
        • Microsoft Sharepoint Connector
        • Salesforce Sales Cloud Connector
        • Salesforce Service Cloud Connector
        • Webz.io Connector
    • Data Types
    • Date Format
    • Data Loader Reference
    • Format Strings
    • Labels
    • Plugins
      • API for Caching and Custom State Management
      • Boilerplate
      • Configuration
      • DataSource Class Reference
      • Dependencies
      • Example Data Loader Plugin
      • Incremental Loading
      • Preview
      • Templates
    • Troubleshooting
    • UI Data Loader
  • Data Processing Pipeline
    • Built-In Steps
      • Load
      • Enrich Steps
        • Unshorten Link
        • Duplicate Detection
        • Content Augmentation
        • Content Extraction
        • PDF OCR
        • Noise Removal
        • Near Duplicate Detection
        • Thumbnail Extraction
        • Language Detection
        • PDF Conversion
      • Relate
      • Discover
      • Claissfy
      • Predict
      • Recommend
      • Automate
      • Index Steps
        • Content Standardization
        • Cache Cleaning
        • Indexing
        • Search Tagging and Alerting
      • Flow
    • Custom Steps
      • Pipelets (Custom Step)
      • Squirro Scripts
    • 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
    • PoolParty Knowledge Graph
    • 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
      • CustomSpacyNormalizer
      • LanguageDetection
      • LemmaExpander
      • POSBooster
      • QueryClassifier
      • QueryModifier
      • QuerySyntaxParser
      • QueryZeroShotClassifier
      • SemanticTermExpander
    • Step Types
      • Standard Types
      • Analyzers Package
        • make_analyzer
        • Analyzer
        • ProximityValidation
      • Classifiers Package
        • make_classifier
        • AutoMLClassifier
        • 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
        • RemoteQuestionAnswering
        • RemoteSpacy
      • 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
    • Troubleshooting & FAQ
    • 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
  • 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
      • Pipelets Tutorial
      • How to Access File Contents in Pipelets
      • How to Use Pipelets With the Squirro Data Loader
    • 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
      • Concept Search
      • Other People Ask
      • Popular Query Suggestions
      • Question Answering
      • Query Syntax
      • Search Bar Chips
      • Semantic and Hybrid Search
      • Spellchecking
      • Typeahead Suggestions
    • How-To Guides
      • BEM Quick Start
      • Best-Bets Labels
      • Cognitive Search Set Up
      • Configure Other People Ask
      • Configure Question Answering
      • Configure Scoring Profiles for Document Relevancy
      • Handle Query Terms
    • Document Relevancy
      • Scoring Profiles and Roles
      • Scoring Plugins
        • Recommend
        • Rerank
        • Retrieve
        • View
    • 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
      • ML Workflows
      • ML Jobs
    • Themes
  • Widgets
    • Built-In Widgets
      • Action Widget
      • Bar Chart Widget
      • Breadcrumbs Widget
      • Cards Widget
      • Communities Widget
      • Communities Banner Widget
      • Community Headlines Widget
      • Data Labeling Lane Widget
      • Divider Widget
      • Engagement Map Widget
      • Entities Widget
      • Favorites Widget
      • Heat Map Widget
      • HTML Editor Widget
      • iFrame Widget
      • Item Detail Widget
      • Items Table Widget
      • Items Widget
      • Kanban Lane Widget
      • Labels Widget
      • Line Chart Widget
      • Metrics Widget
      • Navigation Chips Widget
      • Pie Chart Widget
      • QA Widget
      • REC Explanations Widget
      • REC Input Widget
      • REC Results Widget
      • Region Map Widget
      • Reset Filters Widget
      • Result List Widget
      • Rich Text Editor Widget
      • Sample Text Labeller Widget
      • Search Bar Widget
      • Significant Terms Widget
      • Similar Searches Widget
      • Smart Filters Widget
      • Spelling Correction Widget
      • Table Widget
      • Tabs Widget
      • Time Selection Widget
      • Timeline Widget
      • Topic Cluster Widget
      • Trend Widget
      • Trends List Widget
      • Word Cloud Widget
      • World Map Widget
    • Custom Widgets
    • How to Create a Custom Widget
    • Managing Widgets in the UI
    • Squirro Widget SDK
      • Core Widgets
      • Properties
      • Factories
      • Utils
    • React Custom Widgets
      • 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
      • Available React Hooks
      • Available Libraries
      • Creating Custom Widgets
      • Customizing Widgets
      • Getting Started with React
      • Squirro Storybook
      • Styling React Components
    • Backbone Custom Widgets
      • Custom Widgets Life Cycle
      • Custom Widgets for Dashboards
      • Squirro Widget CLI Reference
      • Custom Widgets and the Dashboard Store
      • Example Card or Result List Custom Widget
      • Tutorials
        • Getting Started
        • Accessing Data
      • Common Knowledge
        • FAQ
        • Debugging
        • Models, Views, & Collections
        • JavaScript
        • Limitations & Workarounds

Engage

  • Forum
  • Support
  • Redefining AI Podcast

Other

  • SquirroGPT on Squirro Docs
  • Squirro Website
  • Terms & Conditions
  • Security
    • Security Advisories
      • CVE-2021-27945 - Cross-Site Scripting
      • CVE-2021-44228 - log4j Security Vulnerability

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

By Squirro AG
© Copyright 2023, Squirro AG.