すべてのプロダクト
Search
ドキュメントセンター

OpenSearch:config 句

最終更新日:Jan 13, 2025

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

詳細ソート式でソートされるドキュメント数。

total_rank_size

INT

いいえ

-

-

簡易ソート式でソートされるドキュメント数。

default_operator

STRING

いいえ

'AND' または 'OR'

AND

このクエリで使用されるデフォルトのクエリ演算子。:このパラメーターは、専用インスタンスでのみサポートされています。

使用上の注意

  1. config 句はオプションです。

  2. パラメーターのキーと値のペアはコンマ (,) で区切ります。

  3. 各パラメーターのキーと値はコロン (:) で区切ります。

  4. start パラメーターと hit パラメーターの値の合計が 5,000 を超えないようにしてください。超えるとエラーが発生し、結果は返されません。複数のページで 5,000 を超えるデータエントリを取得する必要がある場合は、スクロール検索を実行してドキュメントを一度にエクスポートし、ページングを実装できます。詳細については、スクロール検索を参照してください。

  5. default_operator パラメーターは、専用インスタンスでのみサポートされています。

  6. total_rank_size パラメーターは、OpenSearch SDK for Java ではconfig.addToCustomConfig("total_rank_size:200000"); の形式で指定します。OpenSearch SDK for PHP では、$params->setCustomConfig('total_rank_size', 200000); の形式で指定します。

  7. コードにパラメーターを追加することで、ドキュメントのソートの詳細を表示できます。

    方法: config 句に format:fulljson パラメーターを追加します。

    戻り結果では、sortExprValues パラメーターはドキュメントのソート情報を示します。

    image

    sortExprValues パラメーターの値は配列で、sort 句のソートフィールドの値です。例:

    sort=-price;-RANK

    この場合、sortExprValues パラメーターの値は [価格、ドキュメントスコア] の形式になります。

    sort 句を設定しない場合、sortExprValues パラメーターの値はデフォルトでドキュメントスコアになります。

  1. config 句を使用してページングを設定します。この例では、戻り結果の各ページに 20 件のドキュメントが表示されます。

    # 最初のページの config 句。
    config=start:0, hit:20, format:xml   
    # 2 番目のページの config 句。
    config=start:20, hit:20, format:xml
  2. 詳細ソート式でソートされるドキュメント数を 1000 に設定します。

    config=start:0, hit:20, rerank_size:1000
  3. 取得されるドキュメントの最大数を 100 に設定します。

    config=start:0, hit:20, total_rank_size:100