Retail V2 API - Class Google::Cloud::Retail::V2::SearchResponse (v1.0.1)

Version 1.0.1

• 1.2.0 (latest)
• 1.1.0
• 1.0.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SearchResponse.

Response message for SearchService.Search method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#applied_controls

def applied_controls() -> ::Array<::String>

Returns

• (::Array<::String>) — The fully qualified resource name of applied controls.

#applied_controls=

def applied_controls=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — The fully qualified resource name of applied controls.

Returns

• (::Array<::String>) — The fully qualified resource name of applied controls.

#attribution_token

def attribution_token() -> ::String

Returns

• (::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.

#attribution_token=

def attribution_token=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#corrected_query

def corrected_query() -> ::String

Returns

• (::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.

#corrected_query=

def corrected_query=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#experiment_info

def experiment_info() -> ::Array<::Google::Cloud::Retail::V2::ExperimentInfo>

Returns

• (::Array<::Google::Cloud::Retail::V2::ExperimentInfo>) — Metadata related to A/B testing [Experiment][] associated with this response. Only exists when an experiment is triggered.

#experiment_info=

def experiment_info=(value) -> ::Array<::Google::Cloud::Retail::V2::ExperimentInfo>

Parameter

• value (::Array<::Google::Cloud::Retail::V2::ExperimentInfo>) — Metadata related to A/B testing [Experiment][] associated with this response. Only exists when an experiment is triggered.

Returns

• (::Array<::Google::Cloud::Retail::V2::ExperimentInfo>) — Metadata related to A/B testing [Experiment][] associated with this response. Only exists when an experiment is triggered.

#facets

def facets() -> ::Array<::Google::Cloud::Retail::V2::SearchResponse::Facet>

Returns

• (::Array<::Google::Cloud::Retail::V2::SearchResponse::Facet>) — Results of facets requested by user.

#facets=

def facets=(value) -> ::Array<::Google::Cloud::Retail::V2::SearchResponse::Facet>

Parameter

• value (::Array<::Google::Cloud::Retail::V2::SearchResponse::Facet>) — Results of facets requested by user.

Returns

• (::Array<::Google::Cloud::Retail::V2::SearchResponse::Facet>) — Results of facets requested by user.

#invalid_condition_boost_specs

def invalid_condition_boost_specs() -> ::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>

Returns

• (::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>) — The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.

#invalid_condition_boost_specs=

def invalid_condition_boost_specs=(value) -> ::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>

Parameter

• value (::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>) — The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.

Returns

• (::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>) — The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied during serving.

#next_page_token

def next_page_token() -> ::String

Returns

• (::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.

#next_page_token=

def next_page_token=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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

def query_expansion_info() -> ::Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo

Returns

• (::Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo) — Query expansion information for the returned results.

#query_expansion_info=

def query_expansion_info=(value) -> ::Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo

Parameter

• value (::Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo) — Query expansion information for the returned results.

Returns

• (::Google::Cloud::Retail::V2::SearchResponse::QueryExpansionInfo) — Query expansion information for the returned results.

#redirect_uri

def redirect_uri() -> ::String

Returns

• (::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.

#redirect_uri=

def redirect_uri=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#results

def results() -> ::Array<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>

Returns

• (::Array<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>) — A list of matched items. The order represents the ranking.

#results=

def results=(value) -> ::Array<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>

Parameter

• value (::Array<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>) — A list of matched items. The order represents the ranking.

Returns

• (::Array<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>) — A list of matched items. The order represents the ranking.

#total_size

def total_size() -> ::Integer

Returns

• (::Integer) — 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.

#total_size=

def total_size=(value) -> ::Integer

Parameter

• value (::Integer) — 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

• (::Integer) — 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.