Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveMemoriesRequest

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

Request message for MemoryBankService.RetrieveMemories.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1RetrieveMemoriesRequest

Returns a new instance of GoogleCloudAiplatformV1RetrieveMemoriesRequest.



33410
33411
33412
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33410

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

Instance Attribute Details

#filter ⇒ String

Optional. The standard list filter that will be applied to the retrieved memories. More detail in AIP-160. Supported fields: * fact * create_time * update_time * topics (i.e. topics. custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES) Corresponds to the JSON property filter

Returns:

  • (String) 


33371
33372
33373
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33371

def filter
  @filter
end

#filter_groups ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MemoryConjunctionFilter>

Optional. Metadata filters that will be applied to the retrieved memories' metadata using OR logic. Filters are defined using disjunctive normal form ( OR of ANDs). For example: filter_groups: [filters: [key: "author", value: string_value: "agent 123", op: EQUAL],filters: [key: "label", value: string_value: "travel", op: EQUAL, key: "author", value:string_value: " agent 321", op: EQUAL]] would be equivalent to the logical expression: ( metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata. author = "agent 321")). Corresponds to the JSON property filterGroups

Returns:



33383
33384
33385
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33383

def filter_groups
  @filter_groups
end

#memory_types ⇒ Array<String>

Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type NATURAL_LANGUAGE_COLLECTION. If populated, the request will retrieve memories matching any of the specified MemoryType values. Corresponds to the JSON property memoryTypes

Returns:

  • (Array<String>) 


33391
33392
33393
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33391

def memory_types
  @memory_types
end

#scope ⇒ Hash<String,String>

Required. The scope of the memories to retrieve. A memory must have exactly the same scope (Memory.scope) as the scope provided here to be retrieved ( same keys and values). Order does not matter, but it is case-sensitive. Corresponds to the JSON property scope

Returns:

  • (Hash<String,String>) 


33398
33399
33400
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33398

def scope
  @scope
end

#similarity_search_params ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveMemoriesRequestSimilaritySearchParams

Parameters for semantic similarity search based retrieval. Corresponds to the JSON property similaritySearchParams

Returns:



33403
33404
33405
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33403

def similarity_search_params
  @similarity_search_params
end

#simple_retrieval_params ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveMemoriesRequestSimpleRetrievalParams

Parameters for simple (non-similarity search) retrieval. Corresponds to the JSON property simpleRetrievalParams

Returns:



33408
33409
33410
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33408

def simple_retrieval_params
  @simple_retrieval_params
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33415
33416
33417
33418
33419
33420
33421
33422
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 33415

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @filter_groups = args[:filter_groups] if args.key?(:filter_groups)
  @memory_types = args[:memory_types] if args.key?(:memory_types)
  @scope = args[:scope] if args.key?(:scope)
  @similarity_search_params = args[:similarity_search_params] if args.key?(:similarity_search_params)
  @simple_retrieval_params = args[:simple_retrieval_params] if args.key?(:simple_retrieval_params)
end