Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunk

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

A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a GroundingChunk that contains a reference to the source of the information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1GroundingChunk

Returns a new instance of GoogleCloudAiplatformV1beta1GroundingChunk.



27185
27186
27187
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 27185

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

Instance Attribute Details

#image ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkImage

An Image chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. Corresponds to the JSON property image

Returns:



27162
27163
27164
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 27162

def image
  @image
end

#maps ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMaps

A Maps chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. Corresponds to the JSON property maps

Returns:



27169
27170
27171
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 27169

def maps
  @maps
end

#retrieved_context ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext

Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. Corresponds to the JSON property retrievedContext

Returns:



27176
27177
27178
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 27176

def retrieved_context
  @retrieved_context
end

#web ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkWeb

A Web chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. Corresponds to the JSON property web

Returns:



27183
27184
27185
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 27183

def web
  @web
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27190
27191
27192
27193
27194
27195
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 27190

def update!(**args)
  @image = args[:image] if args.key?(:image)
  @maps = args[:maps] if args.key?(:maps)
  @retrieved_context = args[:retrieved_context] if args.key?(:retrieved_context)
  @web = args[:web] if args.key?(:web)
end