Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams

Inherits:

Object

• Object
• Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams

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

Parameters for semantic similarity search based retrieval.

Instance Attribute Summary

• #search_query ⇒ String

  Required.

• #top_k ⇒ Fixnum

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams constructor

  A new instance of GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams

Returns a new instance of GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams.

# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31781

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

Instance Attribute Details

#search_query ⇒ String

Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig. SimilaritySearchConfig set. Corresponds to the JSON property searchQuery

Returns:

• (String)

# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31772

def search_query
  @search_query
end

#top_k ⇒ Fixnum

Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100. Corresponds to the JSON property topK

Returns:

• (Fixnum)

# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31779

def top_k
  @top_k
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/aiplatform_v1/classes.rb', line 31786

def update!(**args)
  @search_query = args[:search_query] if args.key?(:search_query)
  @top_k = args[:top_k] if args.key?(:top_k)
end