Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Fact

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

The fact used in grounding.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Fact

Returns a new instance of GoogleCloudAiplatformV1beta1Fact.



14922
14923
14924
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14922

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

Instance Attribute Details

#chunk ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagChunk

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

Returns:



14884
14885
14886
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14884

def chunk
  @chunk
end

#query ⇒ String

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

Returns:

  • (String) 


14889
14890
14891
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14889

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) 


14900
14901
14902
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14900

def score
  @score
end

#summary ⇒ String

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

Returns:

  • (String) 


14905
14906
14907
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14905

def summary
  @summary
end

#title ⇒ String

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

Returns:

  • (String) 


14910
14911
14912
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14910

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) 


14915
14916
14917
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14915

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) 


14920
14921
14922
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14920

def vector_distance
  @vector_distance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14927
14928
14929
14930
14931
14932
14933
14934
14935
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 14927

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