Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

RecommendationResult represents a generic recommendation result with associated metadata.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult

Returns a new instance of GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult.



4813
4814
4815
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4813

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#document ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument

Document captures all raw metadata information of items to be recommended or searched. Corresponds to the JSON property document

Returns:



4799
4800
4801
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4799

def document
  @document
end

#id ⇒ String

Resource ID of the recommended Document. Corresponds to the JSON property id

Returns:

  • (String) 


4804
4805
4806
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4804

def id
  @id
end

#metadata ⇒ Hash<String,Object>

Additional Document metadata / annotations. Possible values: * score: Recommendation score in double value. Is set if returnScore is set to true in RecommendRequest.params. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


4811
4812
4813
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4811

def metadata
  @metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4818
4819
4820
4821
4822
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4818

def update!(**args)
  @document = args[:document] if args.key?(:document)
  @id = args[:id] if args.key?(:id)
  @metadata = args[:metadata] if args.key?(:metadata)
end