Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata

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

Overview

Metadata returned to client when grounding is enabled.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1GroundingMetadata

Returns a new instance of GoogleCloudAiplatformV1beta1GroundingMetadata.



13699
13700
13701
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13699

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

Instance Attribute Details

#grounding_chunks ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunk>

List of supporting references retrieved from specified grounding source. Corresponds to the JSON property groundingChunks

Returns:



13672
13673
13674
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13672

def grounding_chunks
  @grounding_chunks
end

#grounding_supports ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingSupport>

Optional. List of grounding support. Corresponds to the JSON property groundingSupports

Returns:



13677
13678
13679
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13677

def grounding_supports
  @grounding_supports
end

#retrieval_metadata ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrievalMetadata

Metadata related to retrieval in the grounding flow. Corresponds to the JSON property retrievalMetadata

Returns:



13682
13683
13684
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13682

def retrieval_metadata
  @retrieval_metadata
end

#retrieval_queries ⇒ Array<String>

Optional. Queries executed by the retrieval tools. Corresponds to the JSON property retrievalQueries

Returns:

  • (Array<String>) 


13687
13688
13689
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13687

def retrieval_queries
  @retrieval_queries
end

#search_entry_point ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchEntryPoint

Google search entry point. Corresponds to the JSON property searchEntryPoint

Returns:



13692
13693
13694
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13692

def search_entry_point
  @search_entry_point
end

#web_search_queries ⇒ Array<String>

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

Returns:

  • (Array<String>) 


13697
13698
13699
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13697

def web_search_queries
  @web_search_queries
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13704
13705
13706
13707
13708
13709
13710
13711
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 13704

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