/**
     * Returns the list of suggested words.
     * @return The list of words.
     */
    public List<String> getWords() {
        return words;
    }

    /**
     * Returns the number of suggested words.
     * @return The number of words.
     */
    public int getNum() {
        return num;
    }

    /**
     * Returns the total number of hits.
     * @return The total number of hits.
     */

                final String[] words = SuggestUtil.parseQuery(queryString, field);
                if (words.length == 0) {
                    continue;
                }

                final String[][] readings = new String[words.length][];
                for (int j = 0; j < words.length; j++) {
                    words[j] = normalizer.normalize(words[j], field, "");

     * @param words the list of popular words
     * @param total the total number of words
     * @param items the list of suggested items
     */
    public PopularWordsResponse(final String index, final long tookMs, final List<String> words, final long total,
            final List<SuggestItem> items) {
        this.index = index;
        this.tookMs = tookMs;
        this.words = words;
        num = words.size();

 *   <li>{@code ELEVATE_WORD_TAGS} - The key for elevate word tags.</li>
 *   <li>{@code ELEVATE_WORD_ROLES} - The key for elevate word roles.</li>
 * </ul>
 *
 * <p>Methods:</p>
 * <ul>
 *   <li>{@code get()} - Retrieves an array of elevate words from the settings.</li>
 *   <li>{@code add(ElevateWord elevateWord)} - Adds a new elevate word to the settings.</li>

import org.opensearch.transport.client.Client;

/**
 * Represents a request for popular words. This class extends {@link Request} and is parameterized
 * with {@link PopularWordsResponse}. It allows specifying various criteria for retrieving popular words,
 * such as index, size, tags, roles, fields, languages, and exclusion words.
 *
 * <p>Key functionalities include:</p>
 * <ul>
 *   <li>Setting the target index for the search.</li>

/**
 * The BadWordSettings class manages the settings related to bad words.
 * It allows adding, deleting, and retrieving bad words from the settings.
 * It also supports loading default bad words from a file.
 */
public class BadWordSettings {
    private static final Logger logger = LogManager.getLogger(BadWordSettings.class);

    /** Key for bad word settings. */
    public static final String BAD_WORD_SETTINGD_KEY = "badword";

public interface ContentsParser {
    /**
     * Parses the given search words and creates a SuggestItem.
     *
     * @param words the array of search words
     * @param readings the array of readings corresponding to the search words
     * @param fields the array of fields associated with the search words
     * @param tags the array of tags associated with the search words
     * @param roles the array of roles associated with the search words

    }

    /**
     * Returns the total number of words in the suggestion index.
     * @return The total number of words.
     */
    public long getAllWordsNum() {
        return getNum(QueryBuilders.matchAllQuery());
    }

    /**
     * Returns the number of document words in the suggestion index.
     * @return The number of document words.
     */
    public long getDocumentWordsNum() {

     * @param fieldName The field name.
     * @param words The words to filter by.
     * @return The QueryBuilder instance.
     */
    protected QueryBuilder buildFilterQuery(final String fieldName, final List<String> words) {
        final BoolQueryBuilder boolQueryBuilder = QueryBuilders.boolQuery().minimumShouldMatch(1);
        words.stream().forEach(word -> boolQueryBuilder.should(QueryBuilders.termQuery(fieldName, word)));

suggester.indexer().indexFromQueryLog(queryLog);
```

### Popular Words Analytics

```java
import org.codelibs.fess.suggest.request.popularwords.PopularWordsResponse;

PopularWordsResponse popularWords = suggester.popularWords()
    .setSize(20)                    // top 20 words
    .setQuery("tech*")              // filter pattern
    .execute()
    .getResponse();