Params

Bases: str, Enum

How to segment text into passages for highlighting.

Controls where snippets begin and end: - SENTENCE: Break on sentence boundaries (recommended for natural-looking snippets) - WORD: Break on word boundaries - SEPARATOR: Break on a custom character - CHARACTER: Break anywhere - LINE: Break on line breaks - WHOLE: Treat entire field as one passage

Reference: https://solr.apache.org/guide/solr/latest/query-guide/highlighting.html

Bases: ParamsMixin

Common query parameters: https://solr.apache.org/guide/solr/latest/query-guide/common-query-parameters.html

Bases: str, Enum

Faceting algorithm methods.

Choose based on your field characteristics: - ENUM: Best for fields with few distinct values (enumerates all terms) - FIELD_CACHE: Best for fields with many unique terms but few per document - PER_SEGMENT: Best for single-valued strings with frequent index updates

Reference: https://solr.apache.org/guide/solr/latest/query-guide/faceting.html#the-facet-method-parameter

Bases: ParamsConfig

Solr Faceting Configuration - Categorize and Count Search Results.

Faceting breaks down search results into categories with counts, enabling drill-down navigation and data analysis.

Common Patterns:

Basic Field Faceting:
```python
config = FacetParamsConfig(
    fields=['category', 'brand'],  # Fields to facet on
    limit=10,  # Top 10 values
    mincount=1  # Skip empty facets
)
```

Range Faceting (Prices, Dates):
```python
config = FacetParamsConfig(
    range_field=['price'],
    range_start={'price': '0'},
    range_end={'price': '1000'},
    range_gap={'price': '100'}  # $0-100, $100-200, etc.
)
```

Filtered Facets:
```python
config = FacetParamsConfig(
    fields=['color'],
    prefix='bl',  # Only colors starting with 'bl' (blue, black)
    mincount=5  # Only show if 5+ matches
)
```

Bases: str, Enum

How to order facet results.

• COUNT: Sort by frequency (most common first) - default for most use cases
• INDEX: Sort lexicographically (alphabetically)

Bases: str, Enum

Fragment list builder types.

Bases: str, Enum

Text snippet generator types.

Bases: str, Enum

Fragments builder types.

Bases: ParamsConfig

Solr Result Grouping - Collapse Results by Common Values.

Result grouping (also known as field collapsing) combines documents that share a common field value. Useful for: - Showing one result per author, category, or domain - Preventing duplicate-like results from dominating - Creating grouped summaries of search results

config = GroupParamsConfig(
    by='author',  # Group documents by author
    limit=3,  # Show up to 3 docs per author
    sort='date desc',  # Newest first within each group
    ngroups=True  # Include count of total groups
)

config = GroupParamsConfig(
    query=['price:[0 TO 50]', 'price:[50 TO 100]'],  # Custom groups
    limit=5  # Up to 5 docs per price range
)

Bases: str, Enum

Highlight text encoding options.

Bases: str, Enum

Available highlighting methods.

Bases: ParamsConfig

Configuration for Solr Highlighting.

Highlighting allows you to show snippets of text from documents with query terms emphasized (usually wrapped in tags). Common use cases include: - Search result snippets showing matched terms in context - Preview text with keywords highlighted - Showing relevant passages from long documents

# Basic highlighting setup
highlight_config = HighlightParamsConfig(
    method='unified',  # Use the recommended Unified Highlighter
    fields=['title', 'content'],  # Fields to highlight
    snippets_per_field=3,  # Show up to 3 snippets per field
    fragment_size=150,  # ~150 character snippets
    tag_before='<mark>',  # HTML tag before matched term
    tag_after='</mark>'  # HTML tag after matched term
)