Typeahead Suggestions#

Profiles: Project Creator, Search User

The search bar within Squirro Cognitive Search offers a rich set of type-ahead functionalities out of the box.

Configured out of the box, search users are provided suggestions based on typehead configurations that can be modified by the project creator.

../../../_images/searchbar_suggestions.png

Based on Document Features#

Typeahead suggestions can come from three different sources:

Content (Key Phrases and Title), as described on this page.
Labels and their values.
Communities.

Content-based Typeahead#

Squirro provides search completion based on document features. This is in addition to the typeahead based on label values.

Features#

Matching on key-phrases and document title
Fuzzy phrase-term matching
- Optional enforcing of in-order term matching
- Support for phrase slop: maximum number of intervening unmatched positions

Setup#

To enable the content-based typeahead, add the NLP Keyphrase Tagger (see Discover (NLP Tagger)) step to the corresponding pipeline.

Add the NLP Keyphrase Tagger pipelet (found in the Discover section) to a pipeline workflow:

This enrichment will create a hidden label nlp_tag__phrases, which contains the extracted key phrases:

Based on User Interaction#

User’s Saved Searches
User’s Search History
Popular queries (see Popular Query Suggestions) across the project (or for a single user).

Using `SquirroClient`#

All suggestions can be accessed programmatically via the SquirroClient (Python SDK).

For this, see TopicApiBaseMixin, specifically get_typeahead_suggestions().

Configuration#

Typeahead Suggestions can be configured in Setup > Settings > Project Configuration.

Suggestions Based on Document Content#

Project Configuration topic.typeahead.content.configuration

Reference: Configuration Schema

pydantic model ContentTypeaheadConfig#

Content-based Typeahead configuration.

For more information about the Typeahead Suggestions feature in Squirro see: https://docs.squirro.com/en/latest/technical/search/features/typeahead.html

Fields

fuzziness (str)
fuzzy_max_expansions (int)
fuzzy_prefix_length (int)
highlighter (squirro.common.schema.typeahead.ContentTypeaheadHighlighter)
in_order (bool)
slop (int)
terminate_after (int)

field fuzziness: str = 'AUTO'#: Specifies the maximum edit distance allowed for matching. The fuzziness parameter can be specified as: 0, 1, 2: The maximum allowed Levenshtein Edit Distance (or number of edits), AUTO: Generates an edit distance based on the length of the term.

field fuzzy_max_expansions: int = 1#: Maximum number of variations created.

field fuzzy_prefix_length: int = 2#: Number of beginning characters left unchanged when creating expansions.

field highlighter: squirro.common.schema.typeahead.ContentTypeaheadHighlighter = ContentTypeaheadHighlighter.UNIFIED#: Highlighter type.

field in_order: bool = False#: Require matched spans to be in-order.

field slop: int = 6#: Maximum number of intervening unmatched positions.

field terminate_after: int = 100000#: Tradeoff between accurate matching and speed. The typeahead search request gets terminated after N matching documents (per shard) are found. Potentially higher scoring results may be missed out.

Suggestions Based on Label Values#

Project Configuration topic.typeahead.facetvalue.configuration

{
    "terminate_after": string,
    "sample_shard_size": int,
    "aggregation_method": "significant_terms",
    "community_drill_down": {
        "enabled": true,
        "for_top_n": 1
    }
}