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.



57952
57953
57954
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57952

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


57918
57919
57920
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57918

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:



57925
57926
57927
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57925

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:



57930
57931
57932
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57930

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) 


57935
57936
57937
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57935

def similarity_top_k
  @similarity_top_k
end

#store_context ⇒ Boolean Also known as: store_context?

Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if store_context bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. Corresponds to the JSON property storeContext

Returns:

  • (Boolean) 


57944
57945
57946
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57944

def store_context
  @store_context
end

#vector_distance_threshold ⇒ Float

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

Returns:

  • (Float) 


57950
57951
57952
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57950

def vector_distance_threshold
  @vector_distance_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



57957
57958
57959
57960
57961
57962
57963
57964
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 57957

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)
  @store_context = args[:store_context] if args.key?(:store_context)
  @vector_distance_threshold = args[:vector_distance_threshold] if args.key?(:vector_distance_threshold)
end