Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult (v1.0.1)

Version 1.0.1

• 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::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 if returnScore 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 if returnScore 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 if returnScore is set to true in RecommendRequest.params.