Class: Aws::OpenSearchMemory::Types::MemorySearchSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::OpenSearchMemory::Types::MemorySearchSummary
- Defined in:
- gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb
Overview
A SearchMemories result: a matching memory and its relevance score.
Constant Summary collapse
- SENSITIVE =
[:content]
Instance Attribute Summary collapse
-
#content ⇒ String
The memory text.
-
#memory_id ⇒ String
The memory's ID, assigned by the service.
-
#memory_type ⇒ String
The memory type of the result.
-
#metadata ⇒ Hash<String,String>
The memory's metadata tags.
-
#score ⇒ Float
The relevance score of the result.
-
#source_event_ids ⇒ Array<String>
The IDs of the events the memory was derived from, without duplicates.
-
#strategy_name ⇒ String
The name of the strategy the memory belongs to, for example
user-facts: the strategymemoryStrategiesselects on inSearchMemories. -
#system_metadata ⇒ Types::SystemMetadata
Provenance for the memory: the actor and session that own it, and when it was created and last updated.
Instance Attribute Details
#content ⇒ String
The memory text.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#memory_id ⇒ String
The memory's ID, assigned by the service. Always present.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#memory_type ⇒ String
The memory type of the result.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#metadata ⇒ Hash<String,String>
The memory's metadata tags. All values are strings. In a query,
filter on a tag as metadata.<key>.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#score ⇒ Float
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.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#source_event_ids ⇒ Array<String>
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.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#strategy_name ⇒ String
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.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |
#system_metadata ⇒ Types::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.
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 |
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1402 class MemorySearchSummary < Struct.new( :memory_id, :memory_type, :strategy_name, :content, :score, :system_metadata, :metadata, :source_event_ids) SENSITIVE = [:content] include Aws::Structure end |