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
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ results |
array<SearchResponse\SearchResult>
A list of matched items. The order represents the ranking. |
↳ facets |
array<SearchResponse\Facet>
Results of facets requested by user. |
↳ 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 |
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 |
array
The fully qualified resource name of applied controls. |
↳ pin_control_metadata |
PinControlMetadata
Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin. |
↳ invalid_condition_boost_specs |
array<SearchRequest\BoostSpec\ConditionBoostSpec>
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving. |
↳ experiment_info |
array<ExperimentInfo>
Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered. |
↳ conversational_search_result |
SearchResponse\ConversationalSearchResult
This field specifies all related information that is needed on client side for UI rendering of conversational retail search. |
↳ tile_navigation_result |
SearchResponse\TileNavigationResult
This field specifies all related information for tile navigation that will be used in client side. |
getResults
A list of matched items. The order represents the ranking.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setResults
A list of matched items. The order represents the ranking.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SearchResponse\SearchResult>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFacets
Results of facets requested by user.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFacets
Results of facets requested by user.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SearchResponse\Facet>
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryExpansionInfo
Query expansion information for the returned results.
| Returns | |
|---|---|
| Type | Description |
SearchResponse\QueryExpansionInfo|null |
|
hasQueryExpansionInfo
clearQueryExpansionInfo
setQueryExpansionInfo
Query expansion information for the returned results.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchResponse\QueryExpansionInfo
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAppliedControls
The fully qualified resource name of applied controls.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAppliedControls
The fully qualified resource name of applied controls.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPinControlMetadata
Metadata for pin controls which were applicable to the request.
This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
| Returns | |
|---|---|
| Type | Description |
PinControlMetadata|null |
|
hasPinControlMetadata
clearPinControlMetadata
setPinControlMetadata
Metadata for pin controls which were applicable to the request.
This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
| Parameter | |
|---|---|
| Name | Description |
var |
PinControlMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInvalidConditionBoostSpecs
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setInvalidConditionBoostSpecs
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SearchRequest\BoostSpec\ConditionBoostSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExperimentInfo
Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setExperimentInfo
Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ExperimentInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConversationalSearchResult
This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
| Returns | |
|---|---|
| Type | Description |
SearchResponse\ConversationalSearchResult|null |
|
hasConversationalSearchResult
clearConversationalSearchResult
setConversationalSearchResult
This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchResponse\ConversationalSearchResult
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTileNavigationResult
This field specifies all related information for tile navigation that will be used in client side.
| Returns | |
|---|---|
| Type | Description |
SearchResponse\TileNavigationResult|null |
|
hasTileNavigationResult
clearTileNavigationResult
setTileNavigationResult
This field specifies all related information for tile navigation that will be used in client side.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchResponse\TileNavigationResult
|
| Returns | |
|---|---|
| Type | Description |
$this |
|