config 句は、検索結果のページネーション、レスポンスフォーマット、およびランキングの範囲を制御します。
パラメーター
| パラメーター | 型 | 必須 | 有効値 | デフォルト | 説明 |
|---|---|---|---|---|---|
start | INT | いいえ | [0, 5000] | 0 | 返す最初のドキュメントのオフセット。 |
hit | INT | いいえ | [0, 500] | 10 | 結果セットあたりの最大ドキュメント数。 |
format | STRING | いいえ | JSON、fullJSON | JSON | レスポンスフォーマット。 fullJSON には、 variableValue と sortExprValues という 2 つの追加フィールドが含まれます。 |
rerank_size | INT | いいえ | [0, 2000] | 200 | 高度ソート式に渡されるドキュメント数。 |
total_rank_size | INT | いいえ | — | — | 基本ソート式に渡されるドキュメント数。 |
default_operator | STRING | いいえ | AND、OR | AND | デフォルトのクエリ演算子。独占型インスタンスでのみサポートされます。 |
注意事項
config 句はオプションです。
キーと値のペアは、カンマ (
,) で区切ります。各キーと値は、コロン (:) で区切ります。startとhitの合計は 5,000 を超えてはなりません。この制限を超えるクエリは、結果を返さずにエラーを返します。深い結果ウィンドウの取得では、先行するすべてのドキュメントをメモリにロードする必要があり、リソース使用量が大幅に増加するため、この制限が設けられています。5,000 件を超えるドキュメントをページネーションするには、代わりに スクロール検索 を使用してください。default_operatorは専用インスタンスでのみサポートされています。total_rank_sizeは、お使いの SDK によって構文が異なります:Java SDK:
config.addToCustomConfig("total_rank_size:200000");PHP SDK:
$params->setCustomConfig('total_rank_size', 200000);
レスポンスにソートの詳細を含めるには、config 句に
format:fullJSONを追加してください。レスポンス内のsortExprValuesフィールドは、ソート句に対応するソートフィールド値の配列です。たとえば、sort=-price;-RANKの場合、sortExprValuesは[price, ドキュメントスコア]を返します。ソート句が設定されていない場合、sortExprValuesはデフォルトでドキュメントスコアを返します。
レスポンスフォーマット:JSON と fullJSON の比較
| フィールド | JSON | fullJSON |
|---|---|---|
| 標準の結果フィールド | はい | はい |
variableValue | — | はい |
sortExprValues | — | はい |
ドキュメントごとのソートスコアや変数式の値を検査する必要がある場合 (ランキングの動作をデバッグする場合など) は、 fullJSON を使用してください。
例
結果のページネーション — 1 ページあたり 20 ドキュメント
# 1ページ目
config=start:0, hit:20, format:xml
# 2ページ目
config=start:20, hit:20, format:xmlこのページネーションの例では、ソースドキュメントはformat:xmlを使用しています。しかし、パラメーターテーブルには、サポートされているフォーマット値としてJSONとfullJSONのみが記載されています。この不整合は元のソースに存在し、製品チームによるレビューのためにフラグが立てられています。
高度ソートの候補プールを 1,000 ドキュメントに設定
config=start:0, hit:20, rerank_size:1000基本ソートを 100 ドキュメントに制限
config=start:0, hit:20, total_rank_size:100次のステップ
スクロール検索 — 複数のページにまたがって 5,000 件を超えるドキュメントを取得