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.



23665
23666
23667
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23665

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:



23635
23636
23637
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23635

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) 


23646
23647
23648
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23646

def score
  @score
end

#source_display_name ⇒ String

The file display name. Corresponds to the JSON property sourceDisplayName

Returns:

  • (String) 


23651
23652
23653
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23651

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) 


23658
23659
23660
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23658

def source_uri
  @source_uri
end

#text ⇒ String

The text chunk. Corresponds to the JSON property text

Returns:

  • (String) 


23663
23664
23665
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23663

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23670
23671
23672
23673
23674
23675
23676
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23670

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