config 句 - OpenSearch - Alibaba Cloud ドキュメントセンター

概要

config 句は、クエリ文のオプション部分です。 config 句を使用してクエリを構成できます。たとえば、開始オフセット、返されるレコード数、クエリ結果のフォーマット、クエリのタイムアウト期間を指定できます。

構文

{
  "config": {
  }
}

config 句はオプションです。 config 句の内容はオブジェクトです。 config 句でサポートされているパラメーターの詳細については、このトピックのパラメーターセクションをご参照ください。

パラメーター

パラメーター	有効な値または型	デフォルト値	説明
start	NUMBER	0	結果セット内でシステムがドキュメントの返却を開始するオフセット値。
hit	NUMBER	10	返却するドキュメントの最大数。
format	json および xml	xml	クエリ結果のフォーマット。
rank_trace	FATAL、ERROR、INFO、DEBUG、WARN、TRACE1、TRACE2、および TRACE3	デフォルト値なし	フロントエンドにおけるドキュメントのスコアリングプロセスに関する出力情報。
default_index	string	""	クエリで使用されるデフォルトのインデックス。デフォルトのインデックスは、クラスタ構成ファイルの query_config 設定項目で指定されたインデックスと同じです。クエリでインデックスを指定した場合、クエリで指定されたインデックスが優先的にデフォルトのインデックスとして使用されます。それ以外の場合、query_config 設定項目で指定されたインデックスが使用されます。
default_operator	AND および OR	""	クエリで使用されるデフォルトの演算子。デフォルトの演算子は、クラスタ構成ファイルの query_config 設定項目で指定された演算子と同じです。クエリで演算子を指定した場合、クエリで指定された演算子が優先的にデフォルトの演算子として使用されます。それ以外の場合、query_config 設定項目で指定された演算子が使用されます。
timeout	NUMBER	0	クエリのタイムアウト期間。単位：ミリ秒。値を負の数にすることはできません。
seek_timeout	NUMBER	0	クエリシークフェーズのタイムアウト期間。単位：ミリ秒。デフォルト値：0。デフォルトでは、指定されたタイムアウト期間に 0.7 を掛けた値がシークタイムアウト期間として使用されます。
no_summary	false または true	false	フェーズ 1 クエリのみを実行するかどうかを指定します。
dedup	no および yes	yes	プライマリキーに基づいて結果から重複を自動的に削除するかどうかを指定します。
searcher_return_hits	NUMBER	0	サーチャーによって返されるレコードの数。値 0 は、start パラメーターと hit パラメーターの値に基づいてレコードが返されることを指定します。 searcher_return_hits パラメーターの値は 5000 を超えることはできません。
actual_hits_limit	NUMBER	0	totalhits パラメーターの値が実際の値か推定値かを指定します。返されたレコードの実際の数が actual_hits_limit パラメーターの値より小さい場合、実際の値が返されます。返されたレコードの実際の数が actual_hits_limit パラメーターの値以上の場合、推定値が返されます。返されたレコードの実際の数が 0 の場合、推定値が返されます。 numeric_limits<uint32_t>::max() 条件が満たされた場合、実際の値が返されます。
sourceid	string	デフォルト値なし	クエリ用にレプリカが選択される基になるソース ID。オンラインインデックスには複数のレプリカを使用できます。 sourceid パラメーターを指定しない場合、クエリごとにレプリカがランダムに選択されます。インデックスがインクリメンタルに更新されると、更新されたデータがすべてのレプリカに同期されない場合があります。その結果、最新のクエリ結果が返されない可能性があります。 sourceid パラメーターの値を指定すると、sourceid パラメーターのハッシュ値に基づいてクエリ用にレプリカが選択されます。この場合、同じ sourceid パラメーター値を使用するユーザーは最新のデータをクエリできます。 sourceid パラメーターの値は STRING 型です。
rerank_hint	BOOL	false	クエリに対して 2 回目のスコアリングプロセスを実行するかどうかを指定します。
rank_size	NUMBER	0	大まかにソートされるドキュメントの数、または動的インデックスに基づいて切り捨てられるドキュメントの数。このパラメーターの値が 0 の場合、構成ファイルの値が使用されます。
rerank_size	NUMBER	0	最初のスコアリングプロセスで細かくソートされるドキュメントの数。このパラメーターの値が 0 の場合、構成ファイルの値が使用されます。
total_rank_size	NUMBER	0	すべてのパーティションで大まかにソートされるドキュメントの合計、または動的インデックスに基づいて切り捨てられるドキュメントの数。このパラメーターの値が 0 の場合、構成ファイルの値が使用されます。
total_rerank_size	NUMBER	0	各パーティションの最初のスコアリングプロセスで細かくソートされるドキュメントの合計。このパラメーターの値が 0 の場合、構成ファイルの値が使用されます。
fetch_summary_type	docid または pk または rawpk	docid	サマリーを取得するために使用されるメソッド。デフォルトでは、サマリーはドキュメント ID に基づいて取得されます。プライマリキーのハッシュ値または元の値に基づいてサマリーを取得するように指定することもできます。プライマリキーのハッシュ値または元の値に基づいてサマリーを取得することをお勧めします。
research_threshold	NUMBER	0	再検索がトリガーされるしきい値。返されたレコードの数がこのパラメーターの値より少ない場合、クエリが再度実行されます。

例

config 句を使用してページングを構成します。この例では、クエリ結果の各ページに 20 個のドキュメントが表示されます。

# 最初のページの config 句。
{
  "config": {
    "start":0,
    "hit":20,
    "format":"xml"
  }
} 
  
# 2 番目のページの config 句。
{
  "config": {
    "start":20,
    "hit":20,
    "format":"xml"
  }
}

高度ソート式でソートされるドキュメントの数を 1000 に設定します。
```
{
  "config": {
    "start":1,
    "hit":20,
    "rerank_size":1000
  }
}
```