Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Citation for the generated content.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata

Returns a new instance of GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata.



15885
15886
15887
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15885

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

Instance Attribute Details

#grounding_support ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport>

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:



15859
15860
15861
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15859

def grounding_support
  @grounding_support
end

#retrieval_metadata ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata>

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:



15867
15868
15869
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15867

def retrieval_metadata
  @retrieval_metadata
end

#search_entry_point ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint

Google search entry point. Corresponds to the JSON property searchEntryPoint

Returns:



15872
15873
15874
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15872

def search_entry_point
  @search_entry_point
end

#support_chunks ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFactChunk>

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:



15878
15879
15880
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15878

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


15883
15884
15885
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15883

def web_search_queries
  @web_search_queries
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



15890
15891
15892
15893
15894
15895
15896
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 15890

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