Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponse

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

Overview

Response message for Recommend method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1RecommendResponse

Returns a new instance of GoogleCloudDiscoveryengineV1RecommendResponse.



5898
5899
5900
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5898

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

Instance Attribute Details

#attribution_token ⇒ String

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


5878
5879
5880
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5878

def attribution_token
  @attribution_token
end

#missing_ids ⇒ Array<String>

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. Corresponds to the JSON property missingIds

Returns:

  • (Array<String>) 


5884
5885
5886
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5884

def missing_ids
  @missing_ids
end

#results ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult>

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). Corresponds to the JSON property results

Returns:



5890
5891
5892
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5890

def results
  @results
end

#validate_only ⇒ Boolean Also known as: validate_only?

True if RecommendRequest.validate_only was set. Corresponds to the JSON property validateOnly

Returns:

  • (Boolean) 


5895
5896
5897
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5895

def validate_only
  @validate_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5903
5904
5905
5906
5907
5908
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5903

def update!(**args)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @missing_ids = args[:missing_ids] if args.key?(:missing_ids)
  @results = args[:results] if args.key?(:results)
  @validate_only = args[:validate_only] if args.key?(:validate_only)
end