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

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::Chunk

Returns

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

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::Chunk) — The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

Returns

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

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::Document) — The document data snippet in the search response. Only fields that are marked as retrievable are populated.

#document=

def document=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Document

Parameter

value (::Google::Cloud::DiscoveryEngine::V1beta::Document) — The document data snippet in the search response. Only fields that are marked as retrievable are populated.

Returns

(::Google::Cloud::DiscoveryEngine::V1beta::Document) — The document data snippet in the search response. Only fields that are marked as retrievable are 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::V1beta::DoubleList}

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}) — Google provided available scores.

#model_scores=

def model_scores=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}

Parameter

value (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}) — Google provided available scores.

Returns

(::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}) — Google provided available scores.