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.



13781
13782
13783
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13781

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:



13743
13744
13745
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13743

def chunk
  @chunk
end

#query ⇒ String

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

Returns:

  • (String) 


13748
13749
13750
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13748

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) 


13759
13760
13761
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13759

def score
  @score
end

#summary ⇒ String

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

Returns:

  • (String) 


13764
13765
13766
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13764

def summary
  @summary
end

#title ⇒ String

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

Returns:

  • (String) 


13769
13770
13771
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13769

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) 


13774
13775
13776
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13774

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) 


13779
13780
13781
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13779

def vector_distance
  @vector_distance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13786
13787
13788
13789
13790
13791
13792
13793
13794
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13786

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