All Products
Search

This Product

    OpenSearch:Retrieval Configuration

    Document Center

    OpenSearch:Retrieval Configuration

    Last Updated:Jun 26, 2026

    Basic configuration

    Online application configuration

    Navigate to Search Configuration Center > Retrieval Configuration > Basic Configuration. Select an application, then select the Online Application tab to view its current tokenization configurations. To modify the application schema, click Modify Offline Application in the upper-right corner.

    Offline application configuration

    Navigate to Search Configuration Center > Retrieval Configuration > Basic Configuration. Select an application. On the Offline Application tab, if an offline version of the application exists, the Modify Offline Application button is replaced with Configure.

    Tokenization configuration

    Configure the index name, its analyzer, and its fields. For more information about analyzer types, see Text analyzers.

    Notes

    • You can configure tokenization methods only for an offline application, not directly for an online application.

    • An application within an instance can have only two versions at a time: one online and one offline. If an offline version already exists:

      • If you modify configurations, such as the analyzer settings or the application schema, before reindexing is complete, the previous changes saved to the offline application are discarded.

      • If reindexing is already complete and you make another change that triggers reindexing, such as modifying the application schema or a data source, the system deletes the existing offline version before creating a new one.

    • OpenSearch separates saving the application schema from reindexing. This design ensures that your application schema is retained even if the reindexing process fails.

    Procedure

    Note: This example shows how to modify an online application by using a custom analyzer. You typically only need a custom analyzer to fix specific tokenization errors; default analyzers are sufficient for most scenarios.

    1. Navigate to Search Configuration Center > Retrieval Configuration > Analyzer Management, and create a custom analyzer.

    In the Create Analyzer dialog box that appears, enter a Name for the analyzer and select an Analyzer type, such as General Analyzer.

    2. Add intervention entries to the custom analyzer.

    On the Analyzer Management page, find your 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, fill in the Query and Tokenization result fields, and then click Save. Note: Separate the terms in the tokenization result with spaces. For example, to tokenize "beefjerky" into two terms, enter "beef jerky".

    3. Return to the Basic Configuration page to modify the online application and apply the custom analyzer.

    To configure the index schema, click the Configure button in the upper-right corner to enter editing mode. For Analysis method, select Custom analyzer and choose the analyzer you just created.

    4. Configure incremental data synchronization and automatic deployment for the new version.

    After configuring the index schema, click Next to open the New Version dialog box. By default, both options are enabled. If you disable an option:

    • Do not synchronize real-time incremental data from the online application to the offline application: During the build process for the new version, the system will not synchronize new data pushed via an API or from a data source to the new version.

    • Do not automatically publish after full reindexing is complete: If you select this, the system will not automatically publish the new version online after a successful build. This version is retained and is not subject to the 8-hour automatic deletion rule for offline versions.

    5. After you save the configuration, a new offline application appears with the status Rebuilding Index.

    Note: Because the application has two versions (online and offline) and the offline application is reindexing, the Modify Offline Application button for the online application is disabled.

    6. After the system successfully reindexes the offline application, it becomes the new online application if automatic deployment is enabled.

    You can verify the change on the Basic Configuration page. Select the Online Application tab and confirm that the Analysis method for the title index displays your custom analyzer. The Modify Offline Application button is available again.

    Precautions

    • An application within a single OpenSearch instance can have only two versions at a time: one online and one offline. If an application already has both versions, changing its application schema overwrites the existing offline version.

    • Analyzer changes take effect only after reindexing.