Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata

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

Describes the metadata about the dynamic retrieval predictor.

Instance Attribute Summary

• #prediction ⇒ Float

  The value of the predictor.

• #version ⇒ String

  The version of the predictor which was used in dynamic retrieval.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata constructor

  A new instance of GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata

Returns a new instance of GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata.

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10791

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

Instance Attribute Details

#prediction ⇒ Float

The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. Corresponds to the JSON property prediction

Returns:

• (Float)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10784

def prediction
  @prediction
end

#version ⇒ String

The version of the predictor which was used in dynamic retrieval. Corresponds to the JSON property version

Returns:

• (String)

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10789

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10796

def update!(**args)
  @prediction = args[:prediction] if args.key?(:prediction)
  @version = args[:version] if args.key?(:version)
end