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

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

Relevant contexts for one query.

Defined Under Namespace

Classes: Context

Instance Attribute Summary collapse

Instance Attribute Details

#contexts ⇒ ::Array<::Google::Cloud::AIPlatform::V1::RagContexts::Context>

Returns All its contexts.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_service.rb', line 91

class RagContexts
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A context of the query.
  # @!attribute [rw] source_uri
  #   @return [::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.
  # @!attribute [rw] source_display_name
  #   @return [::String]
  #     The file display name.
  # @!attribute [rw] text
  #   @return [::String]
  #     The text chunk.
  # @!attribute [rw] score
  #   @return [::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.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::AIPlatform::V1::RagChunk]
  #     Context of the retrieved chunk.
  class Context
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end