Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateMemoriesRequest

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.GenerateMemories. Maximum size is 8 MB.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1GenerateMemoriesRequest

Returns a new instance of GoogleCloudAiplatformV1GenerateMemoriesRequest.



16424
16425
16426
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16424

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

Instance Attribute Details

#allowed_topics ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MemoryTopicId>

Optional. Restricts memory generation to a subset of memory topics. Corresponds to the JSON property allowedTopics

Returns:



16352
16353
16354
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16352

def allowed_topics
  @allowed_topics
end

#direct_contents_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSource

Defines a direct source of content from which to generate the memories. Corresponds to the JSON property directContentsSource

Returns:



16357
16358
16359
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16357

def direct_contents_source
  @direct_contents_source
end

#direct_memories_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateMemoriesRequestDirectMemoriesSource

Defines a direct source of memories that should be uploaded to Memory Bank with consolidation. Corresponds to the JSON property directMemoriesSource

Returns:



16363
16364
16365
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16363

def direct_memories_source
  @direct_memories_source
end

#disable_consolidation ⇒ Boolean Also known as: disable_consolidation?

Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled. Corresponds to the JSON property disableConsolidation

Returns:

  • (Boolean) 


16371
16372
16373
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16371

def disable_consolidation
  @disable_consolidation
end

#disable_memory_revisions ⇒ Boolean Also known as: disable_memory_revisions?

Optional. If true, no revisions will be created for this request. Corresponds to the JSON property disableMemoryRevisions

Returns:

  • (Boolean) 


16377
16378
16379
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16377

def disable_memory_revisions
  @disable_memory_revisions
end

#metadata ⇒ Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MemoryMetadataValue>

Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. Corresponds to the JSON property metadata

Returns:



16384
16385
16386
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16384

def metadata
  @metadata
end

#metadata_merge_strategy ⇒ String

Optional. The strategy to use when applying metadata to existing memories. Corresponds to the JSON property metadataMergeStrategy

Returns:

  • (String) 


16389
16390
16391
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16389

def metadata_merge_strategy
  @metadata_merge_strategy
end

#revision_expire_time ⇒ String

Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. Corresponds to the JSON property revisionExpireTime

Returns:

  • (String) 


16395
16396
16397
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16395

def revision_expire_time
  @revision_expire_time
end

#revision_labels ⇒ Hash<String,String>

Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. Corresponds to the JSON property revisionLabels

Returns:

  • (Hash<String,String>) 


16401
16402
16403
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16401

def revision_labels
  @revision_labels
end

#revision_ttl ⇒ String

Optional. The TTL for the revision. The expiration time is computed: now + TTL. Corresponds to the JSON property revisionTtl

Returns:

  • (String) 


16406
16407
16408
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16406

def revision_ttl
  @revision_ttl
end

#scope ⇒ Hash<String,String>

Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If scope is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. Corresponds to the JSON property scope

Returns:

  • (Hash<String,String>) 


16415
16416
16417
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16415

def scope
  @scope
end

#vertex_session_source ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateMemoriesRequestVertexSessionSource

Defines an Agent Engine Session from which to generate the memories. If scope is not provided, the scope will be extracted from the Session (i.e. "user_id" : sesison.user_id). Corresponds to the JSON property vertexSessionSource

Returns:



16422
16423
16424
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16422

def vertex_session_source
  @vertex_session_source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 16429

def update!(**args)
  @allowed_topics = args[:allowed_topics] if args.key?(:allowed_topics)
  @direct_contents_source = args[:direct_contents_source] if args.key?(:direct_contents_source)
  @direct_memories_source = args[:direct_memories_source] if args.key?(:direct_memories_source)
  @disable_consolidation = args[:disable_consolidation] if args.key?(:disable_consolidation)
  @disable_memory_revisions = args[:disable_memory_revisions] if args.key?(:disable_memory_revisions)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metadata_merge_strategy = args[:metadata_merge_strategy] if args.key?(:metadata_merge_strategy)
  @revision_expire_time = args[:revision_expire_time] if args.key?(:revision_expire_time)
  @revision_labels = args[:revision_labels] if args.key?(:revision_labels)
  @revision_ttl = args[:revision_ttl] if args.key?(:revision_ttl)
  @scope = args[:scope] if args.key?(:scope)
  @vertex_session_source = args[:vertex_session_source] if args.key?(:vertex_session_source)
end