すべてのプロダクト
Search

このプロダクト

    OpenSearch:SearchParamsBuilder クラス

    ドキュメントセンター

    OpenSearch:SearchParamsBuilder クラス

    最終更新日:Mar 19, 2026

    このトピックでは、OpenSearch PHP ソフトウェア開発キット（SDK）における SearchParamsBuilder クラスの機能について説明します。

    概要

    SearchParamsBuilder クラスは、SearchParams オブジェクト用のパラメーター・オブジェクトを構築するために使用されます。

    コンストラクター

    関数定義

    mixed  OpenSearch\Util\SearchParamsBuilder::__construct($opts)

    パラメーター

    パラメーター

    型

    説明

    $opts

    mixed

    クエリパラメーターを含む内容です。

    結果セットのオフセットを設定

    検索結果で返される最初のドキュメントの序数を指定します。

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setStart(integer $start)

    パラメーター

    パラメーター名

    型

    説明

    $start

    integer

    検索結果からドキュメントの返送を開始する位置を指定します。

    返却件数を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setHits( $hits)

    パラメーター

    パラメーター名

    型

    説明

    $hits

    integer

    返却される結果の件数です。

    結果セットのデータ形式を設定

    応答結果のデータ形式を指定します。サポートされる形式は XML、JSON、FULLJSON です。JSON 形式と比較して、FULLJSON 形式は variableValue などの追加フィールドをサポートします。

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setFormat(String $format)

    パラメーター

    パラメーター名

    型

    説明

    $format

    String

    応答は JSON 形式で返されます。

    検索対象のアプリケーション名または ID を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setAppName($appNames)

    パラメーター

    パラメーター名

    型

    説明

    $appNames

    mixed

    アプリケーション名です。

    検索キーワードを設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setQuery( $query)

    パラメーター

    パラメーター名

    型

    説明

    $query

    String

    検索キーワードです。書式は index_name:'keyword' [ AND | OR ... ] です。

    キーと値のペア（kvpairs）を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setKvPairs( $kvPairs)

    パラメーター

    パラメーター名

    型

    説明

    $kvPairs

    String

    設定するキーと値のペアです。

    結果セットに含めるフィールドを設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setFetchFields(array $fetchFields)

    パラメーター

    パラメーター名

    型

    説明

    $fetchFields

    array

    返却するフィールドのリストです。例： array('a', 'b')。

    グループ検索におけるグループ値を指定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setRouteValue( $routeValue)

    パラメーター

    パラメーター

    型

    説明

    $routeValue

    Mixed

    グループ化に使用するフィールド値です。

    Config 句にカスタムパラメーターを追加

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setCustomConfig(String $key, Mixed $value)

    パラメーター

    パラメーター名

    型

    説明

    $key

    String

    カスタムパラメーター名を設定できます。

    $value

    Mixed

    カスタムパラメーターの値を設定できます。

    フィルター条件を追加

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addFilter( $filter,  $condition)

    パラメーター

    パラメーター名

    型

    説明

    $filter

    String

    フィルター条件です。例： a > 1。

    $condition

    String

    2 つのフィルター条件を接続する論理演算子（例：AND、OR）です。

    フィルター条件を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setFilter($filterString)

    パラメーター

    パラメーター名

    型

    説明

    $filterString

    mixed

    フィルター条件です。

    ソートルールを追加

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addSort( $field, $order)

    パラメーター

    パラメーター名

    型

    説明

    $field

    String

    ドキュメントをソートする基準となるフィールドです。

    $order

    mixed

    SearchParamsBuilder::SORT_INCREASE または SearchParamsBuilder::SORT_DECREASE

    基本ソート式の名前を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setFirstRankName( $firstRankName)

    パラメーター

    パラメーター

    型

    説明

    $firstRankName

    String

    基本ソート式に設定する名前です。

    高度ソート式の名前を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setSecondRankName( $secondRankName)

    パラメーター

    パラメーター名

    型

    説明

    $secondRankName

    String

    高度ソート式に設定する名前です。

    集約構成を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addAggregate( $agg)

    パラメーター

    パラメーター

    型

    説明

    $agg

    array

    指定する集約構成です。

    重複排除構成を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addDistinct( $dist)

    パラメーター

    パラメーター名

    型

    説明

    $dist

    array

    指定する重複排除構成です。

    検索結果のサマリー構成を設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addSummary( $summaryMeta)

    パラメーター

    パラメーター

    型

    説明

    $summaryMeta

    array

    指定するサマリー・フィールド構成です。

    クエリ分析構成を追加

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addQueryProcessor( $qpName)

    パラメーター

    パラメーター名

    型

    説明

    $qpName

    array

    サマリー・フィールド構成を指定します。

    無効化する関数を追加

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::addDisableFunctions( $disabledFunction)

    パラメーター

    パラメーター

    型

    説明

    $disabledFunction

    String

    サマリー・フィールドの指定構成です。

    カスタムパラメーターを設定

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setCustomParam( $key,  $value)

    パラメーター

    パラメーター名

    型

    説明

    $key

    String

    カスタムパラメーターのキーです。

    $value

    String

    カスタムパラメーターの値です。

    スクロール・スキャンの有効期限を設定

    各スクロール・クエリに対するタイムアウト期間を設定します。

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setScrollExpire($expiredTime)

    パラメーター

    パラメーター名

    型

    説明

    $expiredTime

    mixed

    次のスクロール・クエリの TTL（Time-To-Live）です。たとえば、TTL を 3 分間に設定する場合は、値を 3m とします。

    スクロール・スキャンのスクロール ID を設定

    スクロール ID は、前のスキャンによって返されます。

    関数定義

    void  OpenSearch\Util\SearchParamsBuilder::setScrollId(String $scrollId)

    パラメーター

    パラメーター

    型

    説明

    $scrollId

    String

    スクロール ID を設定できます。

    SearchParams オブジェクトを取得

    関数定義

    \OpenSearch\Generated\Search\SearchParams     OpenSearch\Util\SearchParamsBuilder::build()

    • SearchParams オブジェクトを返します。