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

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

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

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

import org.opensearch.search.sort.SortOrder;
import org.opensearch.transport.client.Client;

/**
 * SuggestRequest is a class that handles the request for suggestions.
 * It extends the Request class with a SuggestResponse type.
 *
 * <p>This class provides various methods to set parameters for the suggestion request,
 * such as index, query, size, tags, roles, fields, kinds, languages, and other configurations.

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

        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;