Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata

Inherits:
Object
  • Object
show all
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

Citation for the generated content.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata

Returns a new instance of GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadata.



10741
10742
10743
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10741

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

Instance Attribute Details

#grounding_support ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>

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:



10715
10716
10717
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10715

def grounding_support
  @grounding_support
end

#retrieval_metadata ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>

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:



10723
10724
10725
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10723

def retrieval_metadata
  @retrieval_metadata
end

#search_entry_point ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint

Google search entry point. Corresponds to the JSON property searchEntryPoint

Returns:



10728
10729
10730
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10728

def search_entry_point
  @search_entry_point
end

#support_chunks ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFactChunk>

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:



10734
10735
10736
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10734

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>) 


10739
10740
10741
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10739

def web_search_queries
  @web_search_queries
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10746
10747
10748
10749
10750
10751
10752
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10746

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