Class: Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1VertexRagStore

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) ⇒ GoogleCloudAiplatformV1beta1VertexRagStore

Returns a new instance of GoogleCloudAiplatformV1beta1VertexRagStore.



2065
2066
2067
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2065

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>) 


2041
2042
2043
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2041

def rag_corpora
  @rag_corpora
end

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

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:



2048
2049
2050
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2048

def rag_resources
  @rag_resources
end

#rag_retrieval_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1RagRetrievalConfig

Specifies the context retrieval config. Corresponds to the JSON property ragRetrievalConfig

Returns:



2053
2054
2055
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2053

def rag_retrieval_config
  @rag_retrieval_config
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) 


2058
2059
2060
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2058

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) 


2063
2064
2065
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2063

def vector_distance_threshold
  @vector_distance_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2070
2071
2072
2073
2074
2075
2076
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 2070

def update!(**args)
  @rag_corpora = args[:rag_corpora] if args.key?(:rag_corpora)
  @rag_resources = args[:rag_resources] if args.key?(:rag_resources)
  @rag_retrieval_config = args[:rag_retrieval_config] if args.key?(:rag_retrieval_config)
  @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