View a markdown version of this page

EventSearchSummary - Amazon OpenSearch Memory

EventSearchSummary

A SearchEvents result: the matching chunk of an event and its provenance. Unlike EventSummary from ListEvents, it has a relevance score and the matched content, but not the full payload.

Contents

eventId

The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent.

Type: String

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

Required: Yes

matchedContent

The text of the matching chunk.

Type: String

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

Required: No

metadata

The event'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

systemMetadata

Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.

Absent when the service has no provenance for the chunk.

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: