Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagContextsContext

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

A context of the query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1RagContextsContext

Returns a new instance of GoogleCloudAiplatformV1RagContextsContext.



29423
29424
29425
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29423

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

Instance Attribute Details

#chunk ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagChunk

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

Returns:



29393
29394
29395
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29393

def chunk
  @chunk
end

#score ⇒ Float

According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant. Corresponds to the JSON property score

Returns:

  • (Float) 


29404
29405
29406
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29404

def score
  @score
end

#source_display_name ⇒ String

The file display name. Corresponds to the JSON property sourceDisplayName

Returns:

  • (String) 


29409
29410
29411
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29409

def source_display_name
  @source_display_name
end

#source_uri ⇒ String

If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. Corresponds to the JSON property sourceUri

Returns:

  • (String) 


29416
29417
29418
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29416

def source_uri
  @source_uri
end

#text ⇒ String

The text chunk. Corresponds to the JSON property text

Returns:

  • (String) 


29421
29422
29423
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29421

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29428
29429
29430
29431
29432
29433
29434
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 29428

def update!(**args)
  @chunk = args[:chunk] if args.key?(:chunk)
  @score = args[:score] if args.key?(:score)
  @source_display_name = args[:source_display_name] if args.key?(:source_display_name)
  @source_uri = args[:source_uri] if args.key?(:source_uri)
  @text = args[:text] if args.key?(:text)
end