View a markdown version of this page

MemorySearchSummary - Amazon OpenSearch Memory

MemorySearchSummary

A SearchMemories result: a matching memory and its relevance score.

Contents

memoryId

The memory's ID, assigned by the service. Always present.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

content

The memory text.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 40000.

Required: No

memoryType

The memory type of the result.

Type: String

Valid Values: SEMANTIC | SUMMARY | CUSTOM

Required: No

metadata

The memory's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 15 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9_-]+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [a-zA-Z0-9\s._:\/=+@-]*

Required: No

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.

Type: Double

Required: No

sourceEventIds

The IDs of the events the memory was derived from, without duplicates. Use them with GetEvent or BatchGetEvent, or to search those events' content with SearchEvents by filtering on event_ids in the query. Absent for a memory created directly with CreateMemory. A memory can be derived from several events. The service sets this value.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

strategyName

The name of the strategy the memory belongs to, for example user-facts: the strategy memoryStrategies selects on in SearchMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

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, and SearchEvents return.

In a query, filter or sort on the timestamps as system_metadata.created_at and system_metadata.updated_at. Scope by owner with the top-level actorId, not in the query. Searching memories doesn't filter by session.

Absent when the service has no provenance for the memory.

Type: SystemMetadata object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: