# 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)

 *   <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>

Instead of adding suggestions to the translation PR, make the suggestions to the LLM prompt file for that language, in a new PR. For example, for Spanish, the LLM prompt file is at: [`docs/es/llm-prompt.md`](https://github.com/fastapi/fastapi/blob/master/docs/es/llm-prompt.md).

        this.normalizer = normalizer;
        this.languages = languages;
        this.prefixMatchWeight = prefixMatchWeight;
    }

    /**
     * Builds the query for suggestions.
     * @param q The query string.
     * @param fields The fields to search in.
     * @return The QueryBuilder instance.
     */
    public QueryBuilder buildQuery(final String q, final List<String> fields) {

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 */

    line-height: 1.6;
}

.empty-state-suggestions {
    width: 100%;
    max-width: 500px;
}

.suggestions-label {
    font-size: 0.8125rem;
    color: #6b778c;
    margin-bottom: 0.75rem;
    font-weight: 500;
}

.suggestion-chips {
    display: flex;
    flex-wrap: wrap;
    gap: 0.5rem;
    justify-content: center;
}

.suggestion-chip {
    padding: 0.5rem 1rem;

        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.");

    /** Helper for OpenSearch Description Document (OSDD) functionality. */
    @Resource
    protected OsddHelper osddHelper;

    /** Helper for managing popular search words and suggestions. */
    @Resource
    protected PopularWordHelper popularWordHelper;

    /** Client for RAG chat functionality. */
    @Resource
    protected ChatClient chatClient;

    @Resource
    private ElevateWordService elevateWordService;
    @Resource
    private ElevateWordPager elevateWordPager;
    /** Helper for managing search suggestions and elevate words. */
    @Resource
    protected SuggestHelper suggestHelper;
    @Resource
    private LabelTypeService labelTypeService;

import org.codelibs.fess.suggest.constants.SuggestConstants;
import org.codelibs.fess.suggest.util.SuggestUtil;
import org.opensearch.common.Nullable;

/**
 * The SuggestItem class represents an item used for suggestions in the Fess search engine.
 * It contains various attributes such as text, readings, fields, tags, roles, languages, kinds, and frequencies.