config 句は、返される最初のドキュメントの位置、返されるドキュメントの数、戻り結果のデータ形式、詳細ソート式でソートされるドキュメントの数などの設定を指定するために使用されます。
構文の説明
パラメーター | タイプ | 必須 | 有効な値 | デフォルト値 | 説明 |
start | int | いいえ | [0, 5000] | 0 | 検索結果で返される最初のドキュメントの序数。 |
hit | int | いいえ | [0, 500] | 10 | 返されるドキュメントの最大数。 |
format | string | いいえ | json | 戻り結果のデータ形式。JSON および fullJSON 形式がサポートされています。JSON 形式と比較して、fullJSON 形式は variableValue や sortExprValues などの追加フィールドをサポートしています。 | |
rerank_size | int | いいえ | [0, 2000] | 200 | 1 つの列に基づいて詳細ソート式でソートされるドキュメントの数。 |
total_rank_size | int | いいえ | - | - | 概略ソート式でソートされるドキュメントの数。 |
total_rerank_size | int | いいえ | [0,10000] | - | 詳細ソート式でソートされるドキュメントの数。 |
default_operator | string | いいえ | 'AND' または 'OR' | AND | このクエリで使用されるデフォルトのクエリ演算子。注:このパラメーターは専用インスタンスでのみサポートされています。 |
使用上の注意
config 句は省略可能です。
パラメーターのキーと値のペアはコンマ (,) で区切ります。
各パラメーターのキーと値はコロン (:) で区切ります。
start パラメーターと hit パラメーターの値の合計が 5,000 を超えないようにしてください。超えた場合はエラーが発生し、結果は返されません。複数のページで 5,000 を超えるデータエントリを取得する必要がある場合は、スクロール検索を実行してドキュメントを一度にエクスポートし、ページングを実装できます。詳細については、スクロール検索を参照してください。
default_operator パラメーターは専用インスタンスでのみサポートされています。
total_rank_size パラメーターは、さまざまな言語の OpenSearch SDK で異なる形式で指定されます。OpenSearch SDK for Java では、このパラメーターを
config.addToCustomConfig("total_rank_size:200000");
の形式で指定します。OpenSearch SDK for PHP では、このパラメーターを$params->setCustomConfig('total_rank_size', 200000);
の形式で指定します。コードにパラメーターを追加することで、ドキュメントのソートの詳細を表示できます。
方法:format:fulljson パラメーターを config 句に追加します。
返された結果では、sortExprValues パラメーターはドキュメントのソート情報を示します。
"sortExprValues": [ "10000.0340123586" ]
sortExprValues パラメーターの値は配列で、sort 句のソートフィールドの値です。例:
sort=-price;-RANK
この場合、sortExprValues パラメーターの値は [価格、ドキュメントスコア] の形式になります。
sort 句を設定しない場合、sortExprValues パラメーターの値はデフォルトでドキュメントスコアになります。
例
ページングを設定します。この例では、各ページに 20 個のドキュメントが返されます。
# 最初のページの config 句。 config=start:0, hit:20, format:xml # 2 番目のページの config 句。 config=start:20, hit:20, format:xml
詳細ソート式でソートされるドキュメントの数を 1000 に設定します。
config=start:0, hit:20, rerank_size:1000
取得されるドキュメントの最大数を 100 に設定します。
config=start:0, hit:20, total_rank_size:100