cayu.evals.recall_baseline

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.

`load_recall_baseline_corpus`

from cayu.evals import load_recall_baseline_corpus

load_recall_baseline_corpus(path: str | Path) -> RecallBaselineCorpus

Release source · Runtime guarantees · Capability guides

`RECALL_BASELINE_CORPUS_SCHEMA_VERSION`

from cayu.evals import RECALL_BASELINE_CORPUS_SCHEMA_VERSION

RECALL_BASELINE_CORPUS_SCHEMA_VERSION = 'cayu.recall_baseline_corpus.v2'

Release source · Runtime guarantees · Capability guides

`RECALL_BASELINE_RESULT_SCHEMA_VERSION`

from cayu.evals import RECALL_BASELINE_RESULT_SCHEMA_VERSION

RECALL_BASELINE_RESULT_SCHEMA_VERSION = 'cayu.recall_baseline_result.v2'

Release source · Runtime guarantees · Capability guides

`RecallBaselineCase`

from cayu.evals import RecallBaselineCase

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
`id`	`str`	`required`
`language`	`str`	`required`
`query`	`str`	`required`
`recent_conversation`	`tuple[str, ...]`	`()`
`work_context`	`str \| None`	`None`
`namespace`	`str`	`required`
`access`	`MemoryRetrievalAccessSpec`	`required`
`transcript_session_ids`	`tuple[str, ...]`	`()`
`relevant`	`tuple[RecallBaselineExpectedIdentity, ...]`	`required`
`forbidden`	`tuple[RecallBaselineExpectedIdentity, ...]`	`()`
`expect_partial_coverage`	`bool`	`True`
`cutoff`	`int`	`5`
`transcript_max_bytes`	`int`	`64000`
`transcript_max_records_scanned`	`int`	`10000`
`admission_max_injected_items`	`int`	`5`

validate_identity (method)

RecallBaselineCase.validate_identity(value: str, info) -> str

validate_query (method)

RecallBaselineCase.validate_query(value: str) -> str

validate_work_context (method)

RecallBaselineCase.validate_work_context(value: str | None) -> str | None

validate_cutoff (method)

RecallBaselineCase.validate_cutoff(value) -> int

validate_admission_max_injected_items (method)

RecallBaselineCase.validate_admission_max_injected_items(value) -> int

validate_transcript_bound (method)

RecallBaselineCase.validate_transcript_bound(value, info) -> int

validate_expectations (method)

RecallBaselineCase.validate_expectations() -> RecallBaselineCase

Release source · Runtime guarantees · Capability guides

`RecallBaselineCaseResult`

from cayu.evals import RecallBaselineCaseResult

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`case_id`	`str`	`required`
`language`	`str`	`required`
`selected_identities`	`tuple[str, ...]`	`required`
`candidate_count`	`int`	`required`
`recall_at_k`	`float`	`required`
`false_result_count`	`int`	`required`
`stale_knowledge_count`	`int`	`required`
`authorization_leak_count`	`int`	`required`
`locator_correct_count`	`int`	`required`
`locator_evaluated_count`	`int`	`required`
`partial_source_count`	`int`	`required`
`source_statuses`	`dict[str, RecallSourceStatus]`	`required`
`source_failure_codes`	`dict[str, str \| None]`	`required`
`channel_index_versions`	`dict[str, str]`	`required`
`continuation_channels`	`tuple[str, ...]`	`required`
`false_complete`	`bool`	`required`
`truncated`	`bool`	`required`
`result_bytes`	`int`	`required`
`latency_ms`	`float`	`required`
`injected_identities`	`tuple[str, ...]`	`required`
`offered_identities`	`tuple[str, ...]`	`required`
`silent_identities`	`tuple[str, ...]`	`required`
`correct_injected_count`	`int`	`required`
`correct_offered_count`	`int`	`required`
`correct_silent_count`	`int`	`required`
`false_injection_count`	`int`	`required`
`stale_injection_count`	`int`	`required`
`unauthorized_injection_count`	`int`	`required`
`injected_source_diversity`	`int`	`required`
`contribution_bytes`	`int`	`required`
`estimated_contribution_tokens`	`int`	`required`
`admission_truncated`	`bool`	`required`
`admission_latency_ms`	`float`	`required`

Release source · Runtime guarantees · Capability guides

`RecallBaselineCorpus`

from cayu.evals import RecallBaselineCorpus

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal['cayu.recall_baseline_corpus.v2']`	`required`
`corpus_revision`	`str`	`required`
`origin`	`Literal['hermetic_public', 'external_private']`	`required`
`knowledge`	`tuple[RecallBaselineKnowledgeEntry, ...]`	`required`
`transcripts`	`tuple[RecallBaselineTranscript, ...]`	`required`
`cases`	`tuple[RecallBaselineCase, ...]`	`required`

validate_corpus_revision (method)

RecallBaselineCorpus.validate_corpus_revision(value: str) -> str

validate_corpus (method)

RecallBaselineCorpus.validate_corpus() -> RecallBaselineCorpus

Release source · Runtime guarantees · Capability guides

`RecallBaselineExpectedIdentity`

from cayu.evals import RecallBaselineExpectedIdentity

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`record_type`	`Literal['knowledge_chunk', 'knowledge_entry', 'transcript_message']`	`required`
`record_id`	`str`	`required`
`revision`	`str \| None`	`None`
`locator`	`dict[str, Any]`	`Field(default_factory=dict)`
`expected_disposition`	`Literal['inject', 'offer', 'silent'] \| None`	`None`

validate_record_id (method)

RecallBaselineExpectedIdentity.validate_record_id(value: str) -> str

validate_revision (method)

RecallBaselineExpectedIdentity.validate_revision(value: str | None) -> str | None

copy_locator (method)

RecallBaselineExpectedIdentity.copy_locator(value) -> dict[str, Any]

validate_locator (method)

RecallBaselineExpectedIdentity.validate_locator() -> RecallBaselineExpectedIdentity

Release source · Runtime guarantees · Capability guides

`RecallBaselineKnowledgeEntry`

from cayu.evals import RecallBaselineKnowledgeEntry

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`id`	`str`	`required`
`revisions`	`tuple[str, ...]`	`required`
`namespace`	`str`	`required`
`labels`	`dict[str, str]`	`Field(default_factory=dict)`

validate_identity (method)

RecallBaselineKnowledgeEntry.validate_identity(value: str, info) -> str

validate_revisions (method)

RecallBaselineKnowledgeEntry.validate_revisions(value: tuple[str, ...]) -> tuple[str, ...]

copy_labels (method)

RecallBaselineKnowledgeEntry.copy_labels(value) -> dict[str, str]

Release source · Runtime guarantees · Capability guides

`RecallBaselineMetrics`

from cayu.evals import RecallBaselineMetrics

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`case_count`	`int`	`required`
`recall_at_k`	`float`	`required`
`false_result_rate`	`float`	`required`
`stale_knowledge_rate`	`float`	`required`
`authorization_leak_rate`	`float`	`required`
`locator_correctness`	`float`	`required`
`false_complete_rate`	`float`	`required`
`truncated_case_count`	`int`	`required`
`partial_source_count`	`int`	`required`
`total_candidate_count`	`int`	`required`
`mean_candidate_count`	`float`	`required`
`result_bytes`	`int`	`required`
`estimated_result_tokens`	`int`	`required`
`latency_p50_ms`	`float`	`required`
`latency_p95_ms`	`float`	`required`
`injected_precision`	`float`	`required`
`offer_precision`	`float`	`required`
`silent_precision`	`float`	`required`
`false_injection_rate`	`float`	`required`
`stale_injection_rate`	`float`	`required`
`unauthorized_injection_rate`	`float`	`required`
`mean_injected_source_diversity`	`float`	`required`
`contribution_bytes`	`int`	`required`
`estimated_contribution_tokens`	`int`	`required`
`admission_truncated_case_count`	`int`	`required`
`admission_latency_p50_ms`	`float`	`required`
`admission_latency_p95_ms`	`float`	`required`
`required_source_failure_closed`	`bool`	`required`

Release source · Runtime guarantees · Capability guides

`RecallBaselineResult`

from cayu.evals import RecallBaselineResult

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`schema_version`	`Literal['cayu.recall_baseline_result.v2']`	`required`
`corpus_revision`	`str`	`required`
`corpus_origin`	`Literal['hermetic_public', 'external_private']`	`required`
`backend`	`str`	`required`
`configuration`	`dict[str, Any]`	`required`
`metrics`	`RecallBaselineMetrics`	`required`
`cases`	`tuple[RecallBaselineCaseResult, ...]`	`required`

validate_backend (method)

RecallBaselineResult.validate_backend(value: str) -> str

copy_configuration (method)

RecallBaselineResult.copy_configuration(value) -> dict[str, Any]

Release source · Runtime guarantees · Capability guides

`RecallBaselineTranscript`

from cayu.evals import RecallBaselineTranscript

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`session_id`	`str`	`required`
`messages`	`tuple[RecallBaselineTranscriptMessage, ...]`	`required`

validate_session_id (method)

RecallBaselineTranscript.validate_session_id(value: str) -> str

validate_messages (method)

RecallBaselineTranscript.validate_messages(value: tuple[RecallBaselineTranscriptMessage, ...]) -> tuple[RecallBaselineTranscriptMessage, ...]

Release source · Runtime guarantees · Capability guides

`RecallBaselineTranscriptMessage`

from cayu.evals import RecallBaselineTranscriptMessage

Bases: BaseModel.

Fields and attributes

Name	Type	Default
`interaction_id`	`str`	`required`
`role`	`MessageRole`	`required`
`text`	`str`	`required`

validate_interaction_id (method)

RecallBaselineTranscriptMessage.validate_interaction_id(value: str) -> str

validate_role (method)

RecallBaselineTranscriptMessage.validate_role(value: MessageRole) -> MessageRole

validate_text (method)

RecallBaselineTranscriptMessage.validate_text(value: str) -> str

Release source · Runtime guarantees · Capability guides

`run_recall_baseline`

from cayu.evals import run_recall_baseline

Seed empty built-in stores and measure deterministic cross-source recall.

async run_recall_baseline(corpus: RecallBaselineCorpus, knowledge_store: KnowledgeStore, session_store: SessionStore, *, backend: str, configuration: dict[str, Any] | None=None) -> RecallBaselineResult

Release source · Runtime guarantees · Capability guides