Kibana に Elasticsearch クエリルール UI を導入

Elasticsearchは初めてですか？Elasticsearchを使い始めるウェビナーに参加しましょう。無料のクラウドトライアルを始めるか、今すぐマシンでElasticを試すこともできます。

検索エンジンの役割は、関連性のある結果を返すことです。ただし、セールの強調、季節商品の優先、スポンサー商品の展示など、それ以上のビジネスニーズがあり、開発者は検索クエリでこれを常に実行できるとは限りません。

さらに、これらのユースケースは通常、時間に敏感であり、一般的な開発段階 (コードブランチを作成してから新しいリリースを待つ) を実行するのは時間のかかるプロセスです。

では、このプロセス全体を API 呼び出しだけで、あるいは Kibana で数回クリックするだけで実行できたらどうなるでしょうか?

クエリルールUI

Elasticsearch 8.10 では、クエリルールとルールリトリーバーが導入されました。これらは、ルールに基づいてオーガニック検索結果のランキングに影響を与えずに、ピン留めされた結果をクエリに挿入するように設計されたツールです。宣言的かつシンプルな方法で、結果の上にビジネスロジックを追加するだけです。

クエリルールの一般的な使用例は次のとおりです。

プロモーション対象商品やセール品の強調表示: セール中の商品やスポンサー商品を上部に表示します。
コンテキストまたは地理位置情報による除外: 地域の規制により表示が許可されていない場合は、特定のアイテムを非表示にします。
主要な結果を優先する: オーガニックランキングに関係なく、人気のある検索や固定検索が常に上位に表示されるようにします。

インターフェースにアクセスしてこれらのツールを操作するには、Kibana サイドメニューをクリックし、関連性の下にあるクエリルールに移動する必要があります。

クエリルールメニューが表示されたら、最初のルールセットの作成をクリックします。

次に、ルールセットに名前を付ける必要があります。

各ルールを定義するフォームには、次の 3 つの主要コンポーネントがあります。

基準: ルールを適用するために満たす必要がある条件。たとえば、「query_string フィールドに値Christmasが含まれている場合」や「country フィールドにCO の場合」などです。
アクション: これは、条件が満たされたときに発生する動作です。ピン留め（ドキュメントを上位の結果に固定する）したり、除外（ドキュメントを非表示にする）したりできます。
メタデータ: これらはクエリの実行時にクエリに付随するフィールドです。これらには、ユーザーの情報 (場所や言語など) や検索データ (query_string) を含めることができます。これらは、ルールを適用するかどうかを決定するための基準で使用される値です。

例: 人気商品

さまざまな商品を扱う電子商取引サイトがあると想像してみましょう。指標をチェックすると、コンソールカテゴリで最も売れているアイテムの 1 つが「DualShock 4 ワイヤレスコントローラー」であることがわかります。特に、ユーザーが「PS4」または「PlayStation 4」というキーワードを検索した場合に多く見られます。そこで、ユーザーがこれらのキーワードを検索するたびに、この製品を結果の最上位に表示することにしました。

まず、Bulk API リクエストを使用して各アイテムのドキュメントをインデックス化します。

クエリに介入しない場合、アイテムは通常 4 番目の場所に表示されます。クエリは次のとおりです。

そして結果はこちらです

これを変更するためのクエリルールを作成しましょう。まず、次のようにルールセットに追加しましょう。

または同等のAPI リクエスト:

クエリでルールセットを使用するには、クエリルールタイプを使用する必要があります。この種のクエリは、主に次の 2 つの部分で構成されます。

match_criteria : ユーザーのクエリと比較するために使用されるメタデータです。この例では、query_string フィールドの値が「PlayStation 4」の場合にルールセットがアクティブになります。
query : 検索してオーガニック検索結果を取得するために使用される実際のクエリ。

この方法では、最初にオーガニッククエリを実行し、次に Elasticsearch がルールセットのルールを適用します。

例: ユーザーベースのメタデータ

クエリルールのもう 1 つの興味深い応用は、メタデータを使用して、ユーザーまたは Web ページからのコンテキスト情報に基づいて特定のドキュメントを表示することです。

たとえば、数値として表されるユーザーのロイヤルティレベルに基づいて、アイテムやカスタマイズされたセールを強調表示したいとします。

これを実現するには、このメタデータをクエリに直接取り込んで、その値が特定の基準を満たしたときにルールがアクティブになるようにします。

まず、ロイヤルティレベルの高いユーザーだけが閲覧できるドキュメントをインデックスします。

ここで、同じルールセット内に新しいルールを作成し、loyalty_level が 80 以上の場合にアイテムが結果の上部に表示されるようにします。

ルールとルールセットを保存します。

同等の REST リクエストは次のとおりです。

ここで、クエリを実行するときに、メタデータに新しいパラメータroyality_levelを含める必要があります。ルールの条件が満たされると、新しいドキュメントが結果の上部に表示されます。

たとえば、loyalty_level が 80 のクエリを送信する場合:

結果の上部にロイヤルティドキュメントが表示されます。

以下の場合、ロイヤルティレベルが 70 であるため、ルールは満たされず、アイテムは上部に表示されません。

結果は次のとおりです。

例: 即時除外

DualShock 4 ワイヤレスコントローラー (ID 2)が一時的に入手できず、販売できないとします。そのため、ビジネスチームは、ドキュメントを手動で削除したり、何らかのデータ処理が開始されるのを待ったりする代わりに、当面は検索結果からドキュメントを削除することにしました。

先ほど人気アイテムに適用したのと同様のプロセスを使用しますが、今回は[Pinned]ではなく[Exclude]を選択します。このルールは一種のブラックリストとして機能します。クエリが実行されるたびに除外が機能するように、条件を「常時」に変更します。

ルールは次のようになります。

変更を適用するには、ルールとルールセットを保存します。同等の REST リクエストは次のとおりです。

ここで、クエリを再度実行すると、以前のルールではアイテムをピン留めするはずだったにもかかわらず、アイテムが結果に表示されなくなっていることがわかります。これは、除外がピン留め結果よりも優先されるためです。

まとめ

クエリルールを使用すると、コードを変更することなく関連性を簡単に調整できます。新しいKibana UIでは、これらの変更を数秒で行うことができるため、お客様とビジネスチームは検索結果をより細かく制御できるようになります。

クエリルールは、電子商取引以外にも、サポートポータルでトラブルシューティングガイドを強調表示したり、ナレッジベースで重要な社内ドキュメントを表示したり、ニュースサイトで最新ニュースを宣伝したり、期限切れの求人やコンテンツの一覧を除外したりするなど、さまざまなシナリオで活用できます。ユーザーの役割や地域によって制限されたコンテンツを非表示にするなど、コンプライアンスルールを適用することもできます。

問題を報告する