Retrieval Configuration

Configuration

Online application configuration

Navigate to Search Algorithm Center > Retrieval Configuration > Basic Configuration and select an application name and an online application. The console then displays the application's current analysis configuration.

Offline application configuration

If an offline application already exists, its configuration page is displayed when you navigate to Search Algorithm Center > Retrieval Configuration > Basic Configuration and select the application name and offline application. In this case, the Offline Change button changes to Configure.

Analysis configuration

Configure the index name, the analyzer for the index, and its fields. For more information, see index schema.

Usage notes

• You can modify the analysis configuration only as an offline change, not directly on an online application.

• An application can have a maximum of two versions: one online and one offline. If an offline version already exists:

  • If you modify configurations, such as the analysis configuration or the application schema, before reindexing, this discards any previously saved offline changes.

  • If reindexing is 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 application and creates a new one.

• Configuring an application schema can be time-consuming. OpenSearch separates the process of saving the application schema from reindexing. This ensures that your configured application schema is saved even if reindexing fails.

Procedure

Note: This section uses the example of creating a custom analyzer and modifying an online application to demonstrate the basic configuration features. You only need to create a custom analyzer if you encounter incorrect analysis results. Otherwise, you can use the default analyzer.

1. From the homepage, navigate to Search Algorithm Center > Retrieval Configuration > Analyzer Management and create a custom analyzer. In the Create Analyzer dialog box, configure the Name, Analyzer Type (such as a system-built-in analyzer or a custom model analyzer), and the Analyzer.

2. Add new 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, enter the Query and Analysis Result, and then click Save. Note: Separate the terms in the analysis result with spaces. For example, to split "beefjerky" into two terms, enter "beef jerky".

3. Return to the Basic Configuration page to 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 Analysis Method, select Custom Analyzer and then choose the analyzer you created.

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

After you finish modifying the index schema, click Next. The New Application dialog box appears. By default, Yes is selected for both options. If you select No:

• The offline application will not receive real-time incremental data (such as updates from API calls or data sources) from the online application while the new version is being built.

• The new version is not automatically published after a full reindex completes. If you do not publish the new version online after a successful build, it is retained indefinitely, bypassing the 8-hour automatic deletion rule for offline versions.

5. After you save the configuration, an offline application with a "Reindexing" status appears.

Note: While an offline application is reindexing, the Offline Change button for the online version is disabled.

6. After reindexing for the offline application is complete, test it to ensure search works as expected. Then, publish it online.

Once the switch is complete, navigate to the Basic Configuration page and select Online Application. You can see that the analysis method for the title index has changed to the custom analyzer test_zw, which confirms that the offline change was successfully published.

Important notes

• Each application in an instance can have a maximum of two versions: one online and one offline. If both versions already exist, any further modification to the application schema overwrites the existing offline application.

• Analyzer modifications take effect only after reindexing.