Class: Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb

Overview

Describes the metadata about the dynamic retrieval predictor.

Defined Under Namespace

Modules: Version

Instance Attribute Summary collapse

#prediction ⇒ ::Float
The value of the predictor.
#version ⇒ ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata::Version
The version of the predictor which was used in dynamic retrieval.

Instance Attribute Details

#prediction ⇒ `::Float`

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

Returns:

(::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.

# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 355

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

  # The version of the predictor which was used in dynamic retrieval.
  module Version
    # Unspecified version, should never be used.
    VERSION_UNSPECIFIED = 0

    # The V1 model which is evaluating each source independently.
    V1_INDEPENDENT = 1
  end
end

#version ⇒ `::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::DynamicRetrievalPredictorMetadata::Version`

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