Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingChunkRetrievedContext

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

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1GroundingChunkRetrievedContext

Returns a new instance of GoogleCloudAiplatformV1GroundingChunkRetrievedContext.



18533
18534
18535
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18533

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

Instance Attribute Details

#document_name ⇒ String

Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is projects/project/locations/location/collections/collection /dataStores/data_store/branches/branch/documents/document`. Corresponds to the JSON propertydocumentName`

Returns:

  • (String) 


18510
18511
18512
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18510

def document_name
  @document_name
end

#rag_chunk ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagChunk

A RagChunk includes the content of a chunk of a RagFile, and associated metadata. Corresponds to the JSON property ragChunk

Returns:



18516
18517
18518
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18516

def rag_chunk
  @rag_chunk
end

#text ⇒ String

The content of the retrieved data source. Corresponds to the JSON property text

Returns:

  • (String) 


18521
18522
18523
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18521

def text
  @text
end

#title ⇒ String

The title of the retrieved data source. Corresponds to the JSON property title

Returns:

  • (String) 


18526
18527
18528
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18526

def title
  @title
end

#uri ⇒ String

The URI of the retrieved data source. Corresponds to the JSON property uri

Returns:

  • (String) 


18531
18532
18533
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18531

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18538
18539
18540
18541
18542
18543
18544
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18538

def update!(**args)
  @document_name = args[:document_name] if args.key?(:document_name)
  @rag_chunk = args[:rag_chunk] if args.key?(:rag_chunk)
  @text = args[:text] if args.key?(:text)
  @title = args[:title] if args.key?(:title)
  @uri = args[:uri] if args.key?(:uri)
end