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.



8822
8823
8824
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8822

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

Instance Attribute Details

#query ⇒ String

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

Returns:

  • (String) 


8789
8790
8791
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8789

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) 


8800
8801
8802
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8800

def score
  @score
end

#summary ⇒ String

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

Returns:

  • (String) 


8805
8806
8807
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8805

def summary
  @summary
end

#title ⇒ String

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

Returns:

  • (String) 


8810
8811
8812
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8810

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) 


8815
8816
8817
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8815

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) 


8820
8821
8822
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8820

def vector_distance
  @vector_distance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8827
8828
8829
8830
8831
8832
8833
8834
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8827

def update!(**args)
  @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