Class: Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb

Overview

RecommendationResult represents a generic recommendation result with associated metadata.

Defined Under Namespace

Classes: MetadataEntry

Instance Attribute Summary

• #document ⇒ ::Google::Cloud::DiscoveryEngine::V1::Document

  Set if returnDocument is set to true in RecommendRequest.params.

• #id ⇒ ::String

  Resource ID of the recommended Document.

• #metadata ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

  Additional Document metadata or annotations.

Instance Attribute Details

#document ⇒ ::Google::Cloud::DiscoveryEngine::V1::Document

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 213

class RecommendationResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#id ⇒ ::String

Returns Resource ID of the recommended Document.

Returns:

• (::String) —

  Resource ID of the recommended Document.

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 213

class RecommendationResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#metadata ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb', line 213

class RecommendationResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Protobuf::Value]
  class MetadataEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end