Skip to content

EventSearchSummary

Source code in docs_src/capo_opensearchmemory/types/event_search_summary.py
class EventSearchSummary(TypedDict, closed=True):
    event_id: "capo_opensearchmemory.types.event_id.EventId"
    """<p>The ID of the event that the chunk belongs to. Use it with <code>GetEvent</code> or <code>DeleteEvent</code>.</p>"""
    score: NotRequired["float"]
    """<p>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.</p>"""
    system_metadata: NotRequired[
        "capo_opensearchmemory.types.system_metadata.SystemMetadata"
    ]
    """<p>Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that <code>ListMemories</code> and <code>SearchMemories</code> return. Event chunks are never modified, so <code>updatedAt</code> always equals <code>createdAt</code>.</p> <p>Absent when the service has no provenance for the chunk.</p>"""
    metadata: NotRequired["capo_opensearchmemory.types.metadata_map.MetadataMap"]
    """<p>The event's metadata tags. All values are strings. In a query, filter on a tag as <code>metadata.&lt;key&gt;</code>.</p>"""
    matched_content: NotRequired[
        "capo_opensearchmemory.types.sensitive_content.SensitiveContent"
    ]
    """<p>The text of the matching chunk.</p>"""

event_id instance-attribute

event_id: EventId

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

matched_content instance-attribute

matched_content: NotRequired[SensitiveContent]

The text of the matching chunk.

metadata instance-attribute

metadata: NotRequired[MetadataMap]

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

score instance-attribute

score: NotRequired[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.

system_metadata instance-attribute

system_metadata: NotRequired[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.