Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata

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

Citation for the generated content.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata

Returns a new instance of GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadata.



5639
5640
5641
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5639

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

Instance Attribute Details

#grounding_support ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>

GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact. Corresponds to the JSON property groundingSupport

Returns:



5613
5614
5615
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5613

def grounding_support
  @grounding_support
end

#retrieval_metadata ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users. Corresponds to the JSON property retrievalMetadata

Returns:



5621
5622
5623
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5621

def retrieval_metadata
  @retrieval_metadata
end

#search_entry_point ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint

Google search entry point. Corresponds to the JSON property searchEntryPoint

Returns:



5626
5627
5628
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5626

def search_entry_point
  @search_entry_point
end

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

List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request. Corresponds to the JSON property supportChunks

Returns:



5632
5633
5634
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5632

def support_chunks
  @support_chunks
end

#web_search_queries ⇒ Array<String>

Web search queries for the following-up web search. Corresponds to the JSON property webSearchQueries

Returns:

  • (Array<String>) 


5637
5638
5639
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5637

def web_search_queries
  @web_search_queries
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5644
5645
5646
5647
5648
5649
5650
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5644

def update!(**args)
  @grounding_support = args[:grounding_support] if args.key?(:grounding_support)
  @retrieval_metadata = args[:retrieval_metadata] if args.key?(:retrieval_metadata)
  @search_entry_point = args[:search_entry_point] if args.key?(:search_entry_point)
  @support_chunks = args[:support_chunks] if args.key?(:support_chunks)
  @web_search_queries = args[:web_search_queries] if args.key?(:web_search_queries)
end