All Products
Search
Document Center

SuggestClient

Last Updated: Sep 09, 2021

Overview

The SuggestClient class is used to implement the drop-down suggestion feature, for example, to obtain drop-down suggestions based on specified keywords and filter conditions.

Constructor

Method definition

void  OpenSearch\Client\SuggestClient::__construct( $openSearchClient)

Parameter description

Parameter

Type

Description

$openSearchClient

\OpenSearch\Client\OpenSearchClient

The OpenSearchClient object. The OpenSearchClient class is a basic class that can be used to calculate signatures, interact with servers, and return the results.


execute

Runs a drop-down suggestion-based query and returns documents based on the specified keywords.

Method definition

\OpenSearch\Generated\Common\OpenSearchResult     OpenSearch\Client\SuggestClient::execute( $searchParams)

Parameter description

Parameter

Type

Description

$searchParams

\OpenSearch\Generated\Search\SearchParams

The query conditions.