Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VertexRagStore

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

Overview

Retrieve from Vertex RAG Store for grounding.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1VertexRagStore

Returns a new instance of GoogleCloudAiplatformV1VertexRagStore.



38449
38450
38451
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 38449

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

Instance Attribute Details

#rag_resources ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1VertexRagStoreRagResource>

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:



38432
38433
38434
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 38432

def rag_resources
  @rag_resources
end

#rag_retrieval_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagRetrievalConfig

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

Returns:



38437
38438
38439
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 38437

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) 


38442
38443
38444
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 38442

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) 


38447
38448
38449
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 38447

def vector_distance_threshold
  @vector_distance_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



38454
38455
38456
38457
38458
38459
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 38454

def update!(**args)
  @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