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>

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.

    /** Service for managing elevate word configurations */
    @Resource
    private ElevateWordService elevateWordService;

    /** Helper for managing search suggestions and elevate words */
    @Resource
    protected SuggestHelper suggestHelper;

    // GET /api/admin/elevateword
    // PUT /api/admin/elevateword
    /**
     * Returns list of elevate word settings.

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

        super();
    }

    private static final Logger logger = LogManager.getLogger(ApiAdminBadwordAction.class);

    @Resource
    private BadWordService badWordService;

    /** Helper for managing search suggestions and bad words */
    @Resource
    protected SuggestHelper suggestHelper;

    /**
     * Retrieves bad word settings with pagination support.
     *

        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;

    /** The HTTP servlet request object for the current request. */
    @Resource
    protected HttpServletRequest request;

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