Reference documentation and code samples for the Google Cloud Retail V2 Client class SearchResponse.
Response message for SearchService.Search method.
Generated from protobuf message google.cloud.retail.v2.SearchResponse
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ results
array< Google\Cloud\Retail\V2\SearchResponse\SearchResult
>
A list of matched items. The order represents the ranking.
↳ facets
↳ total_size
int
The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
↳ corrected_query
string
Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
↳ attribution_token
string
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
↳ next_page_token
string
A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
↳ query_expansion_info
Google\Cloud\Retail\V2\SearchResponse\QueryExpansionInfo
Query expansion information for the returned results.
↳ redirect_uri
string
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
↳ applied_controls
↳ invalid_condition_boost_specs
array< Google\Cloud\Retail\V2\SearchRequest\BoostSpec\ConditionBoostSpec
>
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
getResults
A list of matched items. The order represents the ranking.
setResults
A list of matched items. The order represents the ranking.
$this
getFacets
Results of facets requested by user.
setFacets
Results of facets requested by user.
$this
getTotalSize
The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
int
setTotalSize
The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.
var
int
$this
getCorrectedQuery
Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query.
Otherwise the original query is used for search.
string
setCorrectedQuery
Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query.
Otherwise the original query is used for search.
var
string
$this
getAttributionToken
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
string
setAttributionToken
A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.
var
string
$this
getNextPageToken
A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
string
setNextPageToken
A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
var
string
$this
getQueryExpansionInfo
Query expansion information for the returned results.
hasQueryExpansionInfo
clearQueryExpansionInfo
setQueryExpansionInfo
Query expansion information for the returned results.
$this
getRedirectUri
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
string
setRedirectUri
The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.
var
string
$this
getAppliedControls
The fully qualified resource name of applied controls .
setAppliedControls
The fully qualified resource name of applied controls .
var
string[]
$this
getInvalidConditionBoostSpecs
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
setInvalidConditionBoostSpecs
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
$this
