Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VertexRagStore

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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.



40985
40986
40987
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40985

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


40961
40962
40963
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40961

def rag_corpora
  @rag_corpora
end

#rag_resources ⇒ Array<Google::Apis::AiplatformV1beta1::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:



40968
40969
40970
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40968

def rag_resources
  @rag_resources
end

#rag_retrieval_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagRetrievalConfig

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

Returns:



40973
40974
40975
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40973

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) 


40978
40979
40980
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40978

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) 


40983
40984
40985
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40983

def vector_distance_threshold
  @vector_distance_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



40990
40991
40992
40993
40994
40995
40996
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 40990

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