A powerful Java library that provides intelligent search suggestion functionality built on top of OpenSearch/Elasticsearch. It offers auto-completion, query suggestions, and popular word analytics for search applications.

## Key Features

- **Smart Query Suggestions**: Real-time auto-completion and search suggestions
- **Multi-language Support**: Built-in support for Japanese text processing with Kuromoji analyzer

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

    /**
     * The CRUD mode for form processing (create, update, delete operations).
     */
    @ValidateTypeFailure
    public Integer crudMode;

    /**
     * The bad word to be filtered from search suggestions.
     */
    @Required
    @Pattern(regexp = "[^\\s]+")
    public String suggestWord;

    /**
     * The username of the user who created this bad word entry.
     */
    @Size(max = 1000)

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.

/**
 * Provides supporting data for performance notes in the documentation of {@link
 * Ordering#sortedCopy} and {@link Ordering#immutableSortedCopy}, as well as for automated code
 * suggestions.
 *
 */
@NullUnmarked
public class SortedCopyBenchmark {
  @Param({"1", "10", "1000", "1000000"})
  int size; // logarithmic triangular

  @Param boolean mutable;

  @Param InputOrder inputOrder;

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