アルゴリズムモジュールパラメーターの使用方法 - OpenSearch

OpenSearch のアルゴリズム機能を検索リクエストで使用するには、必要なカスタムパラメーターを SDK for Java 経由で渡します。このページでは、各アルゴリズムモジュールのパラメーターを一覧表示し、コードでの設定方法を示します。

すべてのコード例は擬似コードです。

クエリ分析

クエリ分析はテキストのベクトル化と固有表現抽出 (NER) を実現します。

パラメーター	必須	説明
`raw_query`	はい	元の検索クエリ文字列。テキストベクトル化モデルおよび NERモデルで使用されます。

...
// SearchParams オブジェクトを作成します。
SearchParams searchParams = new SearchParams(config);
searchParams.setQuery("default:'OpenSearch'");

// raw_query パラメーターを設定します。
Map<String, String> customParam = new HashMap<>();
customParam.put("raw_query", "OpenSearch");
searchParams.setCustomParam(customParam);

// クエリを実行し、結果を SearchResult オブジェクトとして返します。
SearchResult execute = searcherClient.execute(searchParams);
...

カテゴリ予測

カテゴリ予測は、raw_query を使用して、カテゴリ予測モデルなどのアルゴリズムモデルをトレーニングします。

パラメーター	必須	説明
`raw_query`	はい	元の検索クエリ文字列。カテゴリ予測モデルをトレーニングするために使用されます。

...
// SearchParams オブジェクトを作成します。
SearchParams searchParams = new SearchParams(config);
searchParams.setQuery("default:'Apple'");

// raw_query パラメーターを設定します。
Map<String, String> customParam = new HashMap<>();
customParam.put("raw_query", "Apple");
searchParams.setCustomParam(customParam);

// クエリを実行し、結果を SearchResult オブジェクトとして返します。
SearchResult execute = searcherClient.execute(searchParams);
...

検索候補

3つのパラメーターが検索候補の動作を制御します。有効にしたい機能に応じて、これらを組み合わせて渡します。

パラメーター	必須	説明
`raw_query`	はい	元の検索クエリ文字列。検索候補で高頻度クエリを有効にします。
`from_request_id`	いいえ	前の検索からのリクエスト ID。検索候補のランキングモデルを最適化し、検索候補ガイド付き検索メトリックのトラッキングを有効にします。
`user_id`	いいえ	ユーザー識別子。`raw_query` および `from_request_id` と一緒に渡すと、インテリジェントソートを有効にできます。検索候補リクエスト (`SuggestParams` 経由) で渡すと、検索履歴を有効にできます。

インテリジェントソート — 検索リクエストで raw_query、user_id、および from_request_id を渡します。

...
// SearchParams オブジェクトを作成します。
SearchParams searchParams = new SearchParams(config);
searchParams.setQuery("default:'Apple'");

// raw_query、user_id、および from_request_id を設定して、インテリジェントソート を有効にします。
Map<String, String> customParam = new HashMap<>();
customParam.put("raw_query", "Apple");
customParam.put("user_id", "12345");
customParam.put("from_request_id", "159851481919726888064081");
searchParams.setCustomParam(customParam);

// クエリを実行し、結果を SearchResult オブジェクトとして返します。
SearchResult execute = searcherClient.execute(searchParams);
...

検索履歴 — 検索リクエストで raw_query を渡し、検索候補リクエストで user_id を渡します。

...
// SearchParams オブジェクトを作成します。
SearchParams searchParams = new SearchParams(config);
searchParams.setQuery("default:'Apple'");

// 検索リクエスト で raw_query を設定します。
Map<String, String> customParam = new HashMap<>();
customParam.put("raw_query", "Apple");
searchParams.setCustomParam(customParam);

// クエリを実行し、結果を SearchResult オブジェクトとして返します。
SearchResult execute = searcherClient.execute(searchParams);
...

// 検索候補リクエスト で user_id を設定して、検索履歴 を有効にします。
SuggestParams suggestParams = new SuggestParams();
suggestParams.setUserId("12345");

トレンドとヒントワード

トレンドとヒントワードは、raw_query を使用して、トレンドモデルおよびヒントワードモデルなどのアルゴリズムモデルをトレーニングします。from_request_id および user_id を渡して、ランキングを改善し、ガイダンスメトリックを収集します。

パラメーター	必須	説明
`raw_query`	はい	元の検索クエリ文字列。トレンドモデルおよびヒントワードモデルをトレーニングするために使用されます。
`from_request_id`	いいえ	前の検索からのリクエスト ID。トレンドとヒントワードのランキングを改善し、ホット検索およびヒントワードガイド付き検索メトリックのトラッキングを有効にします。
`user_id`	いいえ	ユーザー識別子。`from_request_id` と一緒に渡すと、ホット検索およびヒントワードガイド付き検索メトリックのトラッキングを有効にできます。

...
// SearchParams オブジェクトを作成します。
SearchParams searchParams = new SearchParams(config);
searchParams.setQuery("default:'Apple'");

// raw_query、user_id、および from_request_id を設定します。
Map<String, String> customParam = new HashMap<>();
customParam.put("raw_query", "Apple");
customParam.put("user_id", "12345");
customParam.put("from_request_id", "160851481919726888064913");
searchParams.setCustomParam(customParam);

// クエリを実行し、結果を SearchResult オブジェクトとして返します。
SearchResult execute = searcherClient.execute(searchParams);
...

Cavaベースのプラグイン

Cavaベースのプラグインは、Cavaスクリプトを使用してカスタムの第2フェーズランキングポリシーを適用します。Rank オブジェクトに、スクリプト名とソートタイプの2つの値を設定します。

パラメーター	必須	説明
Cavaスクリプト名	はい	第2フェーズランキングのために呼び出す Cavaスクリプトの名前。`setSecondRankName` 経由で設定します。
ソートタイプ	はい	ランキング方法。`RankType.CAVA_SCRIPT` に設定して、Cavaスクリプトベースのランキングを使用します。`setSecondRankType` 経由で設定します。

...
// SearchParams オブジェクトを作成します。
SearchParams searchParams = new SearchParams(config);
...

// Rank オブジェクトを作成し、Cavaスクリプトベースのランキング を設定します。
Rank rank = new Rank();
rank.setSecondRankName("test_cava");
rank.setSecondRankType(RankType.CAVA_SCRIPT);

// ランキングポリシー を検索リクエスト に適用します。
searchParams.setRank(rank);