Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Fact

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

The fact used in grounding.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Fact

Returns a new instance of GoogleCloudAiplatformV1Fact.



9281
9282
9283
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9281

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:



9243
9244
9245
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9243

def chunk
  @chunk
end

#query ⇒ String

Query that is used to retrieve this fact. Corresponds to the JSON property query

Returns:

  • (String) 


9248
9249
9250
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9248

def query
  @query
end

#score ⇒ Float

If present, 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 fact 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 fact. The larger the distance, the less relevant the fact 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) 


9259
9260
9261
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9259

def score
  @score
end

#summary ⇒ String

If present, the summary/snippet of the fact. Corresponds to the JSON property summary

Returns:

  • (String) 


9264
9265
9266
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9264

def summary
  @summary
end

#title ⇒ String

If present, it refers to the title of this fact. Corresponds to the JSON property title

Returns:

  • (String) 


9269
9270
9271
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9269

def title
  @title
end

#uri ⇒ String

If present, this uri links to the source of the fact. Corresponds to the JSON property uri

Returns:

  • (String) 


9274
9275
9276
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9274

def uri
  @uri
end

#vector_distance ⇒ Float

If present, the distance between the query vector and this fact vector. Corresponds to the JSON property vectorDistance

Returns:

  • (Float) 


9279
9280
9281
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9279

def vector_distance
  @vector_distance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9286
9287
9288
9289
9290
9291
9292
9293
9294
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 9286

def update!(**args)
  @chunk = args[:chunk] if args.key?(:chunk)
  @query = args[:query] if args.key?(:query)
  @score = args[:score] if args.key?(:score)
  @summary = args[:summary] if args.key?(:summary)
  @title = args[:title] if args.key?(:title)
  @uri = args[:uri] if args.key?(:uri)
  @vector_distance = args[:vector_distance] if args.key?(:vector_distance)
end