OpenSearch:検索デモ

環境変数の設定

ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数を設定します。

重要

• Alibaba Cloud アカウントの AccessKey ペアは、すべての API オペレーションへのアクセスに使用できます。API オペレーションの呼び出しや日常の O&M には、Resource Access Management (RAM) ユーザーを使用することを推奨します。RAM ユーザーの使用方法については、RAM ユーザーの作成をご参照ください。

• AccessKey ペアの作成方法については、AccessKey ペアの作成をご参照ください。

• RAM ユーザーの AccessKey ペアを使用する場合は、Alibaba Cloud アカウントを使用して、必要な権限が AliyunServiceRoleForOpenSearch ロールに付与されていることを確認してください。詳細については、AliyunServiceRoleForOpenSearch および アクセス権限ルールをご参照ください。

• プロジェクトコードなど、他者が容易にアクセスできる場所に AccessKey ペアを含めないことを推奨します。含めると、AccessKey ペアが漏洩し、アカウント内のリソースが危険にさらされる可能性があります。

• Linux および macOS

  次のコマンドを実行します。<access_key_id> と <access_key_secret> を、使用する RAM ユーザーの AccessKey ID と AccessKey Secret に置き換えてください。

  export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> 
  export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

• Windows

  1. 環境変数ファイルを作成し、ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数をファイルに追加してから、環境変数を AccessKey ID と AccessKey Secret に設定します。

  2. Windows を再起動して、AccessKey ペアを有効にします。

ドキュメント検索のサンプルコード (SDK V4.0.0)

検索エラーの処理：

例外は、status フィールドではなく、code フィールドと message フィールドの値に基づいて処理してください。エラーコードの詳細については、エラーコードをご参照ください。

サンプルコード：

package com.aliyun.opensearch;
import com.aliyun.opensearch.sdk.dependencies.com.google.common.collect.Lists;
import com.aliyun.opensearch.sdk.dependencies.org.json.JSONObject;
import com.aliyun.opensearch.sdk.generated.OpenSearch;
import com.aliyun.opensearch.sdk.generated.commons.OpenSearchClientException;
import com.aliyun.opensearch.sdk.generated.commons.OpenSearchException;
import com.aliyun.opensearch.sdk.generated.search.*;
import com.aliyun.opensearch.sdk.generated.search.general.SearchResult;
import com.aliyun.opensearch.search.SearchParamsBuilder;
import com.aliyun.opensearch.search.SearchResultDebug;
import java.nio.charset.Charset;
public class testSearch {
    private static String appName = "ご自身の OpenSearch アプリケーション名に置き換えてください";
    private static String host = "ご自身のアプリケーションの API エンドポイントに置き換えてください";
    public static void main(String[] args) {
            // ユーザー ID 情報。
    				// 環境変数から AccessKey ID と AccessKey Secret を読み取ります。このサンプルコードを実行する前に、環境変数を設定する必要があります。
      			String accesskey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
            String secret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
      			
            // ファイルとデフォルトのエンコード形式を表示します。
            System.out.println(String.format("file.encoding: %s", System.getProperty("file.encoding")));
            System.out.println(String.format("defaultCharset: %s", Charset.defaultCharset().name()));
            // OpenSearch オブジェクトを作成して構築します。
            OpenSearch openSearch = new OpenSearch(accesskey, secret, host);
            // OpenSearchClient オブジェクトを作成し、OpenSearch オブジェクトをコンストラクターパラメーターとして使用します。
            OpenSearchClient serviceClient = new OpenSearchClient(openSearch);
            // SearcherClient オブジェクトを作成し、OpenSearchClient オブジェクトをコンストラクターパラメーターとして使用します。
            SearcherClient searcherClient = new SearcherClient(serviceClient);
            // Config オブジェクトを定義して、ページング、データ返却フォーマット、アプリケーション名など、config 句のパラメーターを設定します。
            Config config = new Config(Lists.newArrayList(appName));
            config.setStart(0);
            config.setHits(5);
            // 返却フォーマットを FULLJSON に設定します。サポートされているフォーマットには、XML、JSON、FULLJSON があります。
            config.setSearchFormat(SearchFormat.FULLJSON);
            // 検索結果で返却するフィールドを指定します。
            config.setFetchFields(Lists.newArrayList("id", "name", "phone", "int_arr", "literal_arr", "float_arr", "cate_id"));
            // 注：config 句の rerank_size パラメーターは、Rank クラスオブジェクトで設定されます。
            // kvpairs 句のパラメーターを設定します。この例では、uniq プラグインが distinct 句に追加され、reserved が false に設定されている場合に total と viewtotal の値が不正確になる問題が解決されます。
            //config.setKvpairs("duniqfield:cate_id");
            // パラメーターオブジェクトを作成します。
            SearchParams searchParams = new SearchParams(config);
            // query 句を設定します。複数のインデックスを組み合わせてクエリを実行するには、setQuery でマージします。そうしないと、後続の setQuery 呼び出しによって以前のものが上書きされます。
            searchParams.setQuery("name:'opensearch'");
            // 集約および distinct 句を設定します。
            Distinct dist = new Distinct();
            dist.setKey("cate_id"); // dist_key を設定します。
            dist.setDistCount(1); // dist_count を設定します。
            dist.setDistTimes(1); // dist_times を設定します。
            dist.setReserved(false); // reserved を設定します。
            dist.setUpdateTotalHit(false); // update_total_hit を設定します。
            dist.setDistFilter("cate_id<=3"); // フィルター条件を設定します。
            dist.setGrade("1.2"); // grade を設定します。
            // duniqfield パラメーターは、config 句で kvpairs 句を指定することによって追加されます。
            // Distinct オブジェクトパラメーターを追加します。
            searchParams.addToDistincts(dist);
            // 集約句を設定します。
            Aggregate agg = new Aggregate();
            agg.setGroupKey("cate_id"); // group_key を設定します。
            agg.setAggFun("count()"); // agg_fun を設定します。
            agg.setAggFilter("cate_id=1"); // agg_filter を設定します。
            agg.setRange("0~10"); // セグメント化された統計を設定します。
            agg.setAggSamplerThresHold("5"); // サンプリングのしきい値を設定します。
            agg.setAggSamplerStep("5"); // サンプリングのステップサイズを設定します。
            agg.setMaxGroup("5"); // 返却するグループの最大数を設定します。
            // Aggregate オブジェクトパラメーターを追加します。
            //searchParams.addToAggregates(agg);
            // 複数の集約フィールドを設定する例。
            Set<Aggregate> Aggregates = new HashSet();
            Aggregate aggregate1 = new Aggregate();
            aggregate1.setGroupKey("cate_id");
            aggregate1.setAggFun("count()");
            Aggregates.add(aggregate1);

            Aggregate aggregate2 = new Aggregate();
            aggregate2.setGroupKey("cate_id_1");
            aggregate2.setAggFun("count()");
            Aggregates.add(aggregate2);

            searchParams.setAggregates(Aggregates);
            // biz パラメーターを設定します。
            Map hashMap = new HashMap();
            hashMap.put("biz","type:web");
            searchParams.setCustomParam(hashMap);
            // クエリフィルター条件を設定します。
            // searchParams.setFilter("id > \"0\""); // 次の ParamsBuilder を使用してフィルター条件を追加することもできます。
            // ソート条件を設定します。
            Sort sorter = new Sort();
            sorter.addToSortFields(new SortField("id", Order.DECREASE)); // id フィールドで降順にソートします。
            sorter.addToSortFields(new SortField("RANK", Order.INCREASE)); // ID が同じ場合は、RANK で昇順にソートします。
            // ソートで tag_match を使用する例：(Kvpairs は config 句で設定する必要があります。)
            //sorter.addToSortFields(new SortField("tag_match(\"kk1\",int_array,10,\"max\",\"false\",\"false\")", Order.INCREASE));
            //config.setKvpairs("kk1:10");
 

            // Sort オブジェクトパラメーターを追加します。
            searchParams.setSort(sorter);
            // 粗排と精排の式を設定します。この例では、デフォルト値に設定されています。
            Rank rank = new Rank();
            rank.setFirstRankName("default");
            rank.setSecondRankName("default");
            rank.setReRankSize(5);// 精排のドキュメント数を設定します。
            // Rank オブジェクトパラメーターを追加します。
            searchParams.setRank(rank);
            // 再検索のために re_search パラメーターを設定します。
            // strategy:threshold,params:total_hits#10 => ここで、strategy:threshold はポリシーを示します。現在サポートされているポリシーは 1 つだけです。
            // threshold のパラメーターは total_hits です。これは、最初のリクエストの total_hits がこの値より小さい場合に再検索がトリガーされることを意味します。
            Map<String, String> reSearchParams = new HashMap<String, String>();
            reSearchParams.put("re_search", "strategy:threshold,params:total_hits#10");
            // 関連する検索リクエストの from_request_id を設定します。
            reSearchParams.put("from_request_id", "159851481919726888064081");
            //searchParams.setCustomParam(reSearchParams);
            // 検索結果のサマリーを設定します。この例では、SearchParamsBuilder オブジェクトを使用してサマリーを追加する方が便利です。
            Summary summ = new Summary("name");
            summ.setSummary_field("name");// サマリーが適用されるフィールド。このフィールドは、トークン化できるテキストフィールドである必要があります。
            summ.setSummary_len("50");// スニペットの長さ。
            summ.setSummary_element("em"); // ハイライト用の HTML タグ。
            summ.setSummary_ellipsis("...");// スニペットの省略記号。
            summ.setSummary_snippet("1");// スニペットの数。
            // Summary オブジェクトパラメーターを追加します。
            //searchParams.addToSummaries(summ);
            
            // raw_query パラメーターを追加します。値は検索クエリと同じでなければなりません。
            searchParams.setRawQuery("opensearch");
            // SearchParams のユーティリティクラスで、より便利な操作を提供します。
            SearchParamsBuilder paramsBuilder = SearchParamsBuilder.create(searchParams);
            // SearchParamsBuilder オブジェクトを使用して、検索結果のサマリーを追加します。
            paramsBuilder.addSummary("name", 50, "em", "...", 1);
            // クエリフィルター条件を設定します。
            paramsBuilder.addFilter("id>=0", "AND");

            // disable パラメーターを設定して再検索機能を無効にします：
            //searchParams.putToCustomParam("disable", "re_search");
            try {
                // クエリを実行して結果を返します。code と message に基づいて例外を確認します。エラーコードについては、エラーコードのドキュメントをご参照ください。
                SearchResult searchResult = searcherClient.execute(paramsBuilder);
                String result = searchResult.getResult();
                JSONObject obj = new JSONObject(result);
                // クエリ結果を出力します。
                System.out.println(obj.toString());
                // 一部のユーザーは、リクエスト URL 情報をデバッグする必要がある場合があります。
                SearchResultDebug searchdebugrst = searcherClient.executeDebug(searchParams);
                // 最後のクエリリクエスト文字列の情報を出力します。
                System.out.println(searchdebugrst.getRequestUrl());
            } catch (OpenSearchException e) {
                e.printStackTrace();
            } catch (OpenSearchClientException e) {
                e.printStackTrace();
            }
        }
}