All Products
Search
Document Center

OpenSearch:Retrieval configuration

Last Updated:Oct 26, 2026

Configuration overview

[Online application configuration]

On the homepage, go to [Search Algorithm Center - Retrieval Configuration - Basic Configuration] and select an application name and "Online Application". The list of analysis configurations that the application currently uses is displayed. For an online application, you can click the "Offline Change" button in the upper-right corner to modify the application schema.

[Offline application configuration]

On the homepage, go to [Search Algorithm Center - Retrieval Configuration - Basic Configuration] and select an application name and "Offline Application". If an offline application already exists, its configuration page is displayed. Because the application already has an offline application, the "Offline Change" button changes to "Configure".

Analysis configuration

Configure the index name, the analyzer of the index, and the fields that the index contains. For more information, see Index schema.

Tips

  • The analysis method cannot be configured online. It can be modified only through an offline change.

  • An application can have only two versions (online and offline). If an offline version already exists:

    • If the index has not been rebuilt, modifying the configuration (such as the analyzer configuration or the application schema) clears the changes previously saved in the offline application.

    • If the index has been rebuilt, changing the application schema or data source again (any operation that may trigger index rebuilding) first deletes the non-online version and then creates a new version.

  • Because configuring the application schema may take a long time, OpenSearch separates saving the application schema from rebuilding the index. Even if index building fails, the application schema that you configured is retained.

Procedure

Note: To fully demonstrate the basic configuration, this example uses a custom analyzer and modifies an online application. A custom analyzer is not required. You need one only when bad cases occur in text analysis. Otherwise, use the default analyzer.

1. On the homepage, go to Search Algorithm Center - Retrieval Configuration - Analyzer Management and create a custom analyzer. In the Create Analyzer dialog box that appears, configure the Name, Analyzer Type (built-in analyzer or custom model analyzer), and Analyzer parameters.

2. Add entries to the custom analyzer

On the Analyzer Management page, find the target analyzer and click Entry Management in the Actions column. On the entry management page, click Add. In the Add Intervention Entry panel that appears on the right, enter the Query and the Analysis Result, and then click Save. Note: Separate the terms in the analysis result with spaces. Example: beefjerky => beef jerky.

3. Return to Basic Configuration, modify the online application, and add the custom analyzer

Configure the index schema: Click the Configure button in the upper-right corner to enter edit mode. For the analysis method, select Custom Analyzer and then select the analyzer that you just created.

4. Incremental synchronization to the new version and automatic switchover to online:

After you modify the index schema, click "Next". The New Version dialog box appears. "Required" is selected for all options by default. If you select "Not Required":

  • Real-time incremental data of the online application does not need to be synchronized to the offline application: Data added while the new version is being built (through API synchronization or data source additions) is not synchronized to the new version.

  • Automatic publishing is not required after the full index of the offline change is built: If the new version is not published online after it is built, the version is retained permanently and is not subject to the rule that offline versions are automatically deleted after 8 hours.

5. After you save the configuration, an offline application in the "Reindexing" state is added to the application:

Note: Because the application now has two versions and the offline version is in the "Reindexing" state, the "Offline Change" button of the online application is grayed out.

6. After the index of the offline application is rebuilt and searches succeed, switch it to the online version:

After the switchover succeeds, select Online Application on the Basic Configuration page. The analysis method of the title index has changed to the custom analyzer test_zw, which indicates that the offline change has been published online.

Precautions

  • Only two applications can exist under the same instance. If two applications (online and offline) already exist, any further change to the application schema overwrites the existing offline application.

  • After you modify an analyzer, the change takes effect only after the index is rebuilt.