Class: Google::Cloud::AIPlatform::V1::Fact

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb

Overview

The fact used in grounding.

Instance Attribute Summary collapse

Instance Attribute Details

#chunk ⇒ ::Google::Cloud::AIPlatform::V1::RagChunk

Returns If present, chunk properties.

Returns:



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns Query that is used to retrieve this fact.

Returns:

  • (::String) —

    Query that is used to retrieve this fact.



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#score ⇒ ::Float

Returns 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.

Returns:

  • (::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.



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#summary ⇒ ::String

Returns If present, the summary/snippet of the fact.

Returns:

  • (::String) —

    If present, the summary/snippet of the fact.



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#title ⇒ ::String

Returns If present, it refers to the title of this fact.

Returns:

  • (::String) —

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



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

Returns If present, this uri links to the source of the fact.

Returns:

  • (::String) —

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



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#vector_distance ⇒ ::Float

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns If present, the distance between the query vector and this fact vector.

Returns:

  • (::Float) —

    If present, the distance between the query vector and this fact vector.



260
261
262
263
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 260

class Fact
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end