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

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

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

#facets=

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

Parameter

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

Returns

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

#geo_search_debug_info

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

Returns

(::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>)

#geo_search_debug_info=

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

Parameter

value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>)

Returns

(::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>)

#guided_search_result

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

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult) — Guided search result.

#guided_search_result=

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

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult) — Guided search result.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult) — Guided search result.

#natural_language_query_understanding_info

def natural_language_query_understanding_info() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo) — Natural language query understanding information for the returned results.

#natural_language_query_understanding_info=

def natural_language_query_understanding_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo) — Natural language query understanding information for the returned results.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo) — Natural language query understanding information for the returned results.

#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

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

#query_expansion_info=

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

Parameter

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

Returns

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

Returns

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

#results=

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

Parameter

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

Returns

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

#session_info

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

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::SearchResponse::SessionInfo

Parameter

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

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

Returns

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

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

#summary

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

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::SearchResponse::Summary

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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.