Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SearchResponse (v1.2.0)

Version 1.2.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::SearchResponse.

Response message for SearchService.Search method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#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. This also helps to identify a request during the customer support scenarios.

#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. This also helps to identify a request during the customer support scenarios.

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. This also helps to identify a request during the customer support scenarios.

#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::V1::SearchResponse::Facet>

Returns

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

#facets=

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

Parameter

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

Returns

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

#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::V1::SearchResponse::QueryExpansionInfo

Returns

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

#query_expansion_info=

def query_expansion_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::QueryExpansionInfo

Parameter

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

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::DiscoveryEngine::V1::SearchResponse::SearchResult>

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>) — A list of matched documents. The order represents the ranking.

#results=

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

Parameter

• value (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>) — A list of matched documents. The order represents the ranking.

Returns

• (::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult>) — A list of matched documents. The order represents the ranking.

#session_info

def session_info() -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo) — Session information.

  Only set if SearchRequest.session is provided. See its description for more details.

#session_info=

def session_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo) — Session information.

  Only set if SearchRequest.session is provided. See its description for more details.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SessionInfo) — Session information.

  Only set if SearchRequest.session is provided. See its description for more details.

#summary

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

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary) — A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

#summary=

def summary=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary) — A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary) — A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

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