Class MemorySearchSummary
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<MemorySearchSummary.Builder,MemorySearchSummary>
A SearchMemories result: a matching memory and its relevance score.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic MemorySearchSummary.Builderbuilder()final Stringcontent()The memory text.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Metadata property.final booleanFor responses, this returns true if the service returned a value for the SourceEventIds property.final StringmemoryId()The memory's ID, assigned by the service.final MemoryTypeThe memory type of the result.final StringThe memory type of the result.metadata()The memory's metadata tags.final Doublescore()The relevance score of the result.static Class<? extends MemorySearchSummary.Builder> The IDs of the events the memory was derived from, without duplicates.final StringThe name of the strategy the memory belongs to, for exampleuser-facts: the strategymemoryStrategiesselects on inSearchMemories.final SystemMetadataProvenance for the memory: the actor and session that own it, and when it was created and last updated.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
memoryId
The memory's ID, assigned by the service. Always present.
- Returns:
- The memory's ID, assigned by the service. Always present.
-
memoryType
The memory type of the result.
If the service returns an enum value that is not available in the current SDK version,
memoryTypewill returnMemoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommemoryTypeAsString().- Returns:
- The memory type of the result.
- See Also:
-
memoryTypeAsString
The memory type of the result.
If the service returns an enum value that is not available in the current SDK version,
memoryTypewill returnMemoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommemoryTypeAsString().- Returns:
- The memory type of the result.
- 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.- Returns:
- 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.
-
content
-
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:
- 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.
-
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.
- Returns:
- 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.
-
hasMetadata
public final boolean hasMetadata()For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
metadata
The memory's metadata tags. All values are strings. In a query, filter on a tag as
metadata.<key>.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetadata()method.- Returns:
- The memory's metadata tags. All values are strings. In a query, filter on a tag as
metadata.<key>.
-
hasSourceEventIds
public final boolean hasSourceEventIds()For responses, this returns true if the service returned a value for the SourceEventIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSourceEventIds()method.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<MemorySearchSummary.Builder,MemorySearchSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-