Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult.
RecommendationResult represents a generic recommendation result with associated metadata.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#document
def document() -> ::Google::Cloud::DiscoveryEngine::V1::Document
Returns
-
(::Google::Cloud::DiscoveryEngine::V1::Document) — Set if
returnDocument
is set to true in RecommendRequest.params.
#document=
def document=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Document
Parameter
-
value (::Google::Cloud::DiscoveryEngine::V1::Document) — Set if
returnDocument
is set to true in RecommendRequest.params.
Returns
-
(::Google::Cloud::DiscoveryEngine::V1::Document) — Set if
returnDocument
is set to true in RecommendRequest.params.
#id
def id() -> ::String
Returns
- (::String) — Resource ID of the recommended Document.
#id=
def id=(value) -> ::String
Parameter
- value (::String) — Resource ID of the recommended Document.
Returns
- (::String) — Resource ID of the recommended Document.
#metadata
def metadata() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Returns
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —
Additional Document metadata or annotations.
Possible values:
score
: Recommendation score in double value. Is set ifreturnScore
is set to true in RecommendRequest.params.
#metadata=
def metadata=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Parameter
-
value (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —
Additional Document metadata or annotations.
Possible values:
score
: Recommendation score in double value. Is set ifreturnScore
is set to true in RecommendRequest.params.
Returns
-
(::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —
Additional Document metadata or annotations.
Possible values:
score
: Recommendation score in double value. Is set ifreturnScore
is set to true in RecommendRequest.params.