Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingMetadata

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

Overview

Metadata returned to client when grounding is enabled.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1GroundingMetadata

Returns a new instance of GoogleCloudAiplatformV1GroundingMetadata.



11093
11094
11095
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11093

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

Instance Attribute Details

#grounding_chunks ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunk>

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

Returns:



11071
11072
11073
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11071

def grounding_chunks
  @grounding_chunks
end

#grounding_supports ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingSupport>

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

Returns:



11076
11077
11078
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11076

def grounding_supports
  @grounding_supports
end

#retrieval_metadata ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrievalMetadata

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

Returns:



11081
11082
11083
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11081

def retrieval_metadata
  @retrieval_metadata
end

#search_entry_point ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchEntryPoint

Google search entry point. Corresponds to the JSON property searchEntryPoint

Returns:



11086
11087
11088
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11086

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


11091
11092
11093
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11091

def web_search_queries
  @web_search_queries
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11098
11099
11100
11101
11102
11103
11104
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11098

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