Interface MemorySearchSummary.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<MemorySearchSummary.Builder,,MemorySearchSummary> SdkBuilder<MemorySearchSummary.Builder,,MemorySearchSummary> SdkPojo
- Enclosing class:
MemorySearchSummary
-
Method Summary
Modifier and TypeMethodDescriptionThe memory text.The memory's ID, assigned by the service.memoryType(String memoryType) The memory type of the result.memoryType(MemoryType memoryType) The memory type of the result.The memory's metadata tags.The relevance score of the result.sourceEventIds(String... sourceEventIds) The IDs of the events the memory was derived from, without duplicates.sourceEventIds(Collection<String> sourceEventIds) The IDs of the events the memory was derived from, without duplicates.strategyName(String strategyName) The name of the strategy the memory belongs to, for exampleuser-facts: the strategymemoryStrategiesselects on inSearchMemories.default MemorySearchSummary.BuildersystemMetadata(Consumer<SystemMetadata.Builder> systemMetadata) Provenance for the memory: the actor and session that own it, and when it was created and last updated.systemMetadata(SystemMetadata systemMetadata) Provenance for the memory: the actor and session that own it, and when it was created and last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
memoryId
The memory's ID, assigned by the service. Always present.
- Parameters:
memoryId- The memory's ID, assigned by the service. Always present.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memoryType
The memory type of the result.
- Parameters:
memoryType- The memory type of the result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
memoryType
The memory type of the result.
- Parameters:
memoryType- The memory type of the result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
strategyName
The name of the strategy the memory belongs to, for example
user-facts: the strategymemoryStrategiesselects on inSearchMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.- Parameters:
strategyName- The name of the strategy the memory belongs to, for exampleuser-facts: the strategymemoryStrategiesselects on inSearchMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
content
The memory text.
- Parameters:
content- The memory text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
score
The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.
- Parameters:
score- The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
systemMetadata
Provenance for the memory: the actor and session that own it, and when it was created and last updated. It is the same block that
ListMemories,GetMemory, andSearchEventsreturn.In a query, filter or sort on the timestamps as
system_metadata.created_atandsystem_metadata.updated_at. Scope by owner with the top-levelactorId, not in the query. Searching memories doesn't filter by session.Absent when the service has no provenance for the memory.
- Parameters:
systemMetadata- Provenance for the memory: the actor and session that own it, and when it was created and last updated. It is the same block thatListMemories,GetMemory, andSearchEventsreturn.In a query, filter or sort on the timestamps as
system_metadata.created_atandsystem_metadata.updated_at. Scope by owner with the top-levelactorId, not in the query. Searching memories doesn't filter by session.Absent when the service has no provenance for the memory.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
systemMetadata
Provenance for the memory: the actor and session that own it, and when it was created and last updated. It is the same block that
ListMemories,GetMemory, andSearchEventsreturn.In a query, filter or sort on the timestamps as
system_metadata.created_atandsystem_metadata.updated_at. Scope by owner with the top-levelactorId, not in the query. Searching memories doesn't filter by session.Absent when the service has no provenance for the memory.
This is a convenience method that creates an instance of theSystemMetadata.Builderavoiding the need to create one manually viaSystemMetadata.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosystemMetadata(SystemMetadata).- Parameters:
systemMetadata- a consumer that will call methods onSystemMetadata.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metadata
The memory's metadata tags. All values are strings. In a query, filter on a tag as
metadata.<key>.- Parameters:
metadata- The memory's metadata tags. All values are strings. In a query, filter on a tag asmetadata.<key>.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceEventIds
The IDs of the events the memory was derived from, without duplicates. Use them with
GetEventorBatchGetEvent, or to search those events' content withSearchEventsby filtering onevent_idsin the query. Absent for a memory created directly withCreateMemory. A memory can be derived from several events. The service sets this value.- Parameters:
sourceEventIds- The IDs of the events the memory was derived from, without duplicates. Use them withGetEventorBatchGetEvent, or to search those events' content withSearchEventsby filtering onevent_idsin the query. Absent for a memory created directly withCreateMemory. A memory can be derived from several events. The service sets this value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceEventIds
The IDs of the events the memory was derived from, without duplicates. Use them with
GetEventorBatchGetEvent, or to search those events' content withSearchEventsby filtering onevent_idsin the query. Absent for a memory created directly withCreateMemory. A memory can be derived from several events. The service sets this value.- Parameters:
sourceEventIds- The IDs of the events the memory was derived from, without duplicates. Use them withGetEventorBatchGetEvent, or to search those events' content withSearchEventsby filtering onevent_idsin the query. Absent for a memory created directly withCreateMemory. A memory can be derived from several events. The service sets this value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-