/**
 * Helper class for handling search operations in Fess.
 *
 * This class provides comprehensive search functionality including document search,
 * scroll search, and bulk operations. It handles search request parameter processing,
 * query building, response formatting, and search log management.
 *
 * Key features:
 * - Document search with pagination and faceting
 * - Scroll search for large result sets

        });
    }

    /**
     * Performs a search for failure URLs based on the provided criteria.
     *
     * @param form the search form containing filter criteria
     * @return HTML response for the failure URL list page with search results
     */
    @Execute
    @Secured({ ROLE, ROLE + VIEW })
    public HtmlResponse search(final SearchForm form) {

import org.opensearch.search.aggregations.bucket.sampler.SamplerAggregationBuilder;
import org.opensearch.search.aggregations.bucket.terms.SignificantTermsAggregationBuilder;
import org.opensearch.search.aggregations.bucket.terms.TermsAggregationBuilder;
import org.opensearch.search.aggregations.metrics.AvgAggregationBuilder;
import org.opensearch.search.aggregations.metrics.CardinalityAggregationBuilder;

    protected boolean partialResults;

    /** The actual search query executed against the search engine. */
    protected String searchQuery;

    /** Time taken to execute the search query in milliseconds. */
    protected long queryTime;

    /** Timestamp when the search request was made. */
    protected long requestedTime;

    /** Unique identifier for this search query session. */
    protected String queryId;

    /**

/**
 * Form for uploading search request files to the Fess search engine.
 * This form is used in the admin interface to upload search request configuration files
 * that define search behaviors and request handling.
 */
public class UploadForm {

    /**
     * The multipart file containing the search request configurations to be uploaded.
     * This file should contain search request definitions and configurations.
     */

import org.opensearch.action.search.GetAllPitNodesResponse;
import org.opensearch.action.search.MultiSearchRequest;
import org.opensearch.action.search.MultiSearchRequestBuilder;
import org.opensearch.action.search.MultiSearchResponse;
import org.opensearch.action.search.SearchRequest;
import org.opensearch.action.search.SearchRequestBuilder;
import org.opensearch.action.search.SearchResponse;
import org.opensearch.action.search.SearchScrollRequest;

import org.opensearch.search.aggregations.bucket.terms.TermsAggregationBuilder;
import org.opensearch.search.aggregations.metrics.AvgAggregationBuilder;
import org.opensearch.search.aggregations.metrics.CardinalityAggregationBuilder;
import org.opensearch.search.aggregations.metrics.ExtendedStatsAggregationBuilder;
import org.opensearch.search.aggregations.metrics.MaxAggregationBuilder;

import org.codelibs.fess.util.ComponentUtil;

/**
 * Base class for search request body objects in admin API.
 * Provides common pagination parameters for search operations.
 */
public class BaseSearchBody {

    /** The page size for search results. */
    public Integer size = ComponentUtil.getFessConfig().getPagingPageSizeAsInteger();

    /** The page number for search results. */
    public Integer page = Constants.DEFAULT_ADMIN_PAGE_NUMBER;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.lucene.search.TotalHits.Relation;
import org.codelibs.fess.util.FacetResponse;

/**
 * Represents the result of a search operation in the rank fusion system.
 *
 * This class encapsulates all the information returned from a search query,
 * including the list of matching documents, total record count, query execution

tags:
  - name: search
    description: Search operations
  - name: popularword
    description: Popular word operations
  - name: monitor
    description: Monitoring operations
  - name: suggest
    description: Suggest operations
  - name: favorite
    description: Favorite operations
paths:
  /documents:
    get:
      tags:
        - search
      summary: Finds documents by query