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.
| Parameters | |
|---|---|
| Name | Description |
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 |
array<Google\Cloud\Retail\V2\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 |
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 |
array
The fully qualified resource name of 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.
Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setResults
A list of matched items. The order represents the ranking.
Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.SearchResult results = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Retail\V2\SearchResponse\SearchResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFacets
Results of facets requested by user.
Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFacets
Results of facets requested by user.
Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.Facet facets = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Retail\V2\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.
Generated from protobuf field int32 total_size = 3;
| 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.
Generated from protobuf field int32 total_size = 3;
| 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.
Generated from protobuf field string corrected_query = 4;
| 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.
Generated from protobuf field string corrected_query = 4;
| 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.
Generated from protobuf field string attribution_token = 5;
| 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.
Generated from protobuf field string attribution_token = 5;
| 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.
Generated from protobuf field string next_page_token = 6;
| 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.
Generated from protobuf field string next_page_token = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryExpansionInfo
Query expansion information for the returned results.
Generated from protobuf field .google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\SearchResponse\QueryExpansionInfo|null | |
hasQueryExpansionInfo
clearQueryExpansionInfo
setQueryExpansionInfo
Query expansion information for the returned results.
Generated from protobuf field .google.cloud.retail.v2.SearchResponse.QueryExpansionInfo query_expansion_info = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\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.
Generated from protobuf field string redirect_uri = 10;
| 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.
Generated from protobuf field string redirect_uri = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppliedControls
The fully qualified resource name of applied controls.
Generated from protobuf field repeated string applied_controls = 12;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAppliedControls
The fully qualified resource name of applied controls.
Generated from protobuf field repeated string applied_controls = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInvalidConditionBoostSpecs
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
Generated from protobuf field repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setInvalidConditionBoostSpecs
The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.
Generated from protobuf field repeated .google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec invalid_condition_boost_specs = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Retail\V2\SearchRequest\BoostSpec\ConditionBoostSpec>
|
| Returns | |
|---|---|
| Type | Description |
$this | |