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

import org.opensearch.action.bulk.BulkResponse;
import org.opensearch.action.search.SearchResponse;
import org.opensearch.index.query.QueryBuilder;
import org.opensearch.index.query.QueryBuilders;

/**
 * Helper class for indexing operations in the Fess search engine.
 * This class provides functionality for sending documents to the search engine,
 * managing document lifecycle operations (create, update, delete), and handling

    /** Search/filter parameter for data configuration availability status. */
    public String available;

    /** Search/filter parameter for data configuration sort order. */
    public String sortOrder;

    /** Search/filter parameter for data configuration creator. */
    public String createdBy;

    /** Search/filter parameter for data configuration creation time. */
    public String createdTime;

            public long updateByQuery(String index,
                    java.util.function.Function<org.opensearch.action.search.SearchRequestBuilder, org.opensearch.action.search.SearchRequestBuilder> builder,
                    java.util.function.BiFunction<org.opensearch.action.update.UpdateRequestBuilder, org.opensearch.search.SearchHit, org.opensearch.action.update.UpdateRequestBuilder> processor) {
                // Return a fixed count for testing

     */
    @Test
    public void testPrefix() throws Exception {
        final CopyOptions option = new CopyOptions();
        assertThat(option.prefix(BeanNames.search_()), is(sameInstance(option)));
        assertThat(option.prefix, is("search_"));
    }

    /**
     * @throws Exception
     */
    @Test
    public void testBeanDelimiter() throws Exception {
        final CopyOptions option = new CopyOptions();

    }

    /**
     * Creates a search intent result with a Fess query.
     *
     * @param query the Fess query string
     * @param reasoning the detection reasoning
     * @return the search intent result
     */
    public static IntentDetectionResult search(final String query, final String reasoning) {
        return new IntentDetectionResult(ChatIntent.SEARCH, query, null, reasoning);
    }

    /**

/**
 * Form class for handling error page data and search parameters.
 * This form captures the state of a search request when an error occurs,
 * allowing the error page to display relevant information and preserve search context.
 */
public class ErrorForm {

    /** Map of form fields and their validation error messages */
    public Map<String, String[]> fields = new HashMap<>();

    /** Search query parameter that caused the error */

labels.profile.placeholder_new_password=New Password
labels.profile.placeholder_confirm_new_password=Confirm New Password
labels.top.search=Search
labels.index_title=Fess
labels.index_form_search_btn=Search
labels.index_osdd_title=Search
labels.index_form_option_btn=Options
labels.index_help=Help
labels.search_options=Search Options
labels.search_options_close=Close
labels.search_options_clear=Clear

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