cayu.runtime.recall_sources

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.

AutomaticRecallSourceContext

from cayu import AutomaticRecallSourceContext

Read-only construction scope; not a mutable model/transcript request.

Store handles remain trusted application capabilities. The factory must not widen the supplied access scope or mutate those stores.

Decorators: @dataclass(frozen=True, kw_only=True).

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	required
interaction_id	str | None	required
environment_name	str | None	required
knowledge_namespace	str	required
knowledge_access_scope	KnowledgeAccessScope | None	required
knowledge_store	Any	required
session_store	Any	required

Release source · Runtime guarantees · Capability guides

AutomaticRecallSourceDescriptor

from cayu import AutomaticRecallSourceDescriptor

Durable identity and declared lanes of a trusted read-only extension.

The application must change configuration_version whenever source behavior or access configuration changes. Credentials and callable identities do not belong in this descriptor, which is persisted in recall evidence.

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
name	str	required
channel_names	tuple[str, ...]	required
configuration_version	str	required
required	bool	True
candidate_limit	int	20
continuation_channels	tuple[str, ...]	()

validate_name (method)

AutomaticRecallSourceDescriptor.validate_name(value: Any, info) -> str

validate_channels (method)

AutomaticRecallSourceDescriptor.validate_channels(value: Any, info) -> tuple[str, ...]

validate_required (method)

AutomaticRecallSourceDescriptor.validate_required(value: Any) -> bool

validate_limit (method)

AutomaticRecallSourceDescriptor.validate_limit(value: Any) -> int

validate_membership (method)

AutomaticRecallSourceDescriptor.validate_membership() -> AutomaticRecallSourceDescriptor

Release source · Runtime guarantees · Capability guides

AutomaticRecallSourceRegistration

from cayu import AutomaticRecallSourceRegistration

Construct a request-scoped source inside RecallEngine’s work deadline.

Factories and sources are trusted application code, not sandboxed plugins. They must cooperate with cancellation, avoid blocking the event loop, honor the request/situation access scope, and own any resources they acquire. Factories must not perform mutations or allocate resources requiring cleanup after retrieve returns. The runtime owns receipts and delivery evidence.

Decorators: @dataclass(frozen=True, kw_only=True).

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
descriptor	AutomaticRecallSourceDescriptor	required
factory	Callable[[AutomaticRecallSourceContext], Awaitable[RecallSource]]	required

Release source · Runtime guarantees · Capability guides