Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::SearchResponse (v0.12.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::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>) — Controls applied as part of the Control service.

#applied_controls=

def applied_controls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Controls applied as part of the Control service.
Returns
  • (::Array<::String>) — Controls applied as part of the Control service.

#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.

#facets

def facets() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet>
Returns

#facets=

def facets=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet>
Parameter
Returns

#geo_search_debug_info

def geo_search_debug_info() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>
Returns

#geo_search_debug_info=

def geo_search_debug_info=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>
Parameter
Returns

#guided_search_result

def guided_search_result() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult
Returns

#guided_search_result=

def guided_search_result=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult
Parameter
Returns

#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::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo
Returns

#query_expansion_info=

def query_expansion_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo
Parameter
Returns

#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::DiscoveryEngine::V1beta::SearchResponse::SearchResult>
Returns

#results=

def results=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>
Parameter
Returns

#summary

def summary() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary
Returns

#summary=

def summary=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary
Parameter
Returns

#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.