Interface EventSearchSummary.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<EventSearchSummary.Builder,,EventSearchSummary> SdkBuilder<EventSearchSummary.Builder,,EventSearchSummary> SdkPojo
- Enclosing class:
EventSearchSummary
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the event that the chunk belongs to.matchedContent(String matchedContent) The text of the matching chunk.The event's metadata tags.The relevance score of the result.default EventSearchSummary.BuildersystemMetadata(Consumer<SystemMetadata.Builder> systemMetadata) Provenance for the chunk: the owning actor and session, and when it was created and last updated.systemMetadata(SystemMetadata systemMetadata) Provenance for the chunk: the owning actor and session, 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
-
eventId
The ID of the event that the chunk belongs to. Use it with
GetEventorDeleteEvent.- Parameters:
eventId- The ID of the event that the chunk belongs to. Use it withGetEventorDeleteEvent.- 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 chunk: the owning actor and session, and when it was created and last updated. It is the same block that
ListMemoriesandSearchMemoriesreturn. Event chunks are never modified, soupdatedAtalways equalscreatedAt.Absent when the service has no provenance for the chunk.
- Parameters:
systemMetadata- Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block thatListMemoriesandSearchMemoriesreturn. Event chunks are never modified, soupdatedAtalways equalscreatedAt.Absent when the service has no provenance for the chunk.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
systemMetadata
Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that
ListMemoriesandSearchMemoriesreturn. Event chunks are never modified, soupdatedAtalways equalscreatedAt.Absent when the service has no provenance for the chunk.
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 event's metadata tags. All values are strings. In a query, filter on a tag as
metadata.<key>.- Parameters:
metadata- The event'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.
-
matchedContent
The text of the matching chunk.
- Parameters:
matchedContent- The text of the matching chunk.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-