# Squirro Documentation

> Reference documentation for the Squirro enterprise generative AI platform: enterprise search, conversational AI, agents, data loading and processing, and platform administration.

Documentation version: latest.

Every page in this list is available as Markdown at the URL shown, and as HTML at the same path with a `.html` extension.

## Overview

- [Squirro Documentation](https://docs.squirro.com/en/latest/index.md): Reference information, code examples, and how-to guides for all Squirro technology and products, including the Squirro Insight Engine, Enterprise Search, and Squirro Chat.
- [Squirro Academy](https://docs.squirro.com/en/latest/academy.md): Squirro offers educational resources and training in three areas
- [Monthly Changelog](https://docs.squirro.com/en/latest/changelog.md): This page lists the changes to the Squirro documentation, grouped by month.
- [Weekly Changelog](https://docs.squirro.com/en/latest/changelog-weekly.md): This page lists the changes to the Squirro documentation over the last 12 weeks, grouped by week.
- [Squirro Chat Web on Squirro Docs](https://docs.squirro.com/en/latest/squirrogpt-docs.md): As of October 2023, you can find Squirro Chat Web built directly into the Squirro Docs website!

## Squirro A to Z

- [Squirro A to Z](https://docs.squirro.com/en/latest/a-z/index.md): Looking for something specific?
- [Glossary of Industry Terms](https://docs.squirro.com/en/latest/a-z/industry-glossary.md): This glossary explains industry terminology that is used in Squirro’s documentation.
- [Squirro Glossary](https://docs.squirro.com/en/latest/a-z/squirro-glossary.md): This glossary explains Squirro-specific terminology, that is used in Squirro’s documentation.

## Api

- [CustomSpacyNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.CustomSpacyNormalizer.md): Override Spacy Tokenizer to NOT split tokens by / or - characters.
- [IntentDetector](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.IntentDetector.md): doc (Document) – Document
- [LanguageDetection](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.LanguageDetection.md): Perform language detection on document.
- [LemmaExpander](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.LemmaExpander.md): Keep track of lemmatised version of relevant terms.
- [POSBooster](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.POSBooster.md): Perform term level boosting and cleaning based on detected POS tags.
- [QueryClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.QueryClassifier.md): Step that uses ONNX model to infer the type of the query.
- [QueryModifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.QueryModifier.md): Modify raw query using metadata collected from prior steps.
- [QuerySyntaxParser](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.QuerySyntaxParser.md): Parse query to separate User-Query-Terms from filter tokens.
- [QueryZeroShotClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.QueryZeroShotClassifier.md): Classify query into predefined classes using zero-shot-classification.
- [SemanticTermExpander](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.apps.query_processing.SemanticTermExpander.md): Find and add synonyms dynamically via (domain-specific) language models.
- [Analyzer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.analyzers.Analyzer.md): The base Analyzer is a Step that judges the accuracy of a given labeling task.
- [ProximityValidation](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.analyzers.ProximityValidation.md): The proximity validation Analyzer creates the necessary files for the metrics and confusion matrix in the AI Studio Validation screens.
- [make_analyzer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.analyzers.make_analyzer.md): config (dict) – step config
- [AutoMLClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.AutoMLClassifier.md): The AutoML Classifier uses the autogluon tabular library for AutoML
- [BERTSentiment](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.BERTSentiment.md): The BERT Sentiment Classifier detects the sentiments of a text fragment using transformer bases pre-trained models.
- [Classifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.Classifier.md): Classifier steps attempt to guess a specified label_field given an input_field or input_fields.
- [CosineSimilarityClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.CosineSimilarityClassifier.md): The cosine similarity Classifier uses the cosine similarity to decide which text fragment is closest to which class.
- [FastTextClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.FastTextClassifier.md): The fastText Classifier uses the fastText library for text embedding and classification provided by Facebook’s AI Research lab.
- [KFoldValidation](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.KFoldValidation.md): The k-fold validation Classifier wrapper executes the specified Classifier into the k-fold validation principle.
- [SklearnClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.SklearnClassifier.md): The sklearn Classifier is a generic scikit-learn classifier.
- [SmartfilterClassifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.SmartfilterClassifier.md): The smartfilter Classifier uses the Elastic Search based highlight tags <squirro:highlight> and </squirro:highlight> to classify text fragments.
- [VaderSentiment](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.VaderSentiment.md): The Vader Sentiment Classifier applies rule based sentiment analysis (positive, neutral, negative) on a string.
- [make_classifier](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.classifiers.make_classifier.md): config (dict) – step config
- [Debugger](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.debuggers.Debugger.md): The Debugger step allows for the debugging of the Document at different stages of the Pipeline.
- [LogFieldsDebugger](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.debuggers.LogFieldsDebugger.md): The field Debugger logs values of different fields of the Document at different stages of the Pipeline.
- [make_debugger](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.debuggers.make_debugger.md): config (dict) – step config
- [BowEmbedder](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.embedders.BowEmbedder.md): The bag of words Embedder encodes provided text based on gensim doc2bow.
- [Embedder](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.embedders.Embedder.md): The Embedder step converts a word or phrase into a vector of numbers.
- [SklearnTFIDFEmbedder](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.embedders.SklearnTFIDFEmbedder.md): The TFIDF Embedder encodes provided text based on the sklearn TFIDF-Vectorizer.
- [TermsExtractionEmbedder](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.embedders.TermsExtractionEmbedder.md): The term extraction Embedder allows to extract significant terms provided textual data.
- [TransformerEmbedder](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.embedders.TransformerEmbedder.md): The transformer Embedder encodes text based on a pre-trained transformers model.
- [make_embedder](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.embedders.make_embedder.md): config (dict) – step config
- [EndpointStep](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.external.EndpointStep.md): Step that uses an external API endpoint.
- [MlflowMaasEndpointStep](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.external.MlflowMaasEndpointStep.md): Step that uses an external MLFlow based MaaS API endpoint.
- [RemoteQuestionAnswering](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.external.RemoteQuestionAnswering.md): Step that uses an external API endpoint.
- [RemoteSpacy](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.external.RemoteSpacy.md): Step that uses an external API endpoint.
- [make_step](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.external.make_step.md): config (dict) – step config
- [AggregateFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.AggregateFilter.md): The aggregate Filter concatenates / sums up the field values of the aggregated_fields grouped by the value of the aggregating_field
- [BlacklistFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.BlacklistFilter.md): The blacklist Filter removes a Document or marks a Document to be skip based on a blacklist
- [CoalesceFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.CoalesceFilter.md): The coalesce Filter returns the first value which is set from a list of fields.
- [CopyFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.CopyFilter.md): The copy Filter copies input fields into output fields with copy.deepcopy
- [DocJoinFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.DocJoinFilter.md): The doc_join Filter joins multiple Document into one Document via id or a specified field.
- [DocSplitFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.DocSplitFilter.md): The doc_split Filter splits a single Document into many via iterable fields of the same length.
- [EmptyFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.EmptyFilter.md): The empty Filter removes a Document or marks a Document to skip based on empty fields
- [EntityAggregatorFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.EntityAggregatorFilter.md): The entity aggregator Filter creates a structured prediction field based on detected entities.
- [Filter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.Filter.md): The Filter steps take the stream of Document and filter out specific entries based on the criteria of the step or perform reduction/enlargment operations on fields and Document.
- [JoinFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.JoinFilter.md): The join Filter joins a list to a string
- [MergeFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.MergeFilter.md): The merge Filter merges multiple fields into a single field
- [NerEntityFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.NerEntityFilter.md): [ { “start”: int, “end”: int, “label”: str, “text”: str }, … ]
- [OffsetMappingFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.OffsetMappingFilter.md): [ { “start”: int, “end”: int, “label”: str, “text”: str }, … ]
- [ProximityFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.ProximityFilter.md): The proximity RegexFilter filters all Document by checking if terms exist within a specified proximity.
- [PyMuPDFEntityBBoxFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.PyMuPDFEntityBBoxFilter.md): After SquirroEntityFilter has created entities with offsets/lengths, this step uses PyMuPDF to compute precise bounding boxes and fills in page_to_rects for each extract.
- [RegexFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.RegexFilter.md): The regex Filter filters documents based on a supplied list of blacklist and whitelist regexes
- [SplitFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.SplitFilter.md): The splits filter splits the string based field into a list
- [SquirroEntityFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.SquirroEntityFilter.md): The Squirro entitiy Filter takes a set of fields and creates the Squirro entities structure
- [ThresholdFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.ThresholdFilter.md): The threshold Filter removes weighted facets with values below threshold.
- [VoteFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.VoteFilter.md): The vote Filter assigns a single value by majority vote from a list of values (e.g. [["positive"],["negative"],["positive"]] -> ["positive"], ["positive", "negative", "negative"] -> ["negative"]).
- [WhitelistFilter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.WhitelistFilter.md): The whitelist Filter removes a Document or marks a Document to be skip based on a whitelist
- [make_filter](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.filters.make_filter.md): config (dict) – step config
- [ConditionStep](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.flow.ConditionStep.md): Step that executes other steps based on provided condition.
- [make_flow_step](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.flow.make_flow_step.md): config (dict) – step config
- [CSVLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.CSVLoader.md): The CSV Loader loads CSV files and transforms the data into Document items.
- [FileLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.FileLoader.md): The file Loader looks in a specified directory_field directory for files and loads these files either line by line or as a whole and transforms them into Document items.
- [JSONLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.JSONLoader.md): The JSON Loader loads JSON files and transforms the data into Document items.
- [Loader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.Loader.md): The Loader step adds Document to the Pipeline stream.
- [SquirroGroundtruthLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.SquirroGroundtruthLoader.md): Loads items from a Squirro Ground Truth into Document items.
- [SquirroItemLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.SquirroItemLoader.md): Loads in a list of items (with the data structure of a Squirro Item) and transforms them to Document items.
- [SquirroNERGroundtruthLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.SquirroNERGroundtruthLoader.md): Bases: SquirroQueryLoader
- [SquirroQueryLoader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.SquirroQueryLoader.md): Loads items from a Squirro instance using the SquirroClient and transforms the items into Document items.
- [make_loader](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.loaders.make_loader.md): config (dict) – step config
- [CharacterNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.CharacterNormalizer.md): The character Normalizer removes numeric digits
- [EmailParseNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.EmailParseNormalizer.md): The email parse Normalizer parses an string which is based on a email to extract the email body.
- [HTMLMappingNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.HTMLMappingNormalizer.md): The HTML Normalizer removes HTML markup
- [HTMLNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.HTMLNormalizer.md): The HTML Normalizer removes HTML markup
- [LowercaseNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.LowercaseNormalizer.md): The lowercase Normalizer lowercases everything
- [Normalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.Normalizer.md): The Normalizer step applies specific normalizations to fields for each Document.
- [PunctuationNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.PunctuationNormalizer.md): The punctuation Normalizer strips punctuation from text
- [SentimentTermNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.SentimentTermNormalizer.md): Extracts positive and negative terms/phrases from given text.
- [SpacyNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.SpacyNormalizer.md): Multi-Lingual Spacy Text Analyzer.
- [StopwordsNormalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.StopwordsNormalizer.md): The stopwords Normalizer strips stopwords from the text
- [make_normalizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.normalizers.make_normalizer.md): config (dict) – step config
- [Projector](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.projectors.Projector.md): The Projector step projects from one vector space to another.
- [SklearnProjector](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.projectors.SklearnProjector.md): The generic scikit-learn Projector step projects from one vector space to another.
- [make_projector](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.projectors.make_projector.md): config (dict) – step config
- [ONNXRuntime](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.runtimes.ONNXRuntime.md): Step that process data using models in the ONNX format (https://onnx.ai/).
- [Runtime](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.runtimes.Runtime.md): The Runtime step executes inference on a particular runtime.
- [make_runtime_step](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.runtimes.make_runtime_step.md): config (dict) – step config
- [CSVSaver](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.savers.CSVSaver.md): Saves all Document to a specified output_file in CSV format
- [JSONSaver](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.savers.JSONSaver.md): Saves all Document to a specified output_file in JSON format
- [Saver](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.savers.Saver.md): The Saver step saves specified fields to some external store for each Document.
- [SquirroEntityCleaner](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.savers.SquirroEntityCleaner.md): Removes Squirro entities that match the field properties.
- [SquirroItemSaver](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.savers.SquirroItemSaver.md): Converts libNLP Document to Squirro items and saves them to a Squirrinstance
- [make_saver](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.savers.make_saver.md): config (dict) – step config
- [HtmlTokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.HtmlTokenizer.md): The HTML Tokenizer splits the input fields by HTML tags into sentences.
- [PdfPagesTokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.PdfPagesTokenizer.md): PDF Pages Extractor: reads each PDF in your files field and extracts full-page text content using PyMuPDF (fitz).
- [PdfSentencesTokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.PdfSentencesTokenizer.md): PDF Sentences Tokenizer splits the PDF files by sentences and keeps track of the positional information of the extracted sentences.
- [SentencesNLTKTokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.SentencesNLTKTokenizer.md): Sentences Tokenizer splits the input fields by sentences with NLTK and additional custom rules.
- [SpacesTokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.SpacesTokenizer.md): Spaces Tokenizer that splits the input fields on spaces.
- [Tokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.Tokenizer.md): The Tokenizer step takes specified fields and splits them into tokens to be used by a downstream step.
- [make_tokenizer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.steps.tokenizers.make_tokenizer.md): config (dict) – step config
- [Cache](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.cache.Cache.md)
- [CacheWithExpiration](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.cache.CacheWithExpiration.md)
- [ExpiringCache](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.cache.ExpiringCache.md): Bases: CacheWithExpiration
- [MemoryCache](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.cache.MemoryCache.md): A simplistic cache which stores objects in memory.
- [ModelCacheClient](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.cache.ModelCacheClient.md): Cache client to enable model sharing across whole process.
- [get_model_cache_client](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.cache.get_model_cache_client.md)
- [InMemModel](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.model_management.InMemModel.md): Deprecated class.
- [ModelNotInMemoryException](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.model_management.ModelNotInMemoryException.md)
- [Huggingface_Transformers](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.transformers.Huggingface_Transformers.md)
- [SentenceTransformer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.transformers.SentenceTransformer.md)
- [Tensorflow_Transformer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.transformers.Tensorflow_Transformer.md)
- [Transformer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.transformers.Transformer.md)
- [get_transformer](https://docs.squirro.com/en/latest/api/squirro.lib.nlp.utils.transformers.get_transformer.md)
- [GenAIApiMixin](https://docs.squirro.com/en/latest/api/squirro_client.genai.GenAIApiMixin.md): Create a new Squirro Chat Agent.
- [CollectionsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.CollectionsMixin.md): Mixin for collection related API calls.
- [CommunitiesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.CommunitiesMixin.md): A dictionary of the created community.
- [CommunitySubscriptionsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.CommunitySubscriptionsMixin.md): Deletes a community subscription
- [CommunityTypesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.CommunityTypesMixin.md): Returns a community types for a project given the community_type_id
- [ConfigurationMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.ConfigurationMixin.md): Delete the given configuration key from the project namespace.
- [DashboardsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.DashboardsMixin.md): (re)Create dashboard permissions for a specific project.
- [EmailTemplatesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.EmailTemplatesMixin.md): template_name – str, the name of the template
- [EnrichmentsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.EnrichmentsMixin.md): Create a new enrichment on the project.
- [EntitiesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.EntitiesMixin.md): entity_list – [entity, …]
- [FacetsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.FacetsMixin.md): Retrieves a facet of project project_id.
- [FileUploadMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.FileUploadMixin.md): storage_url – Storage URL of the file to delete.
- [GlobalTempMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.GlobalTempMixin.md): Returns the content of the temp file with the name filename.
- [MLCandidateSetMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLCandidateSetMixin.md): Return single Candidate Set.
- [MLGraphiteMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLGraphiteMixin.md): Mixin for interacting with Graphite resources.
- [MLGroundTruthMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLGroundTruthMixin.md): Get a single Ground Truth.
- [MLModelsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLModelsMixin.md): Get new bulk labeling status.
- [MLNerMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLNerMixin.md): Mixin for interacting with NER groundtruths, categories, labels, and models.
- [MLPublishMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLPublishMixin.md): Returns the details of the a published model.
- [MLSentenceSplitterMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLSentenceSplitterMixin.md): Return all available Sentence Splitter.
- [MLTemplatesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLTemplatesMixin.md): Returns a single Template
- [MLUserFeedbackMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MLUserFeedbackMixin.md): Get a single User Feedback.
- [MachineLearningMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.MachineLearningMixin.md): Clone the Machine Learning Workflow.
- [NotesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.NotesMixin.md): Create a new Comment for the Note.
- [ObjectsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.ObjectsMixin.md): DEPRECATED: objects no longer exist.
- [PipelineSectionsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.PipelineSectionsMixin.md): Return all the pipeline sections for project with project_id.
- [PipelineStatusMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.PipelineStatusMixin.md): Returns all or the specified status sections of the ingester status.
- [PipelineWorkflowMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.PipelineWorkflowMixin.md): Updates a pipeline workflow with a published model from AI Studio.
- [ProjectGuideFilesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.ProjectGuideFilesMixin.md): Deletes the Project Guide file.
- [ProjectTranslationsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.ProjectTranslationsMixin.md): Get language translations for the provided project.
- [ProjectsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.ProjectsMixin.md): project_id – Project identifier.
- [SavedSearchesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.SavedSearchesMixin.md): Get saved search details.
- [ScanContext](https://docs.squirro.com/en/latest/api/squirro_client.topic.ScanContext.md): Bases: AbstractContextManager[Iterator[T]], Generator[T, None, None], Generic[T]
- [SmartAnswersMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.SmartAnswersMixin.md): Find similar searches in popular queries given the input query
- [SourcesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.SourcesMixin.md): Delete an existing Source.
- [SubscriptionsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.SubscriptionsMixin.md): DEPRECATED: subscriptions no longer exist.
- [SuggestImageMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.SuggestImageMixin.md): Returns image in byte format for an image_url :type project_id: :param project_id: Project Identifier :type image_url: :param image_url: url of an image
- [SynonymsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.SynonymsMixin.md): Returns all synonym lists for a particular project.
- [TasksMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.TasksMixin.md): Create a scheduled task.
- [ThemesMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.ThemesMixin.md): Delete a specific dashboard theme from the given project.
- [TopicApiBaseMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.TopicApiBaseMixin.md): Ensure the user has the right permissions on the project.
- [WidgetsAndAssetsMixin](https://docs.squirro.com/en/latest/api/squirro_client.topic.WidgetsAndAssetsMixin.md): Delete a specific custom asset.
- [UserApiMixin](https://docs.squirro.com/en/latest/api/squirro_client.user.UserApiMixin.md): Mixin class which encapsulates the functionality of the user API service.

## Features

- [Squirro Classifier](https://docs.squirro.com/en/latest/features/squirro-classifier.md): Squirro Classifier is a cutting-edge feature that harnesses the power of Named Entity Recognition (NER) to automatically identify and categorize key entities within your text data.

## Getting

- [Automate the Backup of Elasticsearch](https://docs.squirro.com/en/latest/getting/install/ansible/backup-restore.md): This page describes how to configure and automate the backup of Elasticsearch.
- [Secure Elasticsearch with SSL/TLS](https://docs.squirro.com/en/latest/getting/install/ansible/elasticsearch-tls.md): This guide will walk you through how to secure your multi-node Elasticsearch cluster with SSL/TLS.
- [Leveraging NVMe SSDs for Elasticsearch speed](https://docs.squirro.com/en/latest/getting/install/ansible/elasticsearch-volatile-nvme.md): By default the cloud providers use software defined storage (SDS) to provide a virtual block device to the virtual machine.
- [Install and Manage Squirro with Ansible](https://docs.squirro.com/en/latest/getting/install/ansible/index.md): This page provides instructions on how to install Squirro using Red Hat’s Ansible Automation Platform.
- [Ansible Quickstart Examples](https://docs.squirro.com/en/latest/getting/install/ansible/quickstart-examples.md): This section contains examples for how to set up a Squirro installation using Ansible.
- [Ansible Role Variables Reference](https://docs.squirro.com/en/latest/getting/install/ansible/variable-reference.md): The following variables can be set to control the squirro-ansible roles behavior.
- [Squirro AWS Installation Manual](https://docs.squirro.com/en/latest/getting/install/aws-installation.md): This document walks you through a step-by-step installation of the latest Squirro LTS release on Amazon Web Services.
- [Squirro Azure Installation Manual](https://docs.squirro.com/en/latest/getting/install/azure-installation.md): This document walks you through a step-by-step installation of the latest Squirro LTS release on Microsoft Azure.
- [Cluster Expansion](https://docs.squirro.com/en/latest/getting/install/cluster-expansion.md): This page details how to add cluster nodes to a Squirro installation.
- [Container Reference](https://docs.squirro.com/en/latest/getting/install/containers/container-reference.md): The Squirro container images use the following volumes to persist data.
- [Deploying Squirro using Containers](https://docs.squirro.com/en/latest/getting/install/containers/index.md): This page provides instructions on how to deploy Squirro using containers.
- [Squirro Minimal Container Image](https://docs.squirro.com/en/latest/getting/install/containers/squirro-minimal.md): Squirro Minimal is, as the name suggests, a minimal container image you can use for testing, development purposes, and very minimal production deployments.
- [Elasticsearch Migration](https://docs.squirro.com/en/latest/getting/install/elasticsearch-migration.md): Starting from Release 3.13.5, Squirro storage nodes use Elasticsearch 9.x.
- [Installation and Upgrade](https://docs.squirro.com/en/latest/getting/install/index.md): This page provides links to information about installing and upgrading Squirro.
- [Installing Squirro on Linux](https://docs.squirro.com/en/latest/getting/install/linux.md): A Squirro cluster can contain anywhere from just one to dozens of servers.
- [Post-Installation Checklist](https://docs.squirro.com/en/latest/getting/install/post-installation-checklist.md): After the installation completes, your Squirro instance is running but not yet secured or fully configured.
- [Configure PostgreSQL as the Database Backend](https://docs.squirro.com/en/latest/getting/install/postgresql.md): Squirro supports PostgreSQL as an alternative SQL database backend to MariaDB.
- [System Requirements](https://docs.squirro.com/en/latest/getting/install/system-requirements.md): This page lists the requirements your environment must meet before installing Squirro.
- [Third-Party Component Versions](https://docs.squirro.com/en/latest/getting/install/third-party-components.md): Squirro installs a set of third-party components alongside the platform services.
- [Upgrading Squirro](https://docs.squirro.com/en/latest/getting/install/upgrade.md): Before starting the upgrade process, it is essential to review the release notes associated with the long-term support (LTS) version to upgrade to.
- [Upgrading Configuration Conflicts](https://docs.squirro.com/en/latest/getting/install/upgrade-conflicts.md): On upgrade, the configuration files are changed.
- [3.10.6 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/3.10.6-release-notes.md): Squirro 3.10.6 was released on July 26, 2024.
- [3.10.6 LTS](https://docs.squirro.com/en/latest/getting/release/3-10/index.md): Squirro 3.10.6 was released on July 26, 2024.
- [3.10.0 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/3.10.0-release-notes.md): Squirro 3.10.0 was released March 14, 2024.
- [3.10.1 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/3.10.1-release-notes.md): Squirro 3.10.1 was released April 4, 2024.
- [3.10.2 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/3.10.2-release-notes.md): Squirro 3.10.2 was released May 10, 2024.
- [3.10.3 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/3.10.3-release-notes.md): Squirro 3.10.3 was released June 06, 2024.
- [3.10.4 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/3.10.4-release-notes.md): Squirro 3.10.4 was released June 20, 2024.
- [3.10.5 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/3.10.5-release-notes.md): Squirro 3.10.5 was released on July 4, 2024.
- [Squirro 3.10.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-10/squirro-3.10.x-release-notes/index.md): This section contains the release notes for the Squirro 3.10.X releases, including the following
- [3.11.6 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/3.11.6-release-notes.md): Squirro 3.11.6 was released on December 11, 2024.
- [3.11.6 LTS](https://docs.squirro.com/en/latest/getting/release/3-11/index.md): Squirro 3.11.6 was released on December 11, 2024.
- [3.11.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/3.11.0-release-notes.md): Squirro 3.11.0 was released on August 19, 2024.
- [3.11.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/3.11.1-release-notes.md): Squirro 3.11.1 was released on September 2, 2024.
- [3.11.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/3.11.2-release-notes.md): Squirro 3.11.2 was released on October 1, 2024.
- [3.11.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/3.11.3-release-notes.md): Squirro 3.11.3 was released on October 23, 2024.
- [3.11.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/3.11.4-release-notes.md): Squirro 3.11.4 was released on November 7, 2024.
- [3.11.5 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/3.11.5-release-notes.md): Squirro 3.11.5 was released on November 25, 2024.
- [Squirro 3.11.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-11/squirro-3.11.x-release-notes/index.md): This section contains the release notes for the Squirro 3.11.X releases, including the following
- [3.12.1 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-12/3.12.1-release-notes.md): Squirro 3.12.1 was released on February 26, 2025.
- [3.12.1 LTS](https://docs.squirro.com/en/latest/getting/release/3-12/index.md): Squirro 3.12.1 was released on February 26, 2025.
- [3.13.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.0-release-notes.md): Squirro 3.13.0 was released on March 20, 2025.
- [3.13.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.1-release-notes.md): Squirro 3.13.1 was released on April 10, 2025.
- [3.13.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.2-release-notes.md): Squirro 3.13.2 was released on April 16, 2025.
- [3.13.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.3-release-notes.md): Squirro 3.13.3 was released on May 19, 2025.
- [3.13.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.4-release-notes.md): Squirro 3.13.4 was released on June 2, 2025.
- [3.13.5 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.5-release-notes.md): Squirro 3.13.5 was released on July 8, 2025.
- [3.13.6 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-13/3.13.6-release-notes.md): Squirro 3.13.6 was released on July 29, 2025.
- [3.13.6 LTS](https://docs.squirro.com/en/latest/getting/release/3-13/index.md): Squirro 3.13.6 was released on July 29, 2025.
- [3.14.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.0-release-notes.md): Squirro 3.14.0 was released on August 20, 2025.
- [3.14.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.1-release-notes.md): Squirro 3.14.1 was released on September 18, 2025.
- [3.14.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.2-release-notes.md): Squirro 3.14.2 was released on October 2, 2025.
- [3.14.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.3-release-notes.md): Squirro 3.14.3 was released on October 17, 2025.
- [3.14.4 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.4-release-notes.md): Squirro 3.14.4 was released on November 5, 2025.
- [3.14.5 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.5-release-notes.md): Squirro 3.14.5 was released on December 11, 2025.
- [3.14.6 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-14/3.14.6-release-notes.md): Squirro 3.14.6 was released on February 6, 2026.
- [3.14.6 LTS](https://docs.squirro.com/en/latest/getting/release/3-14/index.md): Squirro 3.14.6 was released on February 6, 2026.
- [3.15.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-15/3.15.0-release-notes.md): Squirro 3.15.0 was released on December 2, 2025.
- [3.15.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-15/3.15.1-release-notes.md): Squirro 3.15.1 was released on January 26, 2026.
- [3.15.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-15/3.15.2-release-notes.md): Squirro 3.15.2 was released on March 4, 2026.
- [3.15.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-15/3.15.3-release-notes.md): Squirro 3.15.3 was released on March 19, 2026.
- [3.15.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-15/3.15.4-release-notes.md): Squirro 3.15.4 was released on April 27, 2026.
- [3.15.5 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-15/3.15.5-release-notes.md): Squirro 3.15.5 LTS was released on May 13, 2026.
- [3.15.5 LTS](https://docs.squirro.com/en/latest/getting/release/3-15/index.md): Squirro 3.15.5 LTS was released on May 13, 2026.
- [3.16.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.0-release-notes.md): Squirro 3.16.0 was released on May 28, 2026.
- [3.16.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.1-release-notes.md): Squirro 3.16.1 was released on June 11, 2026.
- [3.16.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.2-release-notes.md): Squirro 3.16.2 was released on June 25, 2026.
- [3.16.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.3-release-notes.md): Squirro 3.16.3 was released on July 8, 2026.
- [3.16.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.4-release-notes.md): Squirro 3.16.4 was released on July 22, 2026.
- [3.16.5 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.5-release-notes.md): Squirro 3.16.5 was released on August 5, 2026.
- [3.16.6 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-16/3.16.6-release-notes.md): Squirro 3.16.6 LTS was released on August 24, 2026.
- [3.16.6 LTS](https://docs.squirro.com/en/latest/getting/release/3-16/index.md): Squirro 3.16.6 LTS was released on August 24, 2026.
- [3.17.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-17/3.17.0-release-notes.md): Squirro 3.17.0 was released on September 3, 2026.
- [3.17.0 (latest)](https://docs.squirro.com/en/latest/getting/release/3-17/index.md): Squirro 3.17.0 was released on September 3, 2026.
- [3.4.7 LTS](https://docs.squirro.com/en/latest/getting/release/3-4/index.md): This section contains the following
- [3.4.7 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.7-lts.md): Squirro 3.4.7 is a long-term support (LTS) release and received updates for security issues and important bug fixes for two years.
- [3.4.X Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/index.md): This section contains the release notes for the Squirro 3.4.X releases, including the following
- [3.4.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.0-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.4.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.1-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.4.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.2-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.4.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.3-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.4.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.4-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.4.5 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.5-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.4.6 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-4/squirro-3.4.x-release-notes/squirro-3.4.6-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.8 LTS](https://docs.squirro.com/en/latest/getting/release/3-5/index.md): This section contains the following
- [3.5.8 LTS - Cognitive Search Improvements](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.8-lts-cognitive-search-improvements.md): With the Squirro 3.5.8 LTS release the Cognitive Search app got a complete overhaul.
- [3.5.8 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.8-lts-release-notes.md): Squirro 3.5.8 long-term support (LTS) was released on 08 Jul 2022.
- [3.5.9 LTS - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.9-lts-release-notes.md): Squirro 3.5.9 is a long-term support (LTS) release and received updates for security issues and important bug fixes for two years.
- [3.5.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.0-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.1-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.2-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.3-release-notes.md): Due to the python upgrade, this release has modified upgrade instructions.
- [3.5.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.4-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.5 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.5-release-notes.md): Frontend and other UI related enhancements
- [3.5.6 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.6-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.7 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/3.5.7-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.5.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-5/squirro-3.5.x-release-notes/index.md): This section contains the release notes for the Squirro 3.4.X releases, including the following
- [3.6.8 LTS](https://docs.squirro.com/en/latest/getting/release/3-6/index.md): This section contains the following
- [3.6.8 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.8-lts.md): Squirro 3.6.8 long-term support (LTS) was released on 28 Nov 2022 .
- [Squirro 3.6.8 LTS - Cognitive Search Improvements](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.8-lts-cognitive-search-improvements.md): With the Squirro 3.6.8 LTS Release Notes release, the Squirro Cognitive Search Template received significant improvements.
- [3.6.0 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.0-release-notes.md): Squirro 3.6.0 was released on 21 Jul 2022.
- [3.6.1 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.1-release-notes.md): Squirro 3.6.1 was released on 11 Aug 2022.
- [3.6.2 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.2-release-notes.md): Squirro 3.6.2 was released on 18 Aug 2022.
- [3.6.3 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.3-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.6.4 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.4-release-notes.md): You will have to resolve at least the following config files when upgrading from Squirro 3.3.0
- [3.6.5 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.5-release-notes.md): Squirro 3.6.5 was released October 12, 2022.
- [3.6.6 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/3.6.6-release-notes.md): Squirro Monitoring can now be selected from the Application Setup screen.
- [Squirro 3.6.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-6/squirro-3.6.x-release-notes/index.md): This section contains the release notes for the Squirro 3.6.X releases, including the following
- [3.7.5 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/3.7.5-lts.md): Squirro 3.7.5 long-term support (LTS) was released on May 02, 2023.
- [3.7.6 LTS - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/3.7.6-lts.md): Squirro 3.7.6 is a long-term support (LTS) release and received updates for security issues and important bug fixes for two years.
- [3.7.6 LTS](https://docs.squirro.com/en/latest/getting/release/3-7/index.md): Squirro 3.7.5 and 3.7.6 long-term support (LTS) was released on May 02, 2023.
- [3.7.1 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/squirro-3.7.x-release-notes/3.7.1-release-notes.md): The APIs and SDKs section was updated to include JavaScript SDK, the Squirro Toolbox, and Plugin Repository information.
- [3.7.2 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/squirro-3.7.x-release-notes/3.7.2-release-notes.md): Squirro 3.7.2 was released on Feb 8, 2023.
- [3.7.3 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/squirro-3.7.x-release-notes/3.7.3-release-notes.md): Squirro 3.7.3 was released on March 22, 2023.
- [3.7.4 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/squirro-3.7.x-release-notes/3.7.4-release-notes.md): Squirro 3.7.4 was released on April 05, 2023.
- [Squirro 3.7.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-7/squirro-3.7.x-release-notes/index.md): This section contains release notes for the Squirro 3.7.X releases, including the following
- [3.8.6 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/3.8.6-release-notes.md): Squirro 3.8.6 LTS was released October 16, 2023.
- [3.8.7 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/3.8.7-release-notes.md): Squirro 3.8.7 LTS was released November 03, 2023.
- [3.8.7 LTS](https://docs.squirro.com/en/latest/getting/release/3-8/index.md): Squirro 3.8.7 LTS was released on November 03, 2023.
- [3.8.0 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/3.8.0-release-notes.md): Squirro 3.8.0 was released May 30, 2023.
- [3.8.1 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/3.8.1-release-notes.md): Squirro 3.8.1 was released June 22 2023.
- [3.8.2 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/3.8.2-release-notes.md): Squirro 3.8.2 was released July 12, 2023.
- [3.8.3 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/3.8.3-release-notes.md): Squirro 3.8.3 was released July 24, 2023.
- [3.8.4 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/3.8.4-release-notes.md): Squirro 3.8.4 was released September 18, 2023.
- [3.8.5 - Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/3.8.5-release-notes.md): Squirro 3.8.5 was released September 29, 2023.
- [Squirro 3.8.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-8/squirro-3.8.x-release-notes/index.md): This section contains the release notes for the Squirro 3.8.X releases, including the following
- [3.9.7 LTS Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/3.9.7-release-notes.md): Squirro 3.9.7 was released on February 27, 2024.
- [3.9.7 LTS](https://docs.squirro.com/en/latest/getting/release/3-9/index.md): Squirro 3.9.7 was released on February 27, 2024.
- [3.9.0 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/3.9.0-release-notes.md): Squirro 3.9.0 was released October 31, 2023.
- [3.9.1 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/3.9.1-release-notes.md): Squirro 3.9.1 was released on November 10, 2023.
- [3.9.2 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/3.9.2-release-notes.md): Squirro 3.9.2 was released on November 27, 2023.
- [3.9.3 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/3.9.3-release-notes.md): Squirro 3.9.3 was released on December 11, 2023.
- [3.9.4 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/3.9.4-release-notes.md): Squirro 3.9.4 was released on January 19, 2024.
- [3.9.5 Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/3.9.5-release-notes.md): Squirro 3.9.5 was released on January 30, 2024.
- [Squirro 3.9.x Release Notes](https://docs.squirro.com/en/latest/getting/release/3-9/squirro-3.9.x-release-notes/index.md): This section contains the release notes for the Squirro 3.9.X releases, including the following
- [SquirroGPT Release Highlights](https://docs.squirro.com/en/latest/getting/release/3-9/squirrogpt.md): This page details release highlights for Squirro Chat, a Retrieval Augmented Generation (RAG) AI application that allows you to conversationally interact with your own organizational or website data.
- [Release Notes](https://docs.squirro.com/en/latest/getting/release/index.md): Squirro provides two types of releases.
- [Squirro Release Process](https://docs.squirro.com/en/latest/getting/release/squirro-release-process.md): Roughly once per quarter, Squirro publishes a long-term support (LTS) release.
- [Cluster Roles and Permissions for Self-Service](https://docs.squirro.com/en/latest/getting/self-service/cluster-permissions.md): For Squirro Self-Service instances, there is an additional level of roles and permissions beyond the server-level and project-level roles and permissions detailed in Squirro Roles & Permissions.
- [Email Domain-Based Permissions](https://docs.squirro.com/en/latest/getting/self-service/domain-permissions.md): Squirro allows you to add an email domain (such as squirro.com) to tailor access to an instance.
- [How to Install A Squirro Application](https://docs.squirro.com/en/latest/getting/self-service/how-to/how-application.md): This page explains how to open a Squirro application from start.squirro.com.
- [How to Access a Squirro Online Demo](https://docs.squirro.com/en/latest/getting/self-service/how-to/how-open-demo.md): This page explains how to open a Squirro demo application from start.squirro.com.
- [How to Register for a Squirro ID](https://docs.squirro.com/en/latest/getting/self-service/how-to/how-register-id.md): A Squirro ID is your single account for the entire Squirro ecosystem.
- [How to Launch a Test Drive](https://docs.squirro.com/en/latest/getting/self-service/how-to/how-test-drive.md): This page explains how to launch an application Test Drive, which is a quick and easy way to preview an application in a live environment.
- [How-To Guides](https://docs.squirro.com/en/latest/getting/self-service/how-to/index.md): The following guides provide step-by-step instructions for installing and using Squirro Chat
- [How to Connect Squirro Chat to a Microsoft Azure LLM](https://docs.squirro.com/en/latest/getting/self-service/how-to/squirrogpt-azure.md): Profile: System Administrator
- [How to Connect Squirro Chat to a Third-Party LLM](https://docs.squirro.com/en/latest/getting/self-service/how-to/squirrogpt-external-llm.md): Profile: System Administrator
- [Squirro Chat Data Quick-Start Guide](https://docs.squirro.com/en/latest/getting/self-service/how-to/squirrogpt-guide.md): This guide provides an introduction to Squirro Chat Data and instructions on how to install and use the application.
- [Squirro Chat Web Quick-Start Guide](https://docs.squirro.com/en/latest/getting/self-service/how-to/squirrogpt-web-guide.md): This guide provides an introduction to Squirro Chat Web and instructions on how to install and use the application.
- [Squirro Self-Service](https://docs.squirro.com/en/latest/getting/self-service/index.md): Squirro Self-Service is a web-based interface that allows you to create and manage your own Squirro installations (instances) and projects.
- [Squirro Self-Service Instances](https://docs.squirro.com/en/latest/getting/self-service/instances.md): Squirro provides a single tenant setup for cloud-hosted instances.
- [Upgrading an Instance](https://docs.squirro.com/en/latest/getting/self-service/upgrade.md): As Server Admin, you can configure upgrade settings for your Squirro self-service instance.

## Squirro Products

- [Squirro Search](https://docs.squirro.com/en/latest/products/cognitive-search.md): Accessing the correct information quickly is increasingly difficult in a world filled with siloed data.
- [Squirro Products](https://docs.squirro.com/en/latest/products/index.md): Squirro also offers a standalone generative AI product that can be used to conversationally interact with your own enterprise or website data.
- [Insight Engine](https://docs.squirro.com/en/latest/products/insight-engine.md): Insight Engines augment search technology with artificial intelligence to deliver insights.
- [Installation Guides](https://docs.squirro.com/en/latest/products/installation/index.md): This section contains links to to the following installation guides
- [Microsoft Outlook Installation](https://docs.squirro.com/en/latest/products/installation/install-outlook.md): Squirro dashboards can be embedded into Microsoft Outlook (both on-premises as well as in Office 365).
- [Salesforce Federated Search Installation](https://docs.squirro.com/en/latest/products/installation/salesforce-federated.md): Salesforce federated search is a simple integration of an existing Squirro project into the default search of Salesforce.
- [Squirro for Salesforce Installation](https://docs.squirro.com/en/latest/products/installation/salesforce-install.md): Squirro for Salesforce can be installed from Salesforce’s AppExchange.
- [Outlook](https://docs.squirro.com/en/latest/products/squirro-outlook.md): Squirro can be embedded into Microsoft Outlook to create an insight experience in the context of email messages.
- [Salesforce](https://docs.squirro.com/en/latest/products/squirro-salesforce.md): Squirro can be integrated directly into the Salesforce.com platform.
- [Squirro Chat](https://docs.squirro.com/en/latest/products/squirrogpt.md): Squirro Chat is a Retrieval Augmented Generation (RAG) application powered by an underlying large language model (LLM).

## Squirro Profiles

- [Cognitive Search User](https://docs.squirro.com/en/latest/profiles/cog-user.md): Profile: Cognitive Search User
- [Data Scientist](https://docs.squirro.com/en/latest/profiles/data-scientist.md): Data Scientists work with Squirro products to gain insights into project data.
- [Frontend Developer](https://docs.squirro.com/en/latest/profiles/frontend-developer.md): Profile: Frontend Developer
- [Squirro Profiles](https://docs.squirro.com/en/latest/profiles/index.md): A successful Insight Engine project requires close collaboration from different user profiles.
- [Model Creator](https://docs.squirro.com/en/latest/profiles/model-creator.md): Visit the Squirro Academy to learn more about the dedicated AI Studio Model Creator Certification Course.
- [Project Creator](https://docs.squirro.com/en/latest/profiles/project-creator.md): Sign up for the Squirro Project Creator Training & Certification course at the Squirro Academy!
- [Python Engineer](https://docs.squirro.com/en/latest/profiles/python-engineer.md): As a Python engineer, you can use the Python programming language to expand Squirro’s capabilities by building and uploading the following
- [Search Engineer](https://docs.squirro.com/en/latest/profiles/search-engineer.md): The search engineer is responsible for enhancing the search experience for end users.
- [System Administrator/DevOps Engineer](https://docs.squirro.com/en/latest/profiles/system-admin.md): Profile: System Administrator

## Security

- [CVE-2021-27945 - Cross-Site Scripting](https://docs.squirro.com/en/latest/security/advisories/27945.md): The Squirro Insights Engine was affected by a Reflected Cross-Site Scripting (XSS) vulnerability affecting versions 2.0.0 up to and including 3.2.4.
- [CVE-2021-44228 - log4j Security Vulnerability](https://docs.squirro.com/en/latest/security/advisories/44228.md): 11 Dec 2021, last updated 20 Dec 2021
- [Security Advisories](https://docs.squirro.com/en/latest/security/advisories/index.md): See the links below for Squirro Security Advisories
- [Security](https://docs.squirro.com/en/latest/security/index.md): Squirro is certified against ISO 27001, the globally recognized standard for information security management.

## Technical documentation

- [cluster.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/cluster-ini.md): The cluster.ini config file, located at /etc/squirro/cluster.ini configures the workings of the Cluster Service that allows Squirro to run on multiple servers.
- [common.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/common-ini.md): The common.ini config file, located at /etc/squirro/common.ini configures common settings for all Squirro services.
- [configuration.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/config-ini.md): The configuration.ini config file, located at /etc/squirro/configuration.ini configures the workings of the configuration service.
- [convert.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/convert-ini.md): The convert.ini config file, located at /etc/squirro/convert.ini configures the content extraction (see Content Extraction).
- [datasource.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/datasource-ini.md): The datasource.ini config file, located at /etc/squirro/datasource.ini configures the workings of the Datasource Service.
- [digestmailer.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/digestmailer-ini.md): The digestmailer.ini config file, located at /etc/squirro/digestmailer.ini configures email template rendering.
- [emailsender.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/emailsender-ini.md): By default Squirro sends emails through a local email server.
- [filtering.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/filtering-ini.md): The filtering.ini config file, located at /etc/squirro/filtering.ini configures the filtering process, which is responsible for search tagging and alerts.
- [frontend.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/frontend-ini.md): The frontend.ini config file, located at /etc/squirro/frontend.ini configures the workings of the Squirro frontend user interface
- [genai.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/genai.md): As genai is a containerized service, the configuration does not rely on providing a genai.ini file.
- [Configuration Files](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/index.md): Each service has its own configuration file /etc/squirro/<servicename>.ini.
- [ingester.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/ingester-ini.md): The ingester.ini config file, located at /etc/squirro/ingester.ini configures the workings of the Ingester Service, which executes the pipeline workflows within the Squirro Data Pipeline.
- [storage.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/storage-ini.md): The storage.ini file configures the file storage buckets that Squirro uses to hold uploaded and generated files, such as project and community pictures, newsletter assets, converted documents, and files produced by AI agents.
- [/etc/sysconfig](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/sysconfig-dir.md): The /etc/sysconfig directory is a common location for configuration files in Red Hat Enterprise Linux.
- [topic.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/topic-ini.md): The topic.ini config file, located at /etc/squirro/topic.ini configures the workings of the topic API, one of the core services of the Squirro platform.
- [user.ini](https://docs.squirro.com/en/latest/technical/admin/configuration/config-files/user-ini.md): The user.ini file configures the Squirro user authentication service, which handles authentication, user management, and OAuth2 client credentials.
- [Configuration Interpolation](https://docs.squirro.com/en/latest/technical/admin/configuration/config-interpolation.md): Configuration interpolation allows retrieving values from the Configuration Service and inject them to different parts of Squirro platform.
- [Configuration Service](https://docs.squirro.com/en/latest/technical/admin/configuration/config-service.md): Squirro’s configuration service is the centralized repository for server, project, and user configuration.
- [Changing the Default Language](https://docs.squirro.com/en/latest/technical/admin/configuration/default-language.md): Squirro has support for presenting its dashboards in additional languages.
- [Email Templates](https://docs.squirro.com/en/latest/technical/admin/configuration/email-templates.md): The E-Mail Templates used for alerts and password reset are now configurable per tenant.
- [Enable Proxy Server for Outgoing Calls](https://docs.squirro.com/en/latest/technical/admin/configuration/enable-proxy.md): Some Squirro Services need to access the Internet.
- [File Upload Size Limits](https://docs.squirro.com/en/latest/technical/admin/configuration/file-upload-limits.md): Squirro enforces a default 96 MB file upload limit via two settings that must be kept in sync
- [High Performance Configuration](https://docs.squirro.com/en/latest/technical/admin/configuration/high-performance.md): Within a production deployment, a Squirro installation can be further optimized for improved performance.
- [Configuration](https://docs.squirro.com/en/latest/technical/admin/configuration/index.md): A Squirro cluster can be extensively configured.
- [Configuration Key Naming Conventions](https://docs.squirro.com/en/latest/technical/admin/configuration/key-naming-conventions.md): Profile: System Administrator
- [PDF Viewer](https://docs.squirro.com/en/latest/technical/admin/configuration/pdf-viewer.md): Starting with Squirro 3.15.4, the built-in PDF viewer is powered by Nutrient (formerly PSPDFKit).
- [Translating Dashboards with Project Translations](https://docs.squirro.com/en/latest/technical/admin/configuration/project-translations.md): Project translations let you define a custom dictionary of translated text for a project, so that the text you configure on your dashboards appears in the language selected by the user.
- [Secure Configuration Guide](https://docs.squirro.com/en/latest/technical/admin/configuration/secure-config-guide.md): This page outlines a number of steps that can be taken in order to configure the Squirro environment in a more secure manner than out of the box.
- [Securing Configuration Files](https://docs.squirro.com/en/latest/technical/admin/configuration/securing-config-files.md): By default passwords (e.g. the default password for Redis or MySQL) are configured in plain text in the configuration files.
- [Securing Redis Instance over SSL](https://docs.squirro.com/en/latest/technical/admin/configuration/securing-redis.md): Squirro provides for SSL communication between Redis instances and Squirro services.
- [SSL Certificates](https://docs.squirro.com/en/latest/technical/admin/configuration/ssl-certificates.md): Squirro ships with an nginx web server.
- [Active Directory Federation Services (ADFS)](https://docs.squirro.com/en/latest/technical/admin/external-authentication/adfs.md): This guide explains how to set up Squirro Single Sign-On with Microsoft Active Directory Federation Services.
- [Architecture for Authentication](https://docs.squirro.com/en/latest/technical/admin/external-authentication/architecture.md): This page provides an overview of how SSO and/or External Authentication and Authorization works and how it can be customized to fit your needs.
- [Microsoft Entra ID (ME-ID)](https://docs.squirro.com/en/latest/technical/admin/external-authentication/azure.md): This guide explains how to set up Squirro Single Sign-On with Microsoft Entra ID.
- [Enabling and Disabling UI User Management](https://docs.squirro.com/en/latest/technical/admin/external-authentication/disable-sso.md): Squirro offers the option of managing permissions via inherited third-party Single Sign-on (SSO) settings, or managing users via the management functionality in the user interface (UI), found in Server → Users.
- [Google SAML Setup](https://docs.squirro.com/en/latest/technical/admin/external-authentication/google.md): This page provides instructions on how to integrate Squirro with Google’s Single Sign-on offering.
- [External Authentication](https://docs.squirro.com/en/latest/technical/admin/external-authentication/index.md): This page details how Squirro can work with external authentication, authorization, and Single Sign-On (SSO) providers.
- [JWT Authentication](https://docs.squirro.com/en/latest/technical/admin/external-authentication/jwt.md): Squirro supports authenticating API and frontend requests with JSON Web Tokens (JWTs) issued by an external OpenID Connect (OIDC) Identity Provider (IDP), such as Keycloak, Auth0, Microsoft Entra ID, or Okta.
- [Okta SAML Setup](https://docs.squirro.com/en/latest/technical/admin/external-authentication/okta.md): This page provides instructions for setting up Okta’s SAML authentication provider with Squirro.
- [Query Templates](https://docs.squirro.com/en/latest/technical/admin/external-authentication/query-templates.md): Query Templates are appended to an incoming Squirro query.
- [SAML SSO for Squirro](https://docs.squirro.com/en/latest/technical/admin/external-authentication/saml-sso.md): Security Assertion Markup Language (SAML) is an open standard for single sign-on (SSO) authentication and authorization.
- [Administration](https://docs.squirro.com/en/latest/technical/admin/index.md): This section provides an overview of the administrative elements of Squirro, including operations, configuration, and troubleshooting.
- [Accessing Servers](https://docs.squirro.com/en/latest/technical/admin/operations/accessing-servers.md): This page details how to access the Squirro Server, Squirro Application, Redis Server, and MariaDB Server.
- [Activity Tracking](https://docs.squirro.com/en/latest/technical/admin/operations/activity-tracking.md): This page provides an overview of Activity Tracking, which is used to track data about user interactions on the platform.
- [Audit Logging](https://docs.squirro.com/en/latest/technical/admin/operations/audit-logging.md): This page provides an overview of audit logging, a feature that enables the systematic tracking and monitoring of user activities to ensure security and compliance.
- [Database Backup and Restore](https://docs.squirro.com/en/latest/technical/admin/operations/backup-restore.md): This page provides information on backing up and restoring the Squirro MySQL/MariaDB Database.
- [Business Continuity Planning](https://docs.squirro.com/en/latest/technical/admin/operations/bcp.md): Squirro can be run as a clustered application across multiple hosts to provide high availability and horizontal scaling.
- [Cluster Status](https://docs.squirro.com/en/latest/technical/admin/operations/cluster-status.md): The Squirro cluster status can be observed in the user interface with a few Studio components.
- [Reindexing Elasticsearch](https://docs.squirro.com/en/latest/technical/admin/operations/elasticsearch-reindex.md): Reindexing copies all data from one index into a newly created index and is useful for the following functions
- [Fixing MySQL/MariaDB Replication](https://docs.squirro.com/en/latest/technical/admin/operations/fixing-replication.md): Multi-node Squirro deployments come with a Squirro Cluster service which takes care of electing a master node and making sure that the elected master node has the latest state of persisted data from the previous master in the event of the loss of the master node.
- [How Squirro Scales](https://docs.squirro.com/en/latest/technical/admin/operations/how-scales.md): This document aims to outline how Squirro can scale from a single, small development host to a massive multi-node cluster, ingesting millions of documents daily and serving thousands of users.
- [Operations](https://docs.squirro.com/en/latest/technical/admin/operations/index.md): This section covers operational activities related to accessing, monitoring, scaling, and backing up Squirro.
- [Elasticsearch Management](https://docs.squirro.com/en/latest/technical/admin/operations/managing-elasticsearch.md): Squirro relies on Elasticsearch for the storage nodes where the indexed data is persisted.
- [Monitoring](https://docs.squirro.com/en/latest/technical/admin/operations/monitoring.md): You can to debug system issues in many different ways.
- [Observability and Telemetry](https://docs.squirro.com/en/latest/technical/admin/operations/observability.md): Telemetry is the operational data that a software product emits about its own behavior while it runs, such as how requests move through the system, how long operations take, and where errors occur.
- [Connecting to an Observability Platform](https://docs.squirro.com/en/latest/technical/admin/operations/observability-integrations.md): Squirro produces telemetry through OpenTelemetry and sends it to a collector endpoint that you configure.
- [Deploying the Plumber service in a Docker container](https://docs.squirro.com/en/latest/technical/admin/operations/plumber-in-container.md): This page provides instructions on how to deploy the plumber service in a Docker container.
- [Services](https://docs.squirro.com/en/latest/technical/admin/operations/services.md): Squirro consists of several services that are started and stopped individually.
- [MySQL Big Data Management](https://docs.squirro.com/en/latest/technical/admin/troubleshooting/big-data-mysql.md): If you try to insert big data chunks to the MySQL server, you might run into the following error message
- [Flushing Caches](https://docs.squirro.com/en/latest/technical/admin/troubleshooting/flush-cache.md): Squirro uses caches to speed up common actions, such as queries.
- [Troubleshooting](https://docs.squirro.com/en/latest/technical/admin/troubleshooting/index.md): This section covers common issues that may arise and provides instructions on how to fix them.
- [MySQL Too Many Connections](https://docs.squirro.com/en/latest/technical/admin/troubleshooting/many-sql.md): If you run a large Squirro cluster, you might run into MySQL connection issue.
- [Investigating Performance Issues](https://docs.squirro.com/en/latest/technical/admin/troubleshooting/performance-investigation.md): There are two possible ways to record performance logging for the frontend
- [Python Performance Profiling Using PySpy](https://docs.squirro.com/en/latest/technical/admin/troubleshooting/python-profiling-pyspy.md): Squirro is primarily written in Python.
- [Brave Search Tool](https://docs.squirro.com/en/latest/technical/agents/brave-search-tool.md): The Brave Search tool is a web search integration that enhances Squirro Chat agents by providing access to information from the web.
- [Code Interpreter Tool](https://docs.squirro.com/en/latest/technical/agents/code-interpreter-tool.md): The OpenAI Code Interpreter is a custom tool that enables Squirro Chat agents to write and execute Python code for data analysis, calculations, visualizations, and file processing.
- [Configuring Agents and Tools](https://docs.squirro.com/en/latest/technical/agents/configuring-agents-and-tools.md): This guide explains how to create or modify a Personal Agent in Squirro Chat and configure tools for it.
- [Developing Custom Tools](https://docs.squirro.com/en/latest/technical/agents/developing-custom-tools.md): The Squirro agent framework allows you to create and deploy custom tools using the LangChain framework.
- [Agent Framework](https://docs.squirro.com/en/latest/technical/agents/index.md): In the field of artificial intelligence (AI), the ability to enhance or complement the capabilities of a Large Language Model (LLM) using specialized tools and agents, plays a pivotal role.
- [Large Language Model Support](https://docs.squirro.com/en/latest/technical/agents/llm-support.md): Squirro connects to any Large Language Model (LLM) that supports the OpenAI API standards and tool calling.
- [MCP Server Tools](https://docs.squirro.com/en/latest/technical/agents/mcp-server-tools.md): Squirro Chat integrates with the Model Context Protocol (MCP), an open standard that facilitates secure connections between host applications and external data sources and tools.
- [MCP Server Tools and Local Database](https://docs.squirro.com/en/latest/technical/agents/mcp-server-tools-structured-data.md): Squirro provides both a generic approach to agent-based search and the flexibility to fine-tune solutions for highly specific use cases.
- [Prompt Layers](https://docs.squirro.com/en/latest/technical/agents/prompt-engineering-layer.md): The Squirro platform employs a multi-layered prompt architecture that integrates several instruction layers to direct large language model behavior.
- [Squirro Item Retriever Tool](https://docs.squirro.com/en/latest/technical/agents/squirro-item-retriever-tool.md): The Squirro Item Retriever tool is designed to fetch and process individual documents (Squirro items) from the Squirro content repository.
- [Squirro Retriever Tool](https://docs.squirro.com/en/latest/technical/agents/squirro-retriever-tool.md): Squirro Retriever tool is a powerful paragraph-level retrieval tool that allows AI agents to search and extract relevant information from documents indexed in Squirro projects.
- [V1 Catalog MCP Servers (preview)](https://docs.squirro.com/en/latest/technical/agents/v1-external-mcp.md): The V1 agent runtime consumes MCP servers as catalog-authored resources rather than per-agent tool configurations.
- [Bulk Labeling](https://docs.squirro.com/en/latest/technical/ai-studio/bulk-labeling.md): Profiles: Model Creator, Data Scientist
- [ML Enrichments for Pipeline Workflows](https://docs.squirro.com/en/latest/technical/ai-studio/enrichments-workflows.md): Profiles: Data Scientist, Project Creator
- [Ground Truths](https://docs.squirro.com/en/latest/technical/ai-studio/ground-truth.md): Profiles: Model Creator, Data Scientist
- [How to Use Bulk Labeling in AI Studio](https://docs.squirro.com/en/latest/technical/ai-studio/how-to/bulk.md): Profiles: Model Creator, Data Scientist
- [How to Create a Document-Level Classification Model in AI Studio](https://docs.squirro.com/en/latest/technical/ai-studio/how-to/how-document-level.md): Profiles: Data Scientist, Model Creator, Search Engineer
- [How to Create a Sentence-Level Classification Model in AI Studio](https://docs.squirro.com/en/latest/technical/ai-studio/how-to/how-sentence-level.md): Profiles: Data Scientist, Model Creator, Search Engineer
- [AI Studio How-To Guides](https://docs.squirro.com/en/latest/technical/ai-studio/how-to/index.md): This section contains a collection of how-to guides for using AI Studio.
- [How to Integrate a Custom ML Classifier](https://docs.squirro.com/en/latest/technical/ai-studio/how-to/integrate-ml-class.md): Profiles: Data Scientist, Project Creator
- [How to Interact with Squirro Using Jupyter Notebook](https://docs.squirro.com/en/latest/technical/ai-studio/how-to/jupyter.md): Profiles: Data Scientist, Project Creator
- [AI Studio](https://docs.squirro.com/en/latest/technical/ai-studio/index.md): This section provides reference and how-to information for Squirro’s AI Studio, a no-code machine learning platform that enables you to build and deploy machine learning models without writing code.
- [Models Overview](https://docs.squirro.com/en/latest/technical/ai-studio/models.md): Profiles: Model Creator, Data Scientist
- [Published Models](https://docs.squirro.com/en/latest/technical/ai-studio/publish.md): Profiles: Model Creator, Data Scientist
- [Share Labeling Permissions](https://docs.squirro.com/en/latest/technical/ai-studio/share-labeling.md): Ground truth labeling is a shared activity that should include as many business domain experts as possible.
- [Squirro Client Reference](https://docs.squirro.com/en/latest/technical/ai-studio/squirroclient-reference.md): This page provides AI Studio reference for the SquirroClient (Python SDK).
- [Search Aggregations](https://docs.squirro.com/en/latest/technical/api/aggregations.md): Aggregations let you summarize and group the items returned by a search, so that instead of (or in addition to) a list of results you get counts, statistics, and breakdowns over the matching data set.
- [Authentication](https://docs.squirro.com/en/latest/technical/api/authentication.md): All Squirro API resources are protected and authentication credentials for HTTP authentication (using the Authorization header) are mandatory.
- [Catalyst Data Model](https://docs.squirro.com/en/latest/technical/api/catalyst.md): The catalyst data model provides a sub-item model so that when significant events are detected, you can see exactly which sentence or phrase in a document triggered the catalyst, as well as detailed relationships across documents.
- [Common Headers](https://docs.squirro.com/en/latest/technical/api/common-headers.md): The Squirro services are standard HTTP REST services.
- [Common Status Codes](https://docs.squirro.com/en/latest/technical/api/common-status.md): The Squirro services are standard HTTP REST services.
- [Data Modeling](https://docs.squirro.com/en/latest/technical/api/data-modeling.md): When indexing data from other data sources into Squirro, the data is transformed into the Squirro Item Format.
- [APIs and SDKs](https://docs.squirro.com/en/latest/technical/api/index.md): This page provides an overview of the tools and software development kits (SDKs) you can use to develop on the Squirro platform and the Squirro APIs providing access to all services and entities of Squirro.
- [Item Format](https://docs.squirro.com/en/latest/technical/api/item-format.md): Squirro items are represented in JSON format.
- [JavaScript SDK](https://docs.squirro.com/en/latest/technical/api/javascript-sdk.md): Squirro’s JavaScript SDK allows you to integrate Squirro into any web-enabled framework.
- [Custom Sections API](https://docs.squirro.com/en/latest/technical/api/sections-api.md): The custom sections JavaScript API provides a means to manage the sections of a dashboard.
- [GenAI Service API](https://docs.squirro.com/en/latest/technical/api/services/genai/index.md): The GenAI Service is Squirro’s AI/ML microservice that provides powerful language model capabilities, embeddings, and retrieval-augmented generation (RAG) features.
- [Microservices APIs](https://docs.squirro.com/en/latest/technical/api/services/index.md): Squirro’s platform consists of multiple microservices, each providing specific functionality through RESTful APIs.
- [DocumentUploader Class](https://docs.squirro.com/en/latest/technical/api/squirro_client/documentuploader.md): As a best practice, provide the mime_type argument explicitly when calling upload().
- [SquirroClient (Python SDK)](https://docs.squirro.com/en/latest/technical/api/squirro_client/index.md): You can use the SquirroClient Python SDK to interact with all Squirro APIs.
- [SquirroClient Installation](https://docs.squirro.com/en/latest/technical/api/squirro_client/install.md): This document explains the setup of the Python SDK for Squirro (SquirroClient).
- [ItemUploader Class](https://docs.squirro.com/en/latest/technical/api/squirro_client/itemuploader.md): Item uploader class.
- [GenAI service API](https://docs.squirro.com/en/latest/technical/api/squirro_client/sc-api-genai.md): The class below is a mixin class which encapsulates the functionality of the GenAI service API.
- [Permissions Reference](https://docs.squirro.com/en/latest/technical/api/squirro_client/sc-api-permissions.md): Squirro uses two independent permission layers that both apply on every API request.
- [APIs by Topic](https://docs.squirro.com/en/latest/technical/api/squirro_client/sc-api-topics.md): Mixin classes which encapsulate the functionality of the object API service.
- [User Management](https://docs.squirro.com/en/latest/technical/api/squirro_client/sc-api-user.md): The class below links to all information relating to user permission handling in Squirro, including both users and groups.
- [Create a Service Account](https://docs.squirro.com/en/latest/technical/api/squirro_client/service-account.md): A service account is a non-personal user account that an application or integration uses to authenticate with Squirro.
- [SquirroClient Setup Class](https://docs.squirro.com/en/latest/technical/api/squirro_client/squirroclient-class.md): Instantiation and authorization of the Squirro Client.
- [Upload and Manage Storage Files](https://docs.squirro.com/en/latest/technical/api/squirro_client/storage-files.md): Squirro stores uploaded files, such as pictures, newsletter assets, and documents, in named storage locations called buckets.
- [SquirroClient Tutorial](https://docs.squirro.com/en/latest/technical/api/squirro_client/tutorial.md): This tutorial shows how the SquirroClient (also known as the Python SDK) can be used to interface with a Squirro project.
- [squirro_asset CLI Reference](https://docs.squirro.com/en/latest/technical/api/toolbox/asset-cli.md): The squirro_asset tool can be used to manage all Squirro code artifacts called custom assets.
- [Bulk Exporter](https://docs.squirro.com/en/latest/technical/api/toolbox/bulk-exporter.md): The Bulk Exporter is part of the Squirro Toolbox.
- [Toolbox Differences Between macOS / Linux / Windows](https://docs.squirro.com/en/latest/technical/api/toolbox/differences.md): Across the Squirro documentation are examples of commands that you can run using the command line interface.
- [Squirro Toolbox](https://docs.squirro.com/en/latest/technical/api/toolbox/index.md): The Squirro Toolbox is a set of command line interface (CLI) utilities that you install on your own machine to work with a Squirro instance.
- [Install In a Python Environment](https://docs.squirro.com/en/latest/technical/api/toolbox/install-python.md): The Squirro Toolbox is a collection of command line utilities that work with a Squirro cluster.
- [Architecture Diagrams](https://docs.squirro.com/en/latest/technical/architecture/diagrams.md): The Squirro platform primarily generates insights from unstructured data but also processes structured data.
- [General Concepts](https://docs.squirro.com/en/latest/technical/architecture/general-concepts.md): Where capitalized, words refer to their meaning in this section.
- [Architecture](https://docs.squirro.com/en/latest/technical/architecture/index.md): This section provides general information on how Squirro is structured.
- [AI Guardrails](https://docs.squirro.com/en/latest/technical/chat/ai-guardrails/index.md): Conversational AI has transformed the way we search for information and interact with computer systems.
- [Chat with Document](https://docs.squirro.com/en/latest/technical/chat/chat-with-document-agent.md): That feature is specifically designed for scenarios where users need to deeply understand, analyze, or extract information from a single document they are currently viewing, rather than searching across multiple sources.
- [File Upload](https://docs.squirro.com/en/latest/technical/chat/file-upload.md): Upload documents directly to Squirro Chat for ad hoc analysis without requiring permanent indexing.
- [Chat](https://docs.squirro.com/en/latest/technical/chat/index.md): Squirro Chat is a powerful and user-friendly application designed to streamline your workflows with minimal setup required.
- [Privacy Layer](https://docs.squirro.com/en/latest/technical/chat/privacy-layer/index.md): The widespread adoption of conversational AI systems raises concerns about data privacy.
- [Prompt Library](https://docs.squirro.com/en/latest/technical/chat/prompt-library.md): The Prompt Library in Squirro Chat provides a centralized location for creating, managing, and sharing reusable prompt templates.
- [Starter Questions](https://docs.squirro.com/en/latest/technical/chat/starter-questions.md): Starter Questions provide an interactive way to help users begin conversations with Squirro Chat.
- [Execution Details](https://docs.squirro.com/en/latest/technical/chat/trace-command.md): The trace and trace-verbose commands provide powerful execution tracing and debugging capabilities for Squirro Chat.
- [Collections](https://docs.squirro.com/en/latest/technical/collections/index.md): The Collections feature helps you effortlessly create personal groupings of indexed content.
- [Communities Augmentation](https://docs.squirro.com/en/latest/technical/communities/augmentation.md): This page describes the Communities data augmentation feature and its configuration.
- [Community Auto-Subscription](https://docs.squirro.com/en/latest/technical/communities/auto-subscription.md): This page describes the community auto-subscription feature and how it can be configured by project creators within the Sales Insights application.
- [CSV and Excel Formatting for Upload](https://docs.squirro.com/en/latest/technical/communities/csv.md): This page describes how to upload CSV and XLS files when creating communities.
- [How to Set Up Communities Using KEE](https://docs.squirro.com/en/latest/technical/communities/how-kee.md): This guide explains how you can set up communities based on a Known Entity Extraction (KEE).
- [Communities Tutorial](https://docs.squirro.com/en/latest/technical/communities/how-setup.md): Communities is a feature that allows end users to follow topics that interest them within a Squirro project.
- [Communities](https://docs.squirro.com/en/latest/technical/communities/index.md): This page provides an overview of Communities and links to information about how to set up, manage, and visualize communities.
- [Managing Communities](https://docs.squirro.com/en/latest/technical/communities/management.md): This page describes how to delete, edit, and change configuration settings within communities.
- [Setting Up Community Types](https://docs.squirro.com/en/latest/technical/communities/setup.md): This page provides instructions on setting up Community Types using the Squirro UI in your browser.
- [Visualizing Communities](https://docs.squirro.com/en/latest/technical/communities/visualization.md): The Squirro Dashboard Editor provides flexible ways of visualizing communities using widgets.
- [Dashboard Editor](https://docs.squirro.com/en/latest/technical/dashboards/dashboard-editor.md): The Dashboard Editor is a tool that allows you to build dashboards for end users section-by-section using layers and widgets within a visual editor.
- [Dashboard Permissions](https://docs.squirro.com/en/latest/technical/dashboards/dashboard-permissions.md): In addition to regular Squirro Roles & Permissions, project admins can restrict dashboards to specific users or groups.
- [Dashboard Store](https://docs.squirro.com/en/latest/technical/dashboards/dashboard-store.md): The Dashboard Store is a key-value database that can be used for many things.
- [Dashboards](https://docs.squirro.com/en/latest/technical/dashboards/index.md): Dashboards are the main user interface for Squirro end users.
- [Dashboard Layers](https://docs.squirro.com/en/latest/technical/dashboards/layers.md): Dashboard layers provide the means of splitting a dashboard into various subsections.
- [Mobile Dashboard Editor](https://docs.squirro.com/en/latest/technical/dashboards/mobile-dashboard.md): The mobile dashboard editor is a new addition to the dashboard editing tool.
- [Dashboard/Widget Query Parametrisation](https://docs.squirro.com/en/latest/technical/dashboards/parameterization.md): Templated widget and dashboard queries can use several objects to inject parameters.
- [Community 360 Dashboard](https://docs.squirro.com/en/latest/technical/dashboards/types/community-360.md): Squirro Communities are a great way for users to subscribe to topics they are interested in.
- [Explore Dashboard](https://docs.squirro.com/en/latest/technical/dashboards/types/explore.md): The Explore Dashboard role defines the dashboard that is displayed in the Setup → Explore space.
- [Global Search Dashboard](https://docs.squirro.com/en/latest/technical/dashboards/types/global-search.md): Squirro provides a uniform search experience for users via the Global Search dashboard.
- [Dashboard Types](https://docs.squirro.com/en/latest/technical/dashboards/types/index.md): Three specialty dashboards are available in the Squirro UI.
- [Layout Master Dashboard](https://docs.squirro.com/en/latest/technical/dashboards/types/master.md): The Master dashboards inside Squirro have a centralized place for storing master layouts, including section sizing.
- [Upgrading Dashboards Manually](https://docs.squirro.com/en/latest/technical/dashboards/upgrade.md): Profiles: Project Creator, Frontend Developer
- [Visibility Conditions](https://docs.squirro.com/en/latest/technical/dashboards/visibility.md): Visibility conditions are an important means of choosing when and how certain sections or layers within Squirro’s Dashboard Editor are displayed.
- [Crawler Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/built-in/crawler.md): This page explains how to configure the Crawler connector.
- [CSV Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/built-in/csv.md): This page provides an overview of the CSV connector.
- [Documents Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/built-in/documents.md): This page provides an overview of the Documents connector.
- [Excel Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/built-in/excel.md): This page provides an overview of the Excel connector.
- [Built-In Data Connectors](https://docs.squirro.com/en/latest/technical/data-loading/connectors/built-in/index.md): Click here to view the Squirro Data Loading course over at the Squirro Academy!
- [Squirro Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/built-in/squirro.md): This page describes how to connect to another Squirro instance, repository, or data lake using the pre-built Squirro connector.
- [Dropbox Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/cloud/dropbox.md): Profiles: Project Creator
- [Google Drive Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/cloud/google-drive.md): Profiles: Project Creator
- [1-Click Cloud Connectors](https://docs.squirro.com/en/latest/technical/data-loading/connectors/cloud/index.md): The following Cloud connectors are available out-of-the-box.
- [Microsoft One Drive Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/cloud/microsoft-one-drive.md): Profiles: Project Creator
- [Data Connectors](https://docs.squirro.com/en/latest/technical/data-loading/connectors/index.md): Connectors are the interface between an external data source and Squirro.
- [Atlassian Confluence Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/confluence.md): Squirro provides a 1-Click Connector for Confluence.
- [Google Gmail Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/google-gmail.md): Squirro provides a 1-click connector for Gmail.
- [1-Click Enterprise Connectors](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/index.md): Squirro allows you to connect to a wide range of enterprise data sources out of the box.
- [Atlassian Jira Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/jira.md): Squirro provides a 1-click connector for Jira.
- [Microsoft Exchange Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/microsoft-exchange.md): Squirro provides a 1-click connector for Microsoft Exchange.
- [Microsoft SharePoint Connectors](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/microsoft-sharepoint.md): Squirro provides two 1-click connectors for Microsoft SharePoint.
- [RheinInsights Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/rhein-insights.md): The RheinInsights connector indexes enterprise content from a RheinInsights instance into Squirro.
- [Salesforce Sales Cloud Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/salesforce-sales.md): Squirro provides a 1-click connector for Salesforce Sales Cloud.
- [Salesforce Service Cloud Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/salesforce-service.md): Squirro provides a 1-click connector for Salesforce Service Cloud.
- [Webz.io Connector](https://docs.squirro.com/en/latest/technical/data-loading/connectors/one-click/webz.md): Webz.io is a News API delivering up-to-the-minute news coverage from articles, blog posts, and online discussions.
- [Data Loader CLI Tool](https://docs.squirro.com/en/latest/technical/data-loading/data-loader.md): The Data Loader CLI Tool loads data from multiple sources into Squirro.
- [Data Types](https://docs.squirro.com/en/latest/technical/data-loading/data-types.md): The following data types are used throughout the Squirro platform
- [Date Format](https://docs.squirro.com/en/latest/technical/data-loading/date-format.md): Both for formatting as well as parsing dates, date formats are specified using a date format string.
- [Format Strings](https://docs.squirro.com/en/latest/technical/data-loading/format-strings.md): Squirro supports format strings in many places within the software platform to specify how numbers and dates are displayed or processed.
- [How To Write a Custom 1-Click Connector](https://docs.squirro.com/en/latest/technical/data-loading/how-to/custom-connector.md): This tutorial goes step by step through building a custom 1-click connector.
- [How To Write a Custom Data Loader Plugin](https://docs.squirro.com/en/latest/technical/data-loading/how-to/custom-loader.md): This page will describe in detail how you can build a custom loader to work with data formats/inputs that are not supported out of the box.
- [Data Loader Command Line Interface Tool Tutorial](https://docs.squirro.com/en/latest/technical/data-loading/how-to/how-data-loader.md): This guide walks you step by step through using the Data Loader Command Line Interface (CLI) Tool.
- [Labels Tutorial](https://docs.squirro.com/en/latest/technical/data-loading/how-to/how-labels.md): This tutorial imports an extract of the Panama Papers into Squirro.
- [How to Load Data Using the UI](https://docs.squirro.com/en/latest/technical/data-loading/how-to/how-load-ui.md): Squirro offers multiple out-of-the-box options for connecting to internal and external data sources through the Squirro UI in your browser.
- [Data Loading How-To Guides](https://docs.squirro.com/en/latest/technical/data-loading/how-to/index.md): This section contains links to data loading how-to guides and tutorials.
- [Data Loading](https://docs.squirro.com/en/latest/technical/data-loading/index.md): This section outlines the various ways you can upload data to your Squirro project.
- [Labels](https://docs.squirro.com/en/latest/technical/data-loading/labels.md): This page explains labels, which are fields within an item that includes structured metadata which describes the item.
- [Data Loader Plugin Boilerplate](https://docs.squirro.com/en/latest/technical/data-loading/plugins/boilerplate.md): This is a template file for a Data Loader Plugin.
- [API for Caching and Custom State Management](https://docs.squirro.com/en/latest/technical/data-loading/plugins/caching.md): When building data loader plugins it can be useful to be able to store key-value pairs long term or for storage or caching purposes.
- [Data Loader Plugin Configuration](https://docs.squirro.com/en/latest/technical/data-loading/plugins/configuration.md): Data loader plugins usually require configuration to provide different ways to access the source.
- [Data Loader Templates](https://docs.squirro.com/en/latest/technical/data-loading/plugins/data-loader-templates.md): Dataloader Templates allow you to accelerate the process of loading data in Squirro.
- [Data Loader Plugin Reference](https://docs.squirro.com/en/latest/technical/data-loading/plugins/datasource.md): This page serves as a reference for the Data Loader Plugins SDK, showing the various methods that need to be implemented on a data loader class.
- [Data Loader Plugin Dependencies](https://docs.squirro.com/en/latest/technical/data-loading/plugins/dependencies.md): Data loader plugins sometimes need custom Python packages.
- [Example Data Loader Plugin](https://docs.squirro.com/en/latest/technical/data-loading/plugins/example-plugin.md): The data loader can be easily extended to implement a custom data source.
- [Incremental Loading](https://docs.squirro.com/en/latest/technical/data-loading/plugins/incremental.md): The Squirro data loader handles incremental loading for data loader plugins.
- [Data Loader Plugins](https://docs.squirro.com/en/latest/technical/data-loading/plugins/index.md): The data loader can be extended with data loader plugins.
- [Data Loader Plugin Preview](https://docs.squirro.com/en/latest/technical/data-loading/plugins/preview.md): The data loader frontend requests a preview from data loader plugins.
- [Data Loader Reference](https://docs.squirro.com/en/latest/technical/data-loading/reference.md): This page explains available options for the Data Loader and its usage.
- [Data Loading Troubleshooting](https://docs.squirro.com/en/latest/technical/data-loading/troubleshooting.md): This page lists common issues that may arise when loading data into Squirro with troubleshooting steps to resolve them.
- [UI Data Loader](https://docs.squirro.com/en/latest/technical/data-loading/ui.md): This page provides an overview of data loading using the Squirro UI.
- [Indexing Common Formats](https://docs.squirro.com/en/latest/technical/data-processing/common-formats.md): Squirro’s pipeline supports the processing of complex document types, such as common office formats like Word or Excel files or PDFs.
- [Content Streamers](https://docs.squirro.com/en/latest/technical/data-processing/content-streamers.md): The information provided on this page explains Content Streamers and their usage within the Squirro platform.
- [Custom Steps](https://docs.squirro.com/en/latest/technical/data-processing/custom/index.md): You can extend Squirro by creating custom Pipelets.
- [Pipelets (Custom Step)](https://docs.squirro.com/en/latest/technical/data-processing/custom/pipelets.md): In addition to the built-in pipeline steps, you can add your own custom enrichment or processing steps, called pipelets.
- [Squirro Scripts](https://docs.squirro.com/en/latest/technical/data-processing/custom/squirro-script.md): This section explains Squirro Scripts and how they are used in Squirro.
- [Processing Errors](https://docs.squirro.com/en/latest/technical/data-processing/errors.md): Some steps in the pipeline may abort with an error.
- [Data Processing Pipeline](https://docs.squirro.com/en/latest/technical/data-processing/index.md): This section outlines the various ways data is enriched, related, classified, indexed, and otherwise processed as part of the data processing pipeline.
- [Pipeline Overview](https://docs.squirro.com/en/latest/technical/data-processing/pipeline.md): The Squirro pipeline transforms a record from a data source to a Squirro item and writes it into the index.
- [Pipeline Editor](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-editor.md): The data processing pipeline, referred to simply as the pipeline, with all of its processing steps, can be configured in the user interface using the Pipeline Editor.
- [Pipeline Reruns](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-rerun.md): The page provides an overview of pipeline reruns and instructions on how to perform the following types of reruns
- [Automate Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/automate.md): This step details automated actions, such as sending emails.
- [Classify (from AI Studio) Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/classify.md): Text classification steps are typically created within Squirro’s AI Studio.
- [Discover (NLP Tagger) Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/discover.md): Discover includes steps around topic modelling and clustering, as well as analysis for Typeahead Suggestions.
- [Content Augmentation](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/content-augmentation.md): The content augmentation enrichment fetches additional content from third-party systems.
- [Content Extraction](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/content-extraction.md): The content extraction enrichment converts incoming content to HTML.
- [Duplicate Detection](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/duplicate-detection.md): The duplicate detection enrichment (also known as deduplication) prevents duplication of items.
- [Enrich Pipeline Steps](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/index.md): There are nine enrich steps available in the Squirro data processing pipeline.
- [Language Detection](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/language-detection.md): The language detection pipeline step detects the language of a Squirro item.
- [Noise Removal](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/noise-removal.md): The Noise Removal enrichment (internally used boilerplate-removal) strips unnecessary content from item bodies.
- [PDF Conversion](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/pdf-conversion.md): The PDF Conversion step converts standard Microsoft Office documents (such as Microsoft Word, Excel, and PowerPoint documents) to PDF documents.
- [PDF OCR](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/pdf-ocr.md): The PDF OCR (optical character recognition) step converts images of text embedded in PDF files into machine-encoded text.
- [Thumbnail Extraction](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/thumbnail-extraction.md): The Thumbnail Extraction pipeline step finds a thumbnail image to represent the Squirro item.
- [Unshorten Link](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/enrich/unshorten-link.md): The unshorten link pipeline step resolves the link and expands it to the long version.
- [Flow (Change Pipeline) Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/flow.md): Flow includes steps that manipulate the direction of the items in the pipeline workflows.
- [Built-In Steps](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/index.md): This section contains information regarding built-in data processing pipeline steps listed below.
- [Cache Cleaning](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/index/cache-cleaning.md): The filtering step cleans internal Squirro caches.
- [Content Standardization](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/index/content-standard.md): The content cleanup enrichment cleans up incoming text and removes potentially malicious content from the HTML body.
- [Index Steps](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/index/index.md): The Index section includes the required steps to persist Squirro items on disk for searching.
- [Indexing](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/index/indexing.md): The Indexing step in the Pipeline is responsible for persisting the ingested items and making them searchable.
- [Search Tagging and Alerting](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/index/search-tagging.md): Search tagging is an enrichment, used to add tags to incoming items.
- [Load (Transform Input) Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/load.md): The Transform Input step is used during the Load section to perform the transformations defined in the data source configuration process.
- [Recommend Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/recommend.md): There are currently no Recommend steps exposed within the user interface.
- [Relate (KEE) Pipeline Step](https://docs.squirro.com/en/latest/technical/data-processing/pipeline-steps/relate.md): The Relate step utilizes Squirro’s proprietary Known Entity Extraction (KEE) technology.
- [Pipeline Prioritization](https://docs.squirro.com/en/latest/technical/data-processing/priorities.md): This page provides an overview of how to prioritize items within the Squirro pipeline.
- [Reset Project](https://docs.squirro.com/en/latest/technical/data-processing/reset.md): The Reset Project function in the Studio is used to quickly reset a project.
- [Custom MCP Servers with MXCP](https://docs.squirro.com/en/latest/technical/data-virtualization/building-custom-mcp-servers-mxcp.md): MXCP is an enterprise framework for building and deploying MCP servers.
- [Data Virtualization](https://docs.squirro.com/en/latest/technical/data-virtualization/index.md): The Squirro Data Virtualization add-on extends the capabilities of Retrieval Augmented Generation (RAG) for your AI workflows by providing frictionless access to a vast array of structured and unstructured data, in real-time or near real-time.
- [Getting Started](https://docs.squirro.com/en/latest/technical/getting-started.md): Squirro is an enterprise generative AI platform that helps organizations extract value from large volumes of structured and unstructured data.
- [Downloads](https://docs.squirro.com/en/latest/technical/graphite/downloads.md): The official Squirro Graphite product guides are published as PDF documents.
- [How to Integrate Graphite with Squirro Classifier](https://docs.squirro.com/en/latest/technical/graphite/how-integrate-graphite-squirro-classifier.md): Profile: Project Administrator
- [Squirro Graphite](https://docs.squirro.com/en/latest/technical/graphite/index.md): Squirro Graphite is a software application for designing, building, and managing Knowledge Organization Systems (KOS) based on Linked Data and Semantic Web standards.
- [Concept Extraction Pipelet](https://docs.squirro.com/en/latest/technical/graphite/llm-concept-extraction.md): The Concept Extraction pipelet is a Squirro pipeline plugin that uses a large language model (LLM) to enrich an existing taxonomy in Squirro Graphite by proposing new candidate concepts extracted from your document corpus.
- [Relationship Extraction Pipelet](https://docs.squirro.com/en/latest/technical/graphite/llm-relationship-extraction.md): The LLM Relationship Extraction pipelet uses an LLM to enrich an existing taxonomy in Squirro Graphite by proposing new relationships between known concepts, based on evidence found in your document corpus.
- [Semantic Tagger Pipelet](https://docs.squirro.com/en/latest/technical/graphite/llm-semantic-tagger.md): The LLM Semantic Tagger pipelet uses an LLM to annotate documents in your corpus with concepts from an existing taxonomy in Squirro Graphite.
- [Technical documentation](https://docs.squirro.com/en/latest/technical/index.md): On this page, or in the navigation menu, you can browse Squirro’s technical documentation by topic.
- [Atlassian (Confluence & Jira)](https://docs.squirro.com/en/latest/technical/integrations/atlassian.md): The Squirro Atlassian integration provides unique insights and support assistance on top of your existing Atlassian cloud of either Confluence or Jira.
- [Embedding Dashboards](https://docs.squirro.com/en/latest/technical/integrations/embed-dashboards.md): Squirro dashboards can be embedded into other web applications or even desktop software.
- [Integrations](https://docs.squirro.com/en/latest/technical/integrations/index.md): Squirro can be integrated into a wide variety of third-party applications through both iframe and SDK integrations.
- [Microsoft Dynamics, Sharepoint, and Office](https://docs.squirro.com/en/latest/technical/integrations/microsoft-dso.md): The Squirro Microsoft integrations provide unique insights and support assistance on top of your existing Microsoft installations.
- [Newsletters](https://docs.squirro.com/en/latest/technical/integrations/newsletters.md): Squirro provides out-of-the-box support for configuring and sending regular newsletters to end users.
- [OpenSearch API](https://docs.squirro.com/en/latest/technical/integrations/opensearch.md): The OpenSearch integration allows you to expose an OpenSearch api endpoint on one or several projects.
- [PegaSystems - Pega](https://docs.squirro.com/en/latest/technical/integrations/pega.md): The Pega integration provides unique insights and support assistance on top of your existing Pega customer support installation.
- [ServiceNow Insights](https://docs.squirro.com/en/latest/technical/integrations/servicenow.md): This page explains how to install, configure, and extend the Squirro Service Insights for ServiceNow application.
- [Tableau](https://docs.squirro.com/en/latest/technical/integrations/tableau.md): The Squirro Tableau integration provides unique insights and support assistance on top of your existing Tableau installation.
- [KEE CLI Tool](https://docs.squirro.com/en/latest/technical/kee/cli.md): Using the kee command line (cli) tool, you can set up and deploy Known Entity Extraction to a Squirro Project.
- [KEE Configuration](https://docs.squirro.com/en/latest/technical/kee/config.md): This page details all configuration options for Known Entity Extraction (KEE).
- [KEE CLI Tool Tutorial](https://docs.squirro.com/en/latest/technical/kee/how-cli.md): This tutorial guides you through the process of setting up, testing and deploying a KEE using the KEE command line tool.
- [KEE Studio Plugin Tutorial](https://docs.squirro.com/en/latest/technical/kee/how-studio.md): This tutorial takes you through the steps that are required for creating a Known Entity Extraction (KEE) using the studio plugin in the UI.
- [Known Entity Extraction](https://docs.squirro.com/en/latest/technical/kee/index.md): This page introduces Known Entity Extraction (KEE) and links to information about its set up, configuration, and testing using the command line interface (CLI tool) or the Studio plugin.
- [KEE Studio Plugin](https://docs.squirro.com/en/latest/technical/kee/studio.md): This page explains the configuration of Known Entity Extraction (KEE) through its Studio plugin.
- [Testing](https://docs.squirro.com/en/latest/technical/kee/test.md): You can test KEEs using the test subcommand of the KEE commandline tool.
- [Tokenizers and Filters](https://docs.squirro.com/en/latest/technical/kee/token.md): In a KEE strategy, tokenizers and filters process the entity names and the input text to make the two comparable to each other.
- [Query Processing](https://docs.squirro.com/en/latest/technical/libnlp/apps-query.md): Query Processing steps help to better understand natural language queries and therefore improve the overall search experience.
- [Base Types](https://docs.squirro.com/en/latest/technical/libnlp/base.md): Introduces the fundament of libNLP.
- [How to Create Custom Query-Processing Steps](https://docs.squirro.com/en/latest/technical/libnlp/how-custom-query.md): This page discusses the following
- [libNLP](https://docs.squirro.com/en/latest/technical/libnlp/index.md): This page introduces libNLP and provides information on libNLP apps, base types, and troubleshooting.
- [Step Types](https://docs.squirro.com/en/latest/technical/libnlp/steps.md): Provides access to all predefined steps in libNLP.
- [Analyzers Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/analyzers.md): make_analyzer make_analyzer()
- [Classifiers Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/classifiers.md): make_classifier make_classifier()
- [Debuggers Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/debuggers.md): make_debugger make_debugger()
- [Embedders Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/embedders.md): make_embedder make_embedder()
- [External Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/external.md): EndpointStep EndpointStep EndpointStep.process_batch() EndpointStep.train_batch() MlflowMaasEndpointStep MlflowMaasEndpointStep MlflowMaasEndpointStep.process_batch() RemoteQuestionAnswering RemoteQuestionAnswering RemoteQuestionAnswering.get_client() RemoteQuestionAnswering.process_batch() Remot...
- [Filters Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/filters.md): make_filter make_filter()
- [Flow Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/flow.md): make_flow_step make_flow_step()
- [Loaders Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/loaders.md): make_loader make_loader()
- [Normalizers Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/normalizers.md): make_normalizer make_normalizer()
- [Projectors Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/projectors.md): make_projector make_projector()
- [Runtimes Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/runtimes.md): make_runtime_step make_runtime_step()
- [Savers Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/savers.md): CSVSaver CSVSaver CSVSaver.process_batch() JSONSaver JSONSaver JSONSaver.process_batch() Saver Saver SquirroEntityCleaner SquirroEntityCleaner SquirroEntityCleaner.process_batch() SquirroItemSaver SquirroItemSaver SquirroItemSaver.process_batch()
- [Standard Types](https://docs.squirro.com/en/latest/technical/libnlp/steps/standard.md): config (dict) – Dictionary config
- [Tokenizers Package](https://docs.squirro.com/en/latest/technical/libnlp/steps/tokenizers.md): make_tokenizer make_tokenizer()
- [Troubleshooting & FAQ](https://docs.squirro.com/en/latest/technical/libnlp/trouble.md): Something is not working properly.
- [Utils](https://docs.squirro.com/en/latest/technical/libnlp/utils.md): Provides access to utils defined in libNLP.
- [Cache Package](https://docs.squirro.com/en/latest/technical/libnlp/utils/cache.md): get_model_cache_client get_model_cache_client()
- [Model Management Package](https://docs.squirro.com/en/latest/technical/libnlp/utils/model_management.md): InMemModel InMemModel InMemModel.lifetime InMemModel.get_model() InMemModel.store_model() ModelNotInMemoryException ModelNotInMemoryException
- [Standard Types](https://docs.squirro.com/en/latest/technical/libnlp/utils/standard.md): Yield batches of docs from an iterable of docs
- [Transformers Package](https://docs.squirro.com/en/latest/technical/libnlp/utils/transformers.md): get_transformer get_transformer()
- [Machine Learning](https://docs.squirro.com/en/latest/technical/ml/index.md): This page contains information about machine learning (ML) services offered by Squirro.
- [How To Publish ML Models Using the Squirro Client](https://docs.squirro.com/en/latest/technical/ml/models-squirro-client.md): Besides publishing models directly from the AI Studio or importing published models through project import, you can also use the SquirroClient to publish ML models to the Data Processing Pipeline.
- [Significant Terms Extraction in Squirro](https://docs.squirro.com/en/latest/technical/ml/significant-terms.md): This section provides information on how the Significant Terms Extractor works and how it can be used inside a Squirro project.
- [API Reference](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/api-reference.md): The HTTP API is the surface that the genai CLI wraps.
- [Authoring Agents](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/authoring-agents.md): This page covers what you can change about an agent and when: how to write its instructions, and the full definitions of preferences, constraints, and pins.
- [CLI Reference](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/cli-reference.md): The genai command line interface authors, validates, and deploys agent configuration.
- [Agent Configuration](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/index.md): Agent configuration defines the GenAI agents that power the Chat dashboard in Project Neo: the models behind them, the capabilities they are allowed to use, the knowledge they can reach, and the preferences that govern their behavior.
- [Installation](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/installation.md): The genai command line tool is how you author, validate, and deploy an agent configuration.
- [Overview](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/overview.md): Agent configuration gives you one place to author and one command to deploy.
- [Preference Reference](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/preference-reference.md): Behavior is shaped through a flat set of settings addressed by dotted paths, grouped into four namespaces: inference, capability, source, and trait.
- [Prerequisites](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/prerequisites.md): With these in place, follow the Quick Start page to author, validate, and deploy your first configuration.
- [Quick Start](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/quick-start.md): This walkthrough takes you from an empty directory to a deployed, queryable configuration: three files, two commands, and one query.
- [Resource Reference](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/resource-reference.md): Configuration is made up of typed resources, and each kind has its own set of fields.
- [Scheduled Tasks and Approvals](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/tasks-and-approvals.md): Beyond authoring and deploying a configuration, the genai command line tool does two more things: it schedules an agent to run on its own, and it decides which tools the agent may use without a person approving the call first.
- [Troubleshooting](https://docs.squirro.com/en/latest/technical/neo/admin-guide/agent-config/troubleshooting.md): This page lists the common failures when authoring a configuration, deploying it, calling the API directly, and running scheduled tasks, each as a symptom, its cause, and the fix.
- [Administrator Guide](https://docs.squirro.com/en/latest/technical/neo/admin-guide/index.md): This section covers the setup and administration of Project Neo.
- [Observability](https://docs.squirro.com/en/latest/technical/neo/admin-guide/observability.md): Project Neo runs its AI features on the V1 runtime of the Squirro GenAI service.
- [Setup](https://docs.squirro.com/en/latest/technical/neo/admin-guide/setup.md): This page covers how to deploy Project Neo on an existing Squirro instance.
- [Building and Deploying](https://docs.squirro.com/en/latest/technical/neo/dev-guide/build-and-deploy.md): Bundles are deployed independently from the core Project Neo application.
- [Building Dashboard Components](https://docs.squirro.com/en/latest/technical/neo/dev-guide/building-dashboards.md): Every dashboard in your bundle is a standard React component.
- [CLI Reference](https://docs.squirro.com/en/latest/technical/neo/dev-guide/cli-reference.md): All commands are invoked as neo-ui <command>.
- [Developer Guide](https://docs.squirro.com/en/latest/technical/neo/dev-guide/index.md): The Project Neo Developer Guide covers building custom dashboard bundles that load into the Project Neo host application at runtime.
- [Local Development](https://docs.squirro.com/en/latest/technical/neo/dev-guide/local-development.md): This page explains how the development environment works, covering the two-server architecture, live reload, environment variables, and common workflows.
- [The Bundle Manifest](https://docs.squirro.com/en/latest/technical/neo/dev-guide/manifest.md): The manifest is the central configuration file for your bundle.
- [Overview](https://docs.squirro.com/en/latest/technical/neo/dev-guide/overview.md): The Project Neo bundle system lets development teams build custom dashboards that load into the Project Neo host application at runtime.
- [Prerequisites](https://docs.squirro.com/en/latest/technical/neo/dev-guide/prerequisites.md): Before creating your first bundle project, make sure you have everything listed below.
- [Project Structure](https://docs.squirro.com/en/latest/technical/neo/dev-guide/project-structure.md): After running neo-ui create bundle my-dashboards, the bundle directory has the following layout
- [Quick Start](https://docs.squirro.com/en/latest/technical/neo/dev-guide/quick-start.md): This guide gets your first custom dashboard running in Project Neo in under 10 minutes.
- [Squirro API](https://docs.squirro.com/en/latest/technical/neo/dev-guide/squirro-api.md): Your dashboards can fetch data from the Squirro API.
- [Styling and Components](https://docs.squirro.com/en/latest/technical/neo/dev-guide/styling-and-components.md): This page covers the UI components available to your bundle, how to use icons, and the styling system, including Tailwind CSS, typography classes, and theme tokens.
- [Translations](https://docs.squirro.com/en/latest/technical/neo/dev-guide/translations.md): Bundles can provide localized strings and override host UI text.
- [Troubleshooting](https://docs.squirro.com/en/latest/technical/neo/dev-guide/troubleshooting.md): This page covers common issues encountered when developing Project Neo bundles and how to resolve them.
- [Project Neo](https://docs.squirro.com/en/latest/technical/neo/index.md): Project Neo is the next generation of the Squirro user interface.
- [User Guide](https://docs.squirro.com/en/latest/technical/neo/user-guide/index.md)
- [Additional Labeling Pipelet](https://docs.squirro.com/en/latest/technical/pipelets/additional-labeling.md): Profile: Project Creator, Frontend Developer
- [Pipelets and the Dataloader](https://docs.squirro.com/en/latest/technical/pipelets/dl-pipelets.md): This page describes how to use pipelets with the Data Loader CLI Tool.
- [How to Access File Contents in Pipelets](https://docs.squirro.com/en/latest/technical/pipelets/how-to/how-access.md): When importing files, you sometimes need to access the contents of these files in a pipelet.
- [How to Use Pipelets With the Squirro Data Loader](https://docs.squirro.com/en/latest/technical/pipelets/how-to/how-loader.md): This example shows how pipelets can be used by the data loader to enrich data before it is uploaded to a Squirro server.
- [Pipelets How To Guides](https://docs.squirro.com/en/latest/technical/pipelets/how-to/index.md): This section contains links to pipelet how-to guides and tutorials.
- [Pipelets Tutorial](https://docs.squirro.com/en/latest/technical/pipelets/how-to/tutorial.md): Python Engineer, Project Creator
- [Pipelets](https://docs.squirro.com/en/latest/technical/pipelets/index.md): This page provides an overview of pipelets, which are plugins to the Squirro pipeline used to customize data processing.
- [Pipelets Reference](https://docs.squirro.com/en/latest/technical/pipelets/reference.md): Baseclass for all Pipelets.
- [Rerunning a Pipelet](https://docs.squirro.com/en/latest/technical/pipelets/rerun.md): This page describes how pipelets can be rerun both from the command line and within the UI.
- [Scaling Pipelet Execution](https://docs.squirro.com/en/latest/technical/pipelets/scaling.md): Profile: Project Creator, System Administrator
- [Time Formats Pipelet](https://docs.squirro.com/en/latest/technical/pipelets/time-format.md): This page describes the Time Formats pipelet, which supports the list of format strings on the Squirro UI.
- [Troubleshooting and FAQ](https://docs.squirro.com/en/latest/technical/pipelets/trouble.md): Profile: Project Creator, Python Engineer
- [Development Workflow](https://docs.squirro.com/en/latest/technical/pipelets/workflow.md): Profile: Project Creator, Python Engineer
- [Writing Pipelets](https://docs.squirro.com/en/latest/technical/pipelets/write.md): This page describes how to write pipelets for Squirro.
- [Retrieval Augmented Generation](https://docs.squirro.com/en/latest/technical/retrieval-augmented-generation/index.md): Retrieval Augmented Generation (RAG) is a technology that combines the capabilities of retrieval systems with language models to produce more accurate, context-aware responses.
- [Search Bar Chips](https://docs.squirro.com/en/latest/technical/search/features/chips.md): When you submit a search query within Squirro global search, you’ll notice your search query is broken into chips within the search bar.
- [Concept Search](https://docs.squirro.com/en/latest/technical/search/features/concept-search.md): Profiles: Project Creator, Search User
- [Favorite Filters](https://docs.squirro.com/en/latest/technical/search/features/favorite-filters.md): A favorite allows you to save searches or queries for easy access and navigation.
- [UI Search Features](https://docs.squirro.com/en/latest/technical/search/features/index.md): Visit Cognitive Search for End Users for non-technical training and certification related to Squirro Cognitive Search usage and features as an end user.
- [Other People Ask](https://docs.squirro.com/en/latest/technical/search/features/other-people.md): Profiles: Project Creator, Search User
- [Popular Query Suggestions](https://docs.squirro.com/en/latest/technical/search/features/popular-query.md): Profiles: Project Creator, Search User
- [Question Answering](https://docs.squirro.com/en/latest/technical/search/features/qa.md): Profiles: Project Creator, Search User
- [Query Syntax](https://docs.squirro.com/en/latest/technical/search/features/query-syntax.md): Profiles: Project Creator, Search User
- [Semantic and Hybrid Search](https://docs.squirro.com/en/latest/technical/search/features/semantic-search.md): Profiles: Project Creator, Search User
- [Spellchecking](https://docs.squirro.com/en/latest/technical/search/features/spellcheck.md): Profiles: Project Creator, Search User
- [Typeahead Suggestions](https://docs.squirro.com/en/latest/technical/search/features/typeahead.md): Profiles: Project Creator, Search User
- [CrossEncoderOutputs](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.CrossEncoderOutputs.md)
- [CrossEncoderResponse](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.CrossEncoderResponse.md)
- [EmbeddingDataType](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.EmbeddingDataType.md): Valid values are as follows
- [RerankerInputs](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.RerankerInputs.md)
- [RerankerPayload](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.RerankerPayload.md)
- [SentenceEmbeddingsInputs](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.SentenceEmbeddingsInputs.md): Number of embedding dimensions to keep (positive n keeps first n dimensions, negative n drops last n dimensions, 0 for no truncation
- [SentenceEmbeddingsOutputs](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.SentenceEmbeddingsOutputs.md)
- [SentenceEmbeddingsPayload](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.SentenceEmbeddingsPayload.md)
- [SentenceEmbeddingsResponse](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.SentenceEmbeddingsResponse.md)
- [SentenceType](https://docs.squirro.com/en/latest/technical/search/how-to-guides/_autosummary/squirro.common.clients.transformers.SentenceType.md): Valid values are as follows
- [How To Set Up a Cognitive Search Application](https://docs.squirro.com/en/latest/technical/search/how-to-guides/cog-search.md): This page details how to set up, install, and configure the Squirro Cognitive Search application in your browser.
- [How To Use Best-Bets Labels to Map Query Terms](https://docs.squirro.com/en/latest/technical/search/how-to-guides/how-best-bets.md): Profiles: Project Creator, Search Engineer
- [How to Use The Other People Ask Feature](https://docs.squirro.com/en/latest/technical/search/how-to-guides/how-other-people.md): Profiles: Project Creator
- [How To Use The Question Answering Feature](https://docs.squirro.com/en/latest/technical/search/how-to-guides/how-qa.md): With the Question Answering (QA) feature Squirro aims to provide direct answers to user questions, instead of purely returning search results.
- [How To Handle User Query Terms Correctly](https://docs.squirro.com/en/latest/technical/search/how-to-guides/how-query-terms.md): The Query Term Matching Strategy specifies how Search Terms are interpreted and translated into Elasticsearch query clauses.
- [How to Use Scoring Profiles to Customize Document Relevancy Scoring](https://docs.squirro.com/en/latest/technical/search/how-to-guides/how-relevancy.md): Profiles: Project Creator, Search Engineer
- [How to integrate remote models that power semantic search and other NLP tasks](https://docs.squirro.com/en/latest/technical/search/how-to-guides/how-remote-models.md): Remote Services (service_variants) are registered following the format of <model namespace>.<language>.<worker>, for example spacy.en.fast.
- [How-To Guides](https://docs.squirro.com/en/latest/technical/search/how-to-guides/index.md): Visit Cognitive Search for Project Creators for technical training and certification related to Squirro Cognitive Search usage and features as a project creator.
- [Search](https://docs.squirro.com/en/latest/technical/search/index.md): For training and certification related to Squirro Cognitive Search, visit Squirro Academy.
- [Language Support](https://docs.squirro.com/en/latest/technical/search/language-support.md): The search feature of an enterprise GenAI platform is crucial for efficient information retrieval.
- [Query Processing](https://docs.squirro.com/en/latest/technical/search/query-processing.md): This page provides an overview of query-processing workflows in the Squirro platform.
- [Recommendations](https://docs.squirro.com/en/latest/technical/search/recommendations.md): Profiles: Search Engineer, Data Scientist
- [Document Relevancy](https://docs.squirro.com/en/latest/technical/search/relevancy/index.md): Profiles: Project Creator, Search Engineer
- [PopularItemClauseBuilder](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.behavioural.recommenders.PopularItemClauseBuilder.md): popular_item | Boost trendy items
- [SubscribedCommunitiyClauseBuilder](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.behavioural.recommenders.SubscribedCommunitiyClauseBuilder.md): subscribed_communities | Add communty filter queries for user’s subscribed communities.
- [UserLastReadItem](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.behavioural.recommenders.UserLastReadItem.md): last_read | Boost last read items.
- [UserSearchHistoryRecommender](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.behavioural.recommenders.UserSearchHistoryRecommender.md): recommend_on_searches | Recommend items based on users search history
- [UsersItemHistoryRecommender](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.behavioural.recommenders.UsersItemHistoryRecommender.md): recommend_on_user_items | Recommend items based on users item interaction history
- [RecencyBoost](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.content.recommenders.RecencyBoost.md): recency_boost | Make recent documents more relevant
- [SimilarItemsRecommender](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.recommend.content.recommenders.SimilarItemsRecommender.md): recommend_on_item | Recommend other items based on provided item-id’s
- [Reranker](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.rerank.transformer_rerankers.Reranker.md): reranker | Rerank first-stage retrieved paragraphs based on the contextualized similarity of query <-> paragraph.
- [ExactKnnScriptScore](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.embedding_retrievers.ExactKnnScriptScore.md): exact_knn | Return a Script-Score Query to perform Cosine Similarity on dense vector fields.
- [SemanticRescore](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.embedding_retrievers.SemanticRescore.md): semantic_rescore | Rescore the top N ranked paragraphs based on the similarity between query embedding and pre-computed paragraph embeddings.
- [SemanticSearch](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.embedding_retrievers.SemanticSearch.md): semantic | Perform approximate k-NN search on the paragraph embeddings using the HNSW vector index, and optionally rescore the results.
- [FullTextMatch](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.fulltext_match.FullTextMatch.md): fulltext_match — Perform explicit lexical full-text matching on specified fields.
- [ConceptSearchClauseBuilder](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.lexical_retrievers.ConceptSearchClauseBuilder.md): concept | Run the concept search algorithm on the provided text, or automatically on the overall query terms.
- [FuzzyTermMatcher](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.lexical_retrievers.FuzzyTermMatcher.md): fuzzy_match | Perform fuzzy term matching on the selected fields.
- [PrefixTermMatcher](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.lexical_retrievers.PrefixTermMatcher.md): prefix_match | Perform (phrase) prefix term matching on the specified fields, enforce phrase matching considering term-order (optionally) and phrase-slop.
- [ParagraphHighlight](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.retrieve.paragraph_highlight.ParagraphHighlight.md): paragraph_highlight | Highlight a specific paragraph that has been been processed by the Paragraph Embedding step given its ID.
- [ExtractiveQASummary](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.view.transformer_qa.ExtractiveQASummary.md): extractive-qa | Build abstract based on extractive QA results on top ranked results
- [WithUserReadInfo](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/_autosummary/squirro.lib.search.relevancy.plugins.view.user_info.WithUserReadInfo.md): with_user_read | Tag Items with read:True if user has read the item before.
- [Scoring Plugins](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/index.md): Scoring plugins are used to boost or filter documents based on specific criteria.
- [Recommend](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/recommend.md): PopularItemClauseBuilder PopularItemClauseBuilder PopularItemClauseBuilder.PluginConfig PopularItemClauseBuilder.PluginConfig.PluginConfig.plugin_name PopularItemClauseBuilder.PluginConfig.PluginConfig.min_popularity PopularItemClauseBuilder.PluginConfig.PluginConfig.last_months PopularItemClause...
- [Rerank](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/rerank.md): Reranker Reranker Reranker.PluginConfig Reranker.PluginConfig.PluginConfig.plugin_name Reranker.PluginConfig.PluginConfig.top_n_items Reranker.PluginConfig.PluginConfig.query Reranker.PluginConfig.PluginConfig.worker Reranker.PluginConfig.PluginConfig.rerank_score_mode Reranker.PluginConfig.Plugi...
- [Retrieve](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/retrieve.md): ConceptSearchClauseBuilder ConceptSearchClauseBuilder ConceptSearchClauseBuilder.PluginConfig ConceptSearchClauseBuilder.PluginConfig.PluginConfig.plugin_name ConceptSearchClauseBuilder.PluginConfig.PluginConfig.text PrefixTermMatcher PrefixTermMatcher PrefixTermMatcher.PluginConfig PrefixTermMat...
- [View](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-plugins/view.md): ExtractiveQASummary ExtractiveQASummary ExtractiveQASummary.PluginConfig ExtractiveQASummary.PluginConfig.PluginConfig.plugin_name ExtractiveQASummary.PluginConfig.PluginConfig.on_top_n ExtractiveQASummary.PluginConfig.PluginConfig.query ExtractiveQASummary.PluginConfig.PluginConfig.worker
- [Scoring Profiles and Roles](https://docs.squirro.com/en/latest/technical/search/relevancy/scoring-profiles.md): Profiles: Project Creator, Search Engineer
- [Search Evaluation](https://docs.squirro.com/en/latest/technical/search/relevancy/search_evaluation_documentation.md): The Search Evaluation plugin is a comprehensive tool for evaluating and comparing different search strategies within the Squirro platform.
- [Searchable File Types](https://docs.squirro.com/en/latest/technical/search/supported-docs.md): This page provides a list of the file types that can be searched by content in Squirro, and also which file types can be searched by title and opened using a program outside of Squirro.
- [Synonyms](https://docs.squirro.com/en/latest/technical/search/synonyms.md): Profiles: Project Creator
- [Project Export & Import](https://docs.squirro.com/en/latest/technical/templates/import-export.md): This page provides instructions on how to export and import Squirro projects using both the Squirro user interface (UI) and the SquirroClient.
- [Project Templates](https://docs.squirro.com/en/latest/technical/templates/index.md): This section introduces project templates and provides instructions on how to configure, import, and export Squirro projects.
- [Project Configuration](https://docs.squirro.com/en/latest/technical/templates/project-configuration.md): Project configuration allows you to specify settings within a project.
- [Project Templates Overview](https://docs.squirro.com/en/latest/technical/templates/project-templates.md): Squirro supports exporting a complete project including all the definitions (dashboards, custom assets, etc.) in a compressed file format.
- [App and Nav Bar Styling](https://docs.squirro.com/en/latest/technical/ui/app-nav.md): In App and Nav Bar settings under the Setup space you can quickly customize Squirro to match a corporate brand.
- [Connecting to Squirro](https://docs.squirro.com/en/latest/technical/ui/connecting.md): To load data into Squirro, you need to set up a connection.
- [User Interface](https://docs.squirro.com/en/latest/technical/ui/index.md): This section provides an overview of the Squirro User Interface and common pages encountered when using Squirro.
- [Read, Unread, New, and Bookmarked Items](https://docs.squirro.com/en/latest/technical/ui/items-interaction.md): Squirro provides features to track which items have been read, identify newly created items, and bookmark important items for quick access.
- [Note Taking](https://docs.squirro.com/en/latest/technical/ui/notes.md): The Note Taking feature allows project users to perform the following tasks
- [UI Overview](https://docs.squirro.com/en/latest/technical/ui/overview.md): This page provides an overview of the Squirro user interface (UI).
- [Squirro Roles & Permissions](https://docs.squirro.com/en/latest/technical/ui/permissions.md): To control access to different parts of a Squirro installation, Squirro provides different roles, each with its own unique set of permissions.
- [Project Browser](https://docs.squirro.com/en/latest/technical/ui/project-browser.md): The Project Browser is a part of the UI that allows users to navigate to existing projects or create a new project via the side panel.
- [Reference Screen](https://docs.squirro.com/en/latest/technical/ui/reference-screen.md): The Reference Screen is a split screen view of two documents side-by-side that helps the user identify entities in one document and retrieve relevant information about that entity in a second (reference) document.
- [Squirro Spaces](https://docs.squirro.com/en/latest/technical/ui/spaces.md): Squirro projects are broken into three primary Spaces
- [Squirro Monitoring](https://docs.squirro.com/en/latest/technical/ui/squirro-monitoring.md): This page describes the Squirro Monitoring space, which allows you to monitor user and data ingestion activity throughout your Squirro instance.
- [Studio](https://docs.squirro.com/en/latest/technical/ui/studio/index.md): Squirro Studio is the overall name for the functionalities used by project creators to develop Squirro projects.
- [ML Jobs](https://docs.squirro.com/en/latest/technical/ui/studio/ml-jobs.md): Machine Learning Jobs is used to manage the machine learning jobs associated with all Machine Learning Workflows in a project.
- [ML Workflows](https://docs.squirro.com/en/latest/technical/ui/studio/ml-workflows.md): Machine Learning Workflows is used to manage the machine learning workflows in a project.
- [Themes](https://docs.squirro.com/en/latest/technical/ui/themes.md): Using Themes under the Setup space, you can quickly and easily manage themes in the UI.
- [Custom Widgets and the Dashboard Store](https://docs.squirro.com/en/latest/technical/widgets/backbone/dashboard-store.md): The dashboard store is accessible in the widget using the widget.dashboard.store property (usually this.dashboard.store).
- [Models, Views, & Collections](https://docs.squirro.com/en/latest/technical/widgets/backbone/faqs/backbone.md): Backbone.js gives structure to web applications by providing models with key-value binding and custom events, collections with a rich API of enumerable functions, views with declarative event handling, and connects it all to your existing API over a RESTful JSON interface.
- [Debugging](https://docs.squirro.com/en/latest/technical/widgets/backbone/faqs/debugging.md): All modern browsers (Chrome, Firefox, Safari, and Microsoft Edge) include built-in developer tools.
- [FAQ](https://docs.squirro.com/en/latest/technical/widgets/backbone/faqs/faq.md): Yes, there are a couple of methods to achieve this.
- [Common Knowledge](https://docs.squirro.com/en/latest/technical/widgets/backbone/faqs/index.md): Contents:FAQ Debugging Models, Views, & Collections JavaScript
- [JavaScript](https://docs.squirro.com/en/latest/technical/widgets/backbone/faqs/javascript.md): ECMAScript 6, also known as ES6 and ECMAScript 2015, was the second major revision to JavaScript.
- [Backbone Custom Widgets](https://docs.squirro.com/en/latest/technical/widgets/backbone/index.md): Squirro Dashboards can be extended with custom widgets, tailored for specific use cases that can not be achieved with the default widget set.
- [Custom Widgets Life Cycle](https://docs.squirro.com/en/latest/technical/widgets/backbone/life-cycle.md): A custom widget goes through different stages in its life cycle.
- [Accessing Data](https://docs.squirro.com/en/latest/technical/widgets/backbone/tutorials/accessing_data.md): The primary job of Squirro dashboards is to display data that have been loaded into Squirro in an intuitive form.
- [Tutorials](https://docs.squirro.com/en/latest/technical/widgets/backbone/tutorials/index.md): The tutorials show how to tackle various issues a developer might encounter while extending the core widgets.
- [Getting Started](https://docs.squirro.com/en/latest/technical/widgets/backbone/tutorials/widgets_tutorial.md): This tutorial includes two examples which go step by step through creating a custom widget.
- [Squirro Widget CLI Reference](https://docs.squirro.com/en/latest/technical/widgets/backbone/widget-cli.md): The squirro_widget command line tool, part of the Squirro Toolbox, is used to manage custom widgets on a Squirro cluster.
- [Example Card or Result List Custom Widget](https://docs.squirro.com/en/latest/technical/widgets/backbone/widget-example.md): This article describes the process for customizing the Cards widget but this same example could apply to the Result List widget.
- [Custom Widgets for Dashboards](https://docs.squirro.com/en/latest/technical/widgets/backbone/widgets-dashboards.md): This page shows the full usage of the custom widgets for Squirro dashboards.
- [Action Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/actions.md): The Actions widget (previously called Link widget) is used to present actions to the user.
- [Bar Chart Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/bar-chart.md): The Bar Chart Widget allows you to visualize the distribution of a numeric field in your data.
- [Batch Q&A](https://docs.squirro.com/en/latest/technical/widgets/built-in/batch-question-answer.md): Powered by Squirro Chat, the Batch Q&A widget allows users to process multiple questions simultaneously and receive detailed answers within the context of a project dataset.
- [Breadcrumbs Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/breadcrumbs.md): The Breadcrumbs widget is a navigation element that shows the current page’s location in the site hierarchy.
- [Chat Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/chat.md): Powered by Squirro Chat, the Chat widget extends the capabilities of your dashboards, allowing users to ask questions and receive detailed answers within the context of a specific dataset.
- [Communities Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/communities.md): The Communities widget presents a list of communities to the user.
- [Communities Banner Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/communities-banner.md): The Communities Banner widget shows information about the currently selected Community in a dashboard.
- [Divider Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/divider.md): The divider widget groups widgets into sections, allowing you to create a header that can be left, center, or right-aligned.
- [Engagement Map Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/engagement-map.md): The Engagement Map widget visualizes relationships between people.
- [Entities Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/entities.md): The Entities widget displays all the entities available in the project, in a dropdown fashion similar to the Facets widget.
- [Favorites Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/favorites.md): The Favorites widget displays queries a user added to the favorites list or for which an alert is defined.
- [Heat Map Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/heat-map.md): The Heat Map is a convenient way to represent the aggregations between two facets present in the project.
- [HTML Editor Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/html-editor.md): The HTML Editor widget can be used to add static HTML text content to a Dashboard.
- [iFrame Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/iframe.md): The IFrame widget allows you to embed websites into the Squirro Dashboard.
- [Built-In Widgets](https://docs.squirro.com/en/latest/technical/widgets/built-in/index.md): For visualization of data on a dashboard, Squirro offers many out-of-the-box widgets that can be configured in the Dashboard Editor.
- [Info Card Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/info-card.md): Info card widget shows top community for the current query and dashboard filters.
- [Item Detail Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/item-detail.md): The Item Detail Widget, also called the Document Details, is the starting point for exploring and interacting with specific content.
- [Items Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/items.md): The Items widget provides the standard way of presenting result sets on Squirro dashboards.
- [Items Table Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/items-table.md): The Items Table widget is used to display values of specific labels for every document in the result list.
- [Labels Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/labels.md): The Labels widget (formerly called the Facets widget) can be configured to display all contributing labels in the project or a combination of desired labels.
- [Line Chart Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/line-chart.md): The Line chart displays the values of one label in the form of a time-based line chart.
- [Metrics Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/metrics.md): The Metrics widget can be used to display the count of a single metric to create a high-level summary of the dashboard.
- [Navigation Chips Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/navigation-chips.md): The Navigation Chips widget is conceptually similar to, and functions like, the Tabs widget.
- [Pie Chart Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/pie-chart.md): The Pie Chart widget is used to display values of a specific label in a classic pie or a donut format.
- [QA Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/qa.md): The QA widget is used to present short answers based on the user’s query.
- [Region Map Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/region-map.md): The Region Map widget is used for map-based data visualizations.
- [Reset Filters Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/reset-filters.md): The Reset Filters widget is conceptually similar to the Breadcrumbs widget as it shows the list of filters applied to the dashboard and allows the user to clear them.
- [Rich Text Editor Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/rich-text.md): The Rich Text Editor widget is a text editor that allows you to add rich text content to your dashboard.
- [Search Bar Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/search-bar.md): The Search Bar widget is essentially a Squirro Search box, with the exception that it’s aimed at refining the current dashboard query, rather than fully controlling it.
- [Spelling Correction Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/spelling.md): The Spelling Correction widget presents spell-checking results to the user.
- [Table Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/table.md): The Table widget displays the top values for a label in a table format, along with the number of matches and their relative contribution in percentage in the analyzed documents.
- [Tabs Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/tabs.md): The Tabs widget is designed to be used as a navigational component.
- [Time Selection Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/time-selection.md): The Time Selection widget can be used to display a predefined set of time-based queries.
- [Timeline Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/timeline.md): The Timeline widget is a visualization of a time series of results.
- [Word Cloud Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/word-cloud.md): The Word Cloud widget is used to display values of several facets (max.
- [World Map Widget](https://docs.squirro.com/en/latest/technical/widgets/built-in/world-map.md): The World Map widget visualizes geographic data on a world map.
- [Custom Widgets](https://docs.squirro.com/en/latest/technical/widgets/custom-widget.md): Squirro offers you the ability to create unique visual experiences and extend Squirro dashboards using custom widgets.
- [How to Create a Squirro Custom Widget](https://docs.squirro.com/en/latest/technical/widgets/how-custom.md): This guide will walk you through creating and deploying a Squirro custom widget.
- [Widgets](https://docs.squirro.com/en/latest/technical/widgets/index.md): This page discusses both out-of-the-box and custom widgets used to visualize information in Squirro dashboards.
- [Creating React Custom Widgets](https://docs.squirro.com/en/latest/technical/widgets/react/create.md): When creating a new widget, it’s helpful to understand the available Squirro variables, libraries, and collections.
- [Customizing React Custom Widgets](https://docs.squirro.com/en/latest/technical/widgets/react/customize.md): This page provides an overview of customizing Squirro React widgets.
- [Available React Hooks](https://docs.squirro.com/en/latest/technical/widgets/react/hooks.md): This page describes the React hooks available for use.
- [How To Opt In To React Widgets](https://docs.squirro.com/en/latest/technical/widgets/react/how-to-guides/how-opt.md): This page provides step-by-step instructions for opting in to React widgets from your project dashboard.
- [How To Style React Widgets](https://docs.squirro.com/en/latest/technical/widgets/react/how-to-guides/how-style.md): This page provides an overview of how to style React custom widgets using Squirro Storybook and the Emotion library.
- [React How-Tos and Walkthroughs](https://docs.squirro.com/en/latest/technical/widgets/react/how-to-guides/index.md): The following how-to guides and walkthroughs help show you how to create and use custom React widgets within your Squirro installation
- [Items Widget Styling Walkthrough](https://docs.squirro.com/en/latest/technical/widgets/react/how-to-guides/walkthrough-items.md): This page will guide you through how to customize the React Items widget’s title font size and color.
- [Adding Tooltips to Tabs Widget Walkthrough](https://docs.squirro.com/en/latest/technical/widgets/react/how-to-guides/walkthrough-tooltips.md): This page will guide you through how to add a Tooltip to the Tabs widget using Material UI components.
- [React Custom Widgets](https://docs.squirro.com/en/latest/technical/widgets/react/index.md): This page provides an overview of Squirro custom widgets created or modified using React.
- [Available Libraries](https://docs.squirro.com/en/latest/technical/widgets/react/libraries.md): This page details the libraries used to create and modify React custom widgets.
- [Getting Started with React](https://docs.squirro.com/en/latest/technical/widgets/react/start.md): This page introduces React and provides links to third-party resources for learning more about it.
- [Squirro Storybook](https://docs.squirro.com/en/latest/technical/widgets/react/storybook.md): This page provides an overview of Squirro Storybook, a components library Squirro uses to document and test widgets and components.
- [Styling React Components](https://docs.squirro.com/en/latest/technical/widgets/react/style.md): Squirro uses CSS in JavaSript together with an Emotion library to style React custom widgets.
- [Factories](https://docs.squirro.com/en/latest/technical/widgets/sdk/factories.md): A factory class for item collections
- [Squirro Widget SDK](https://docs.squirro.com/en/latest/technical/widgets/sdk/index.md): Contents:Properties Factories Utils
- [Properties](https://docs.squirro.com/en/latest/technical/widgets/sdk/properties.md): Most widgets require configuration to function correctly.
- [Utils](https://docs.squirro.com/en/latest/technical/widgets/sdk/utils.md): Renders a modal dialog asking the user a yes/no question.
- [Workspaces](https://docs.squirro.com/en/latest/technical/workspaces/index.md): The Workspaces feature, formerly known as tenants, offers administrators and engineers more flexibility for content management, and additional granularity for access rights and data management.