/**
     * Enable or disable search suggestions based on search logs.
     * When enabled, suggestions are generated from previous searches.
     */
    @Size(max = 10)
    public String suggestSearchLog;

    /**
     * Enable or disable search suggestions based on document content.
     * When enabled, suggestions are generated from indexed documents.
     */
    @Size(max = 10)

 *   <li>{@link #getAllWordsNum()}: Returns the total number of words in the suggestion index.</li>
 *   <li>{@link #getDocumentWordsNum()}: Returns the number of document words in the suggestion index.</li>
 *   <li>{@link #getQueryWordsNum()}: Returns the number of query words in the suggestion index.</li>
 * </ul>
 *
 * <p>Protected Methods:
 * <ul>

    private final AnalyzerSettings analyzerSettings;

    /**
     * The settings for suggestions.
     */
    private final SuggestSettings settings;

    /**
     * Constructs an AnalyzerNormalizer with the specified client and settings.
     *
     * @param client   the OpenSearch client
     * @param settings the settings for suggestions
     */
    public AnalyzerNormalizer(final Client client, final SuggestSettings settings) {

# CLAUDE.md - Fess Suggest Project Guide

> AI assistant guidance for the Fess Suggest project - a Java library providing intelligent search suggestions built on OpenSearch.

## Project Overview

**Fess Suggest** delivers auto-completion, search suggestions, and popular word analytics with multi-language support.

**Technology Stack:**
- Java 21+, Maven
- OpenSearch (provided dependency)
- Apache Lucene (query parsing, text analysis)

         * @param request The HTTP servlet request
         * @param query The search query string
         * @param tags Array of tags to filter suggestions
         * @param fields Array of fields to search in for suggestions
         * @param num The maximum number of suggestions to return
         */
        protected RequestParameter(final HttpServletRequest request, final String query, final String[] tags, final String[] fields,

 *       </ul>
 *   </li>
 * </ul>
 *
 * <p>Fields:
 * <ul>
 *   <li>{@link #client}: The client used to perform analysis.</li>
 *   <li>{@link #settings}: The settings for suggestions.</li>
 *   <li>{@link #analyzerSettings}: The settings for the analyzer.</li>
 *   <li>{@link #transliterator}: The transliterator used to convert between Hiragana and Katakana.</li>
 * </ul>
 */

import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;

import jakarta.annotation.PostConstruct;

/**
 * Helper class for managing popular words and suggestions.
 * Provides functionality to retrieve popular words based on search parameters
 * and manages caching for improved performance.
 */
public class PopularWordHelper {
    /** Logger instance for this class */

 * <li>{@link #logger} - Logger instance.
 * <li>{@link #client} - OpenSearch client.
 * <li>{@link #index} - Index name.
 * <li>{@link #settings} - Suggest settings.
 * <li>{@link #supportedFields} - Supported fields for suggestions.
 * <li>{@link #tagFieldNames} - Tag field names.
 * <li>{@link #roleFieldName} - Role field name.
 * <li>{@link #langFieldName} - Language field name.
 * <li>{@link #badWords} - List of bad words.

        if (!ComponentUtil.getFessConfig().isSuggestDocuments() && !ComponentUtil.getFessConfig().isSuggestSearchLog()) {
            logger.info("Skipped creating suggest index: both document and search log suggestions are disabled.");
            return 0;
        }

        final SuggestHelper suggestHelper = ComponentUtil.getSuggestHelper();

        logger.info("Creating new suggest index.");

- **Index Size**: Storage requirements for search indices
- **Crawl Sources**: URLs, file shares, databases being indexed
- **Custom Configurations**: URL patterns, security rules, metadata fields
- **Search Features**: Facets, suggestions, security filtering, ranking rules
- **Integration Points**: Applications consuming search APIs
- **User Permissions**: Access control and label configurations

### 2. Infrastructure Requirements