Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagQuery

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

A query to retrieve relevant contexts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1RagQuery

Returns a new instance of GoogleCloudAiplatformV1beta1RagQuery.



42727
42728
42729
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 42727

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

Instance Attribute Details

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

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

Returns:



42710
42711
42712
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 42710

def rag_retrieval_config
  @rag_retrieval_config
end

#ranking ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagQueryRanking

Configurations for hybrid search results ranking. Corresponds to the JSON property ranking

Returns:



42715
42716
42717
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 42715

def ranking
  @ranking
end

#similarity_top_k ⇒ Fixnum

Optional. The number of contexts to retrieve. Corresponds to the JSON property similarityTopK

Returns:

  • (Fixnum) 


42720
42721
42722
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 42720

def similarity_top_k
  @similarity_top_k
end

#text ⇒ String

Optional. The query in text format to get relevant contexts. Corresponds to the JSON property text

Returns:

  • (String) 


42725
42726
42727
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 42725

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



42732
42733
42734
42735
42736
42737
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 42732

def update!(**args)
  @rag_retrieval_config = args[:rag_retrieval_config] if args.key?(:rag_retrieval_config)
  @ranking = args[:ranking] if args.key?(:ranking)
  @similarity_top_k = args[:similarity_top_k] if args.key?(:similarity_top_k)
  @text = args[:text] if args.key?(:text)
end