All Products
Search

This Product

    OpenSearch:version guide and related downloads

    Document Center

    OpenSearch:version guide and related downloads

    Last Updated:Mar 18, 2026

    This software development kit (SDK) encapsulates OpenSearch API operations for PHP. It lets you manage applications, process data, and perform searches in OpenSearch. New features are added and known bugs are fixed in each iteration. This topic describes the different versions of the PHP SDK.

    PHP SDK versions

    The SDK supports PHP 5.3 and later. For optimal performance, we recommend using PHP 5.4 or later.

    Version guide

    The latest version is 3.4.1, released in May 2021. We recommend that you upgrade to this version.

    V3.4.1 (2021-05-11)

    • Deprecated the V3 management API requests.

    Download

    V3.3.0 (2020-04-21)

    Feature description:

    • Security Token Service (STS) is supported.

    • Added the `Rank.secondRankType` search parameter (EXPRESSION|CAVA_SCRIPT).

    • Added the `userId` and `reSearch` (HOMONYM) parameters for drop-down suggestions.

    • Added the `SuggestParams` and `SuggestionClient` classes.

    Download

    V3.2.1 (2019-09-12)

    Feature description:

    • Added support for Data Collection 2.0.

    • Added support for HTTPS.

    • Fixed an issue with passing parameters for A/B testing.

    Download

    V3.2.0 (2019-08-23)

    • Added support for Data Collection 2.0.

    V3.1.0 (2018-09-03)

    • Added support for A/B testing.

    • Added support for behavioral data collection.

    V3.0.2 (2017-11)

    Features

    • Added support for document search.

    • Added support for drop-down suggestions.

    • Added support for query analysis.

    • Added support for scroll scan.

    • Added support for multi-application queries. Note: In the V3 SDK, separate multiple applications with commas. In the V2 SDK, separate them with semicolons.

    Compatibility

    • Compatible with Standard Edition and Premium Edition applications.

    Bug fixes

    • Fixed an issue where the parameter name for the number of records returned by drop-down suggestions was incorrect.

    • Fixed an issue where the `ReRankSize` parameter could not be set directly.

    V3.0.1 (2017-07)

    Features

    • Added support for document search.

    • Added support for drop-down suggestions.

    • Added support for query analysis.

    • Added support for scroll scan.

    • Added support for multi-application queries. Note: In the V3 SDK, separate multiple applications with commas. In the V2 SDK, separate them with semicolons.

    • Defined `arg` before use to prevent the "Undefined variable: arg" notice when the PHP log level is set to Notice.

    Compatibility

    • Compatible with Standard Edition and Premium Edition applications.

    Enhancements:

    • Added support for the `kvpairs` clause.

    V3.0.0 (2017-05)

    Features

    • You can use the document search feature.

    • Added support for drop-down suggestions.

    • The query and analysis feature is available.

    • Added support for scroll scan.

    • Added support for multi-application queries. Note: In the V3 SDK, separate multiple applications with commas. In the V2 SDK, separate them with semicolons.

    Compatibility

    • Compatible with Standard Edition and Premium Edition applications.

    Download instructions

    We recommend that you upgrade to the latest version of the SDK. Each iteration includes new features and bug fixes.

    Download method: In your browser, right-click the hyperlink below and select Save link as.

    V3.4.1 (2021-05-11)

    • Download link: php_v3.4.1.zip

    • Deprecated the V3 management API requests.

    V3.3.0 (2020-05)

    • Download link: php_v3.3.0.zip

      New features:

    • Added support for STS.

    • Added the `Rank.secondRankType` search parameter (EXPRESSION|CAVA_SCRIPT).

    • Added the `userId` and `reSearch` (HOMONYM) parameters for drop-down suggestions.

    • Added the `SuggestParams` and `SuggestionClient` classes.

    V3.2.1 (2019-09)

    • Download link: php_v3.2.1.zip

      New features:

    • Added support for Data Collection 2.0.

    • Added support for HTTPS.

    V3.1.0 (2018-11)

    New features

    • Added support for A/B testing.

    • Added support for behavioral data collection.

    Fixes

    • Fixed an issue where the `each` function is not supported in later versions of PHP.

    V3.0.2 (2017-11)

    • Download link: php_V3.0.2.zip

      Note

      You must use the V3 SDK to access Standard Edition applications. Using the V2 PHP SDK for this purpose will result in an error. The V3 SDK is compatible with both Premium Edition and Standard Edition applications. The V2 and V3 SDKs are significantly different, and we recommend that you use the V3 SDK.

    Fixes

    • Fixed an issue where the parameter name for the number of records returned by drop-down suggestions was incorrect.

    • Fixed an issue where the `ReRankSize` parameter could not be set directly.

    V3.0.1 (2017-07)

    • Download link: php_V3.0.1.zip

      Note

      You must use the V3 SDK to access Standard Edition applications. Using the V2 PHP SDK for this purpose will result in an error. The V3 SDK is compatible with both Premium Edition and Standard Edition applications. The V2 and V3 SDKs are significantly different, and we recommend that you use the V3 SDK.

    New features

    • Added support for the `kvpairs` clause.

    V3.0.0 (2017-05)

    • Download link: php_V3.0.0.zip

      Note

      This version does not support the `kvpairs` clause. To use the `kvpairs` clause, you must upgrade the PHP SDK to V3.0.1. You must use the V3 SDK to access Standard Edition applications. Using the V2 SDK for this purpose will result in an error. The V3 SDK is compatible with both Premium Edition and Standard Edition applications. The V2 and V3 SDKs are significantly different, and we recommend that you use the V3 SDK.