cayu.memory.evidence

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

CONTEXT_EXPOSURE_VERSION

from cayu.memory import CONTEXT_EXPOSURE_VERSION

CONTEXT_EXPOSURE_VERSION = 'cayu.context_exposure.v1'

Release source · Runtime guarantees · Capability guides

ContextExposure

from cayu.memory import ContextExposure

Durable lifecycle of one exact provider-neutral composition and attempt.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal['cayu.context_exposure.v1']	CONTEXT_EXPOSURE_VERSION
exposure_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
session_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_SESSION_ID_BYTES)
interaction_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
model_step_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
model_attempt_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
provider_attempt_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
provider_name	str	required
model_name	str	required
composition_fingerprint	KeyedEvidenceFingerprint	required
execution_profile_fingerprint	KeyedEvidenceFingerprint	required
context_policy_fingerprint	KeyedEvidenceFingerprint	required
tool_exposure_fingerprint	KeyedEvidenceFingerprint	required
request_contract_fingerprint	KeyedEvidenceFingerprint	required
receipt_ids	tuple[str, ...]	()
contributor_ids	tuple[str, ...]	()
created_at	datetime	required
updated_at	datetime	required
state	ContextExposureState	required
state_revision	StrictInt	Field(ge=0, lt=MAX_CONTEXT_EXPOSURE_TRANSITIONS)
transitions	tuple[ContextExposureTransition, ...]	required

validate_ids (method)

ContextExposure.validate_ids(value: str, info: Any) -> str

validate_execution_unit_ids (method)

ContextExposure.validate_execution_unit_ids(value: str, info: Any) -> str

validate_provider_attempt_id (method)

ContextExposure.validate_provider_attempt_id(value: str) -> str

validate_session_id (method)

ContextExposure.validate_session_id(value: str) -> str

validate_names (method)

ContextExposure.validate_names(value: str, info: Any) -> str

copy_fingerprints (method)

ContextExposure.copy_fingerprints(value: Any) -> KeyedEvidenceFingerprint

validate_fingerprint_domains (method)

ContextExposure.validate_fingerprint_domains() -> Self

copy_receipt_ids (method)

ContextExposure.copy_receipt_ids(value: Any) -> tuple[str, ...]

copy_contributor_ids (method)

ContextExposure.copy_contributor_ids(value: Any) -> tuple[str, ...]

normalize_timestamps (method)

ContextExposure.normalize_timestamps(value: datetime, info: Any) -> datetime

copy_transitions (method)

ContextExposure.copy_transitions(value: Any) -> tuple[ContextExposureTransition, ...]

validate_exposure (method)

ContextExposure.validate_exposure() -> Self

provider_exposure_proven (property)

ContextExposure.provider_exposure_proven() -> bool

Whether acknowledgement/completion evidence proves provider exposure.

Release source · Runtime guarantees · Capability guides

ContextExposureEvidenceKind

from cayu.memory import ContextExposureEvidenceKind

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
COMPOSITION_PLANNED	class attribute	'composition_planned'
REQUEST_PREPARED	class attribute	'request_prepared'
DISPATCH_INTENT_COMMITTED	class attribute	'dispatch_intent_committed'
PROVIDER_ACKNOWLEDGEMENT	class attribute	'provider_acknowledgement'
RECOVERY_ACKNOWLEDGEMENT	class attribute	'recovery_acknowledgement'
PROVIDER_COMPLETION	class attribute	'provider_completion'
RECOVERY_COMPLETION	class attribute	'recovery_completion'
CONCLUSIVE_FAILURE	class attribute	'conclusive_failure'
CONCLUSIVE_CANCELLATION	class attribute	'conclusive_cancellation'
AMBIGUOUS_TRANSPORT	class attribute	'ambiguous_transport'
RECOVERY_INDETERMINATE	class attribute	'recovery_indeterminate'

Release source · Runtime guarantees · Capability guides

ContextExposurePage

from cayu.memory import ContextExposurePage

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
items	tuple[ContextExposure, ...]	required
next_cursor	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_CURSOR_BYTES)
truncated	StrictBool	required

copy_items (method)

ContextExposurePage.copy_items(value: Any) -> tuple[ContextExposure, ...]

validate_next_cursor (method)

ContextExposurePage.validate_next_cursor(value: str | None) -> str | None

validate_page (method)

ContextExposurePage.validate_page() -> Self

Release source · Runtime guarantees · Capability guides

ContextExposureState

from cayu.memory import ContextExposureState

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
PLANNED	class attribute	'planned'
PREPARED	class attribute	'prepared'
DISPATCH_STARTED	class attribute	'dispatch_started'
ACKNOWLEDGED	class attribute	'acknowledged'
COMPLETED	class attribute	'completed'
FAILED	class attribute	'failed'
CANCELLED	class attribute	'cancelled'
INDETERMINATE	class attribute	'indeterminate'

terminal (property)

ContextExposureState.terminal() -> bool

accepts_evidence_kind (method)

ContextExposureState.accepts_evidence_kind(kind: ContextExposureEvidenceKind) -> bool

Return whether one structural evidence kind proves this lifecycle state.

permits_transition_to (method)

ContextExposureState.permits_transition_to(state: ContextExposureState) -> bool

Return whether the lifecycle permits one direct state transition.

Release source · Runtime guarantees · Capability guides

ContextExposureTransition

from cayu.memory import ContextExposureTransition

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
transition_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
revision	StrictInt	Field(ge=0, lt=MAX_CONTEXT_EXPOSURE_TRANSITIONS)
state	ContextExposureState	required
occurred_at	datetime	required
evidence_kind	ContextExposureEvidenceKind	required
evidence_ref	str	Field(max_length=MAX_MEMORY_EVIDENCE_REFERENCE_CHARS)
provider_request_id	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_REFERENCE_CHARS)

validate_transition_id (method)

ContextExposureTransition.validate_transition_id(value: str) -> str

validate_evidence_ref (method)

ContextExposureTransition.validate_evidence_ref(value: str) -> str

validate_optional_provider_request_id (method)

ContextExposureTransition.validate_optional_provider_request_id(value: str | None) -> str | None

normalize_occurred_at (method)

ContextExposureTransition.normalize_occurred_at(value: datetime) -> datetime

validate_evidence_kind (method)

ContextExposureTransition.validate_evidence_kind() -> Self

Release source · Runtime guarantees · Capability guides

ContextExposureTransitionConflict

from cayu.memory import ContextExposureTransitionConflict

A context-exposure transition lost its exact state/revision fence.

Bases: RuntimeError.

init (method)

ContextExposureTransitionConflict.__init__(exposure_id: str, *, expected_state: ContextExposureState, expected_revision: int, actual_state: ContextExposureState, actual_revision: int) -> None

Release source · Runtime guarantees · Capability guides

ContextExposureTransitionRequest

from cayu.memory import ContextExposureTransitionRequest

Compare-and-swap request for one exact, idempotent lifecycle transition.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
transition_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
expected_state	ContextExposureState	required
expected_revision	StrictInt	Field(ge=0, lt=MAX_CONTEXT_EXPOSURE_TRANSITIONS - 1)
state	ContextExposureState	required
occurred_at	datetime	required
evidence_kind	ContextExposureEvidenceKind	required
evidence_ref	str	Field(max_length=MAX_MEMORY_EVIDENCE_REFERENCE_CHARS)
provider_request_id	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_REFERENCE_CHARS)

validate_transition_id (method)

ContextExposureTransitionRequest.validate_transition_id(value: str) -> str

validate_evidence_ref (method)

ContextExposureTransitionRequest.validate_evidence_ref(value: str) -> str

validate_optional_provider_request_id (method)

ContextExposureTransitionRequest.validate_optional_provider_request_id(value: str | None) -> str | None

normalize_occurred_at (method)

ContextExposureTransitionRequest.normalize_occurred_at(value: datetime) -> datetime

validate_requested_transition (method)

ContextExposureTransitionRequest.validate_requested_transition() -> Self

materialize (method)

ContextExposureTransitionRequest.materialize() -> ContextExposureTransition

Release source · Runtime guarantees · Capability guides

keyed_evidence_fingerprint

from cayu.memory import keyed_evidence_fingerprint

Blind an existing exact digest with a domain-separated HMAC key.

keyed_evidence_fingerprint(source_sha256: str, *, domain: KeyedEvidenceFingerprintDomain, key_id: str, key: bytes) -> KeyedEvidenceFingerprint

Release source · Runtime guarantees · Capability guides

KeyedEvidenceFingerprint

from cayu.memory import KeyedEvidenceFingerprint

A domain-separated HMAC fingerprint without the secret key material.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
algorithm	Literal['hmac-sha256']	'hmac-sha256'
domain	KeyedEvidenceFingerprintDomain	required
key_id	str	required
digest	str	required

validate_key_id (method)

KeyedEvidenceFingerprint.validate_key_id(value: str) -> str

validate_digest (method)

KeyedEvidenceFingerprint.validate_digest(value: str) -> str

Release source · Runtime guarantees · Capability guides

KeyedEvidenceFingerprintDomain

from cayu.memory import KeyedEvidenceFingerprintDomain

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
SITUATION	class attribute	'recall_situation'
SOURCE_CONFIGURATION	class attribute	'recall_source_configuration'
ADMISSION_POLICY	class attribute	'recall_admission_policy'
ACCESS_SCOPE	class attribute	'recall_access_scope'
FRONTIER	class attribute	'recall_frontier'
SOURCE_LOCATOR	class attribute	'recall_source_locator'
COMPOSITION	class attribute	'context_composition'
EXECUTION_PROFILE	class attribute	'execution_profile'
CONTEXT_POLICY	class attribute	'context_policy'
TOOL_EXPOSURE	class attribute	'tool_exposure'
REQUEST_CONTRACT	class attribute	'provider_request_contract'

Release source · Runtime guarantees · Capability guides

KnowledgeChunkEvidenceLocator

from cayu.memory import KnowledgeChunkEvidenceLocator

Closed safe locator for one exact chunk of a knowledge revision.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
kind	Literal['knowledge_chunk']	'knowledge_chunk'
entry_id	str	required
entry_revision	StrictInt	Field(ge=1, le=MAX_RECALL_KNOWLEDGE_REVISION)
chunk_id	str	required
chunk_index	StrictInt	Field(ge=0, le=MAX_RECALL_KNOWLEDGE_CHUNK_INDEX)

validate_entry_id (method)

KnowledgeChunkEvidenceLocator.validate_entry_id(value: str) -> str

validate_chunk_id (method)

KnowledgeChunkEvidenceLocator.validate_chunk_id(value: str) -> str

Release source · Runtime guarantees · Capability guides

KnowledgeEntryEvidenceLocator

from cayu.memory import KnowledgeEntryEvidenceLocator

Closed safe locator for one exact knowledge-entry revision.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
kind	Literal['knowledge_entry']	'knowledge_entry'
entry_id	str	required
entry_revision	StrictInt	Field(ge=1, le=MAX_RECALL_KNOWLEDGE_REVISION)

validate_entry_id (method)

KnowledgeEntryEvidenceLocator.validate_entry_id(value: str) -> str

Release source · Runtime guarantees · Capability guides

new_context_exposure_id

from cayu.memory import new_context_exposure_id

new_context_exposure_id() -> str

Release source · Runtime guarantees · Capability guides

new_context_exposure_transition_id

from cayu.memory import new_context_exposure_transition_id

new_context_exposure_transition_id() -> str

Release source · Runtime guarantees · Capability guides

new_provider_attempt_id

from cayu.memory import new_provider_attempt_id

new_provider_attempt_id() -> str

Release source · Runtime guarantees · Capability guides

new_recall_receipt_id

from cayu.memory import new_recall_receipt_id

new_recall_receipt_id() -> str

Release source · Runtime guarantees · Capability guides

OpaqueRecallEvidenceLocator

from cayu.memory import OpaqueRecallEvidenceLocator

Safe exact binding for a custom source locator without retaining its payload.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
kind	Literal['opaque']	'opaque'
fingerprint	KeyedEvidenceFingerprint	required

copy_fingerprint (method)

OpaqueRecallEvidenceLocator.copy_fingerprint(value: Any) -> KeyedEvidenceFingerprint

validate_fingerprint_domain (method)

OpaqueRecallEvidenceLocator.validate_fingerprint_domain() -> Self

Release source · Runtime guarantees · Capability guides

RECALL_ITEM_EXPOSURE_VERSION

from cayu.memory import RECALL_ITEM_EXPOSURE_VERSION

RECALL_ITEM_EXPOSURE_VERSION = 'cayu.recall_item_exposure.v1'

Release source · Runtime guarantees · Capability guides

RECALL_RECEIPT_VERSION

from cayu.memory import RECALL_RECEIPT_VERSION

RECALL_RECEIPT_VERSION = 'cayu.recall_receipt.v1'

Release source · Runtime guarantees · Capability guides

RecallEvidenceConflict

from cayu.memory import RecallEvidenceConflict

An immutable recall-evidence identity was reused with different material.

Bases: RuntimeError.

init (method)

RecallEvidenceConflict.__init__(record_type: str, record_id: str) -> None

Release source · Runtime guarantees · Capability guides

RecallEvidenceLocator

from cayu.memory import RecallEvidenceLocator

RecallEvidenceLocator = Annotated[KnowledgeEntryEvidenceLocator | KnowledgeChunkEvidenceLocator | TranscriptMessageEvidenceLocator | OpaqueRecallEvidenceLocator, Field(discriminator='kind')]

Release source · Runtime guarantees · Capability guides

RecallEvidenceQuery

from cayu.memory import RecallEvidenceQuery

Explicit session-scoped keyset query for bounded receipt/exposure pages.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
session_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_SESSION_ID_BYTES)
interaction_id	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
model_step_id	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
limit	StrictInt	Field(default=50, ge=1, le=MAX_MEMORY_EVIDENCE_PAGE_LIMIT)
max_bytes	StrictInt	Field(default=1000000, ge=MIN_MEMORY_EVIDENCE_PAGE_BYTES, le=MAX_MEMORY_EVIDENCE_PAGE_BYTES)
cursor	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_CURSOR_BYTES)

validate_session_id (method)

RecallEvidenceQuery.validate_session_id(value: str) -> str

validate_optional_ids (method)

RecallEvidenceQuery.validate_optional_ids(value: str | None, info: Any) -> str | None

validate_optional_model_step_id (method)

RecallEvidenceQuery.validate_optional_model_step_id(value: str | None) -> str | None

fingerprint (method)

RecallEvidenceQuery.fingerprint(record_kind: Literal['receipt', 'exposure']) -> str

Release source · Runtime guarantees · Capability guides

RecallItemAdmission

from cayu.memory import RecallItemAdmission

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
ADMITTED	class attribute	'admitted'
OFFERED	class attribute	'offered'

matches_selection_reason (method)

RecallItemAdmission.matches_selection_reason(reason: RecallItemSelectionReason) -> bool

Return whether a selection reason proves this admission outcome.

Release source · Runtime guarantees · Capability guides

RecallItemExposure

from cayu.memory import RecallItemExposure

One exact recalled representation included in a context exposure plan.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal['cayu.recall_item_exposure.v1']	RECALL_ITEM_EXPOSURE_VERSION
exposure_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
receipt_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
ordinal	StrictInt	Field(ge=0, lt=MAX_RECALL_RECEIPT_ITEMS)
receipt_item_ordinal	StrictInt	Field(ge=0, lt=MAX_RECALL_RECEIPT_ITEMS)
identity	RetrievalCandidateIdentity	required
representation_id	str	required
content_sha256	str	required
provider_representation_sha256	str | None	None
locator	RecallEvidenceLocator	required
admission	RecallItemAdmission	required
selection_reason	RecallItemSelectionReason	required

validate_provider_representation_sha256 (method)

RecallItemExposure.validate_provider_representation_sha256(value: str | None) -> str | None

validate_ids (method)

RecallItemExposure.validate_ids(value: str, info: Any) -> str

copy_identity (method)

RecallItemExposure.copy_identity(value: Any) -> RetrievalCandidateIdentity

validate_representation_id (method)

RecallItemExposure.validate_representation_id(value: str) -> str

validate_content_sha256 (method)

RecallItemExposure.validate_content_sha256(value: str) -> str

copy_locator (method)

RecallItemExposure.copy_locator(value: Any) -> Any

validate_locator (method)

RecallItemExposure.validate_locator(value: RecallEvidenceLocator) -> RecallEvidenceLocator

validate_document_size (method)

RecallItemExposure.validate_document_size() -> Self

Release source · Runtime guarantees · Capability guides

RecallItemSelectionReason

from cayu.memory import RecallItemSelectionReason

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
CALIBRATED_STRONG_MATCH	class attribute	'calibrated_strong_match'
CALIBRATED_PLAUSIBLE_MATCH	class attribute	'calibrated_plausible_match'
DUPLICATE_STRONG_REFERENCE	class attribute	'duplicate_strong_reference'
STRONG_MATCH_NOT_FOCUSED	class attribute	'strong_match_not_focused'
STRONG_MATCH_OFFERED_BY_MODE	class attribute	'strong_match_offered_by_mode'
EXPLICIT_APPLICATION_SELECTION	class attribute	'explicit_application_selection'
NEWLY_RELEVANT	class attribute	'newly_relevant'
REANCHORED_CURRENT_REVISION	class attribute	'reanchored_current_revision'

Release source · Runtime guarantees · Capability guides

RecallReceipt

from cayu.memory import RecallReceipt

Immutable bounded proof of one already-computed recall/admission operation.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
schema_version	Literal['cayu.recall_receipt.v1']	RECALL_RECEIPT_VERSION
receipt_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
session_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_SESSION_ID_BYTES)
interaction_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
model_step_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
created_at	datetime	required
situation_fingerprint	KeyedEvidenceFingerprint	required
engine_version	str	required
query_resolution	RecallQueryResolutionEvidence | None	None
candidate_decisions	tuple[RecallCandidateDecision, ...]	Field(default=(), max_length=100)
source_configuration_fingerprint	KeyedEvidenceFingerprint	required
admission_policy_fingerprint	KeyedEvidenceFingerprint	required
access_scope_fingerprint	KeyedEvidenceFingerprint	required
frontier_fingerprint	KeyedEvidenceFingerprint	required
sources	tuple[RecallSourceCoverage, ...]	required
inspected_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
eligible_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
admitted_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
offered_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
silent_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
omitted_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
truncated	StrictBool	required
items	tuple[RecallReceiptItem, ...]	required

validate_ids (method)

RecallReceipt.validate_ids(value: str, info: Any) -> str

validate_model_step_id (method)

RecallReceipt.validate_model_step_id(value: str) -> str

validate_session_id (method)

RecallReceipt.validate_session_id(value: str) -> str

normalize_created_at (method)

RecallReceipt.normalize_created_at(value: datetime) -> datetime

copy_fingerprints (method)

RecallReceipt.copy_fingerprints(value: Any) -> KeyedEvidenceFingerprint

validate_fingerprint_domains (method)

RecallReceipt.validate_fingerprint_domains() -> Self

validate_names (method)

RecallReceipt.validate_names(value: str, info: Any) -> str

copy_sources (method)

RecallReceipt.copy_sources(value: Any) -> tuple[RecallSourceCoverage, ...]

copy_items (method)

RecallReceipt.copy_items(value: Any) -> tuple[RecallReceiptItem, ...]

validate_receipt (method)

RecallReceipt.validate_receipt() -> Self

Release source · Runtime guarantees · Capability guides

RecallReceiptItem

from cayu.memory import RecallReceiptItem

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
ordinal	StrictInt	Field(ge=0, lt=MAX_RECALL_RECEIPT_ITEMS)
identity	RetrievalCandidateIdentity	required
representation_id	str	required
content_sha256	str	required
locator	RecallEvidenceLocator	required
admission	RecallItemAdmission	required
selection_reason	RecallItemSelectionReason	required
fused_rank	StrictInt	Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
match_channels	tuple[str, ...]	required

copy_identity (method)

RecallReceiptItem.copy_identity(value: Any) -> RetrievalCandidateIdentity

validate_representation_id (method)

RecallReceiptItem.validate_representation_id(value: str) -> str

validate_content_sha256 (method)

RecallReceiptItem.validate_content_sha256(value: str) -> str

copy_locator (method)

RecallReceiptItem.copy_locator(value: Any) -> Any

validate_locator (method)

RecallReceiptItem.validate_locator(value: RecallEvidenceLocator) -> RecallEvidenceLocator

copy_match_channels (method)

RecallReceiptItem.copy_match_channels(value: Any) -> tuple[str, ...]

validate_admission_reason (method)

RecallReceiptItem.validate_admission_reason() -> Self

Release source · Runtime guarantees · Capability guides

RecallReceiptPage

from cayu.memory import RecallReceiptPage

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
items	tuple[RecallReceipt, ...]	required
next_cursor	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_CURSOR_BYTES)
truncated	StrictBool	required

copy_items (method)

RecallReceiptPage.copy_items(value: Any) -> tuple[RecallReceipt, ...]

validate_next_cursor (method)

RecallReceiptPage.validate_next_cursor(value: str | None) -> str | None

validate_page (method)

RecallReceiptPage.validate_page() -> Self

Release source · Runtime guarantees · Capability guides

RecallSourceCoverage

from cayu.memory import RecallSourceCoverage

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
source	str	required
required	StrictBool	required
channels	tuple[str, ...]	required
state	RecallSourceCoverageState	required
failure_code	str | None	None
inspected_count	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
candidate_limit	StrictInt	Field(ge=1, le=MAX_DURABLE_JSON_INTEGER)
truncated	StrictBool	False
continuation_available	StrictBool	False

validate_source (method)

RecallSourceCoverage.validate_source(value: str) -> str

copy_channels (method)

RecallSourceCoverage.copy_channels(value: Any) -> tuple[str, ...]

validate_failure_code (method)

RecallSourceCoverage.validate_failure_code(value: str | None) -> str | None

validate_coverage (method)

RecallSourceCoverage.validate_coverage() -> Self

Release source · Runtime guarantees · Capability guides

RecallSourceCoverageState

from cayu.memory import RecallSourceCoverageState

Bases: StrEnum.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
COMPLETE	class attribute	'complete'
PARTIAL	class attribute	'partial'
UNAVAILABLE	class attribute	'unavailable'
FAILED	class attribute	'failed'

Release source · Runtime guarantees · Capability guides

TranscriptMessageEvidenceLocator

from cayu.memory import TranscriptMessageEvidenceLocator

Closed safe locator for the exact indexed text parts of one message.

Bases: BaseModel.

Fields and attributes

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name	Type	Default
kind	Literal['transcript_message']	'transcript_message'
session_id	str	Field(max_length=MAX_MEMORY_EVIDENCE_SESSION_ID_BYTES)
interaction_id	str | None	Field(default=None, max_length=MAX_MEMORY_EVIDENCE_ID_CHARS)
transcript_index	StrictInt	Field(ge=0, le=MAX_DURABLE_JSON_INTEGER)
text_part_indexes	tuple[StrictInt, ...]	required

validate_session_id (method)

TranscriptMessageEvidenceLocator.validate_session_id(value: str) -> str

validate_interaction_id (method)

TranscriptMessageEvidenceLocator.validate_interaction_id(value: str | None) -> str | None

validate_text_part_indexes (method)

TranscriptMessageEvidenceLocator.validate_text_part_indexes(value: Any) -> tuple[int, ...]

Release source · Runtime guarantees · Capability guides