Class: Google::Apis::FirebasemlV2beta::VertexRagStore

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

Overview

Retrieve from Vertex RAG Store for grounding.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VertexRagStore

Returns a new instance of VertexRagStore.



1267
1268
1269
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1267

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

Instance Attribute Details

#rag_corpora ⇒ Array<String>

Optional. Deprecated. Please use rag_resources instead. Corresponds to the JSON property ragCorpora

Returns:

  • (Array<String>) 


1248
1249
1250
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1248

def rag_corpora
  @rag_corpora
end

#rag_resources ⇒ Array<Google::Apis::FirebasemlV2beta::RagResource>

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. Corresponds to the JSON property ragResources

Returns:



1255
1256
1257
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1255

def rag_resources
  @rag_resources
end

#similarity_top_k ⇒ Fixnum

Optional. Number of top k results to return from the selected corpora. Corresponds to the JSON property similarityTopK

Returns:

  • (Fixnum) 


1260
1261
1262
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1260

def similarity_top_k
  @similarity_top_k
end

#vector_distance_threshold ⇒ Float

Optional. Only return results with vector distance smaller than the threshold. Corresponds to the JSON property vectorDistanceThreshold

Returns:

  • (Float) 


1265
1266
1267
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1265

def vector_distance_threshold
  @vector_distance_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1272
1273
1274
1275
1276
1277
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1272

def update!(**args)
  @rag_corpora = args[:rag_corpora] if args.key?(:rag_corpora)
  @rag_resources = args[:rag_resources] if args.key?(:rag_resources)
  @similarity_top_k = args[:similarity_top_k] if args.key?(:similarity_top_k)
  @vector_distance_threshold = args[:vector_distance_threshold] if args.key?(:vector_distance_threshold)
end