Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult.
Represents the search results.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#chunk
def chunk() -> ::Google::Cloud::DiscoveryEngine::V1::Chunk Returns
- (::Google::Cloud::DiscoveryEngine::V1::Chunk) — The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
#chunk=
def chunk=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Chunk Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::Chunk) — The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Chunk) — The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
#document
def document() -> ::Google::Cloud::DiscoveryEngine::V1::Document Returns
- (::Google::Cloud::DiscoveryEngine::V1::Document) — The document data snippet in the search response. Only fields that are marked as
retrievableare populated.
#document=
def document=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Document Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::Document) — The document data snippet in the search response. Only fields that are marked as
retrievableare populated.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::Document) — The document data snippet in the search response. Only fields that are marked as
retrievableare populated.
#id
def id() -> ::String Returns
- (::String) — Document.id of the searched Document.
#id=
def id=(value) -> ::String Parameter
- value (::String) — Document.id of the searched Document.
Returns
- (::String) — Document.id of the searched Document.
#model_scores
def model_scores() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::DoubleList} Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::DoubleList}) — Output only. Google provided available scores.
#rank_signals
def rank_signals() -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals Returns
- (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals) — A set of ranking signals associated with the result.
#rank_signals=
def rank_signals=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals) — A set of ranking signals associated with the result.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult::RankSignals) — A set of ranking signals associated with the result.