Class: Google::Cloud::AIPlatform::V1::RagContexts::Context

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

A context of the query.

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Context of the retrieved chunk.

Returns:



120
121
122
123
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 120

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

#score ⇒ ::Float

Returns 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 context 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 context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

Returns:

  • (::Float) —

    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 context 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 context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.



120
121
122
123
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 120

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

#source_display_name ⇒ ::String

Returns The file display name.

Returns:

  • (::String) —

    The file display name.



120
121
122
123
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 120

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

#source_uri ⇒ ::String

Returns If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

Returns:

  • (::String) —

    If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.



120
121
122
123
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 120

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

#text ⇒ ::String

Returns The text chunk.

Returns:

  • (::String) —

    The text chunk.



120
121
122
123
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 120

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