Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse

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 the GroundedGenerationService.CheckGrounding method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CheckGroundingResponse

Returns a new instance of GoogleCloudDiscoveryengineV1CheckGroundingResponse.



1820
1821
1822
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1820

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

Instance Attribute Details

#cited_chunks ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk>

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. Corresponds to the JSON property citedChunks

Returns:



1806
1807
1808
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1806

def cited_chunks
  @cited_chunks
end

#claims ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim>

Claim texts and citation info across all claims in the answer candidate. Corresponds to the JSON property claims

Returns:



1811
1812
1813
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1811

def claims
  @claims
end

#support_score ⇒ Float

The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. Corresponds to the JSON property supportScore

Returns:

  • (Float) 


1818
1819
1820
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1818

def support_score
  @support_score
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1825
1826
1827
1828
1829
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 1825

def update!(**args)
  @cited_chunks = args[:cited_chunks] if args.key?(:cited_chunks)
  @claims = args[:claims] if args.key?(:claims)
  @support_score = args[:support_score] if args.key?(:support_score)
end