Expand description
§Converge Kernel
This crate is the curated in-process execution API for Converge.
Consumers embed the kernel here; they author packs in converge-pack
and use converge-model for shared semantic types.
Modules§
- admission
- External observation admission API.
- formation
- Grouped offering API for self-assembling formations.
Structs§
- Admission
Actor - Required actor metadata for an admission request.
- Admission
Content - Validated observation payload for admission.
- Admission
Receipt - Receipt returned after staging an admitted observation.
- Admission
Request - Request to admit an external observation into the Converge truth pipeline.
- Admission
Source - Validated source label for admission provenance.
- Agent
Effect - The output of a suggestor’s
execute()call. - Approval
Point Id - Identifier for an approval point or workflow reference.
- Artifact
Id - Unique identifier for a derived artifact.
- Backend
Id - Identifier for a backend, provider, or adapter.
- Budget
- Budget limits for execution.
- Candidate
Provenance - Provenance information for a recall candidate.
- ChainId
- Identifier for a convergence chain or run.
- Constraint
Name - Consumer-owned name for a constraint.
- Constraint
Value - Consumer-owned value for a constraint.
- Context
Fact - Read-only projection of a validated assertion in the context.
- Context
Item - A key-value pair of context data for human review.
- Context
Snapshot - Durable, verified context snapshot for storage adapters.
- Context
State - The shared context for a Converge job.
- Converge
Result - Result of a converged execution.
- Correlation
Id - Identifier for correlating related events or runs.
- Criterion
- Success criterion for a frame.
- Criterion
Id - Identifier for a success criterion.
- Criterion
Outcome - Evaluated outcome for a specific criterion.
- Engine
- The Converge execution engine.
- Engine
Hitl Policy - Engine-level HITL policy for gating proposals.
- EventId
- Identifier for an experience event envelope.
- Event
Query - Query for experience events.
- Experience
Event Envelope - Append-only event envelope.
- Fact
Content - Content of a promoted fact.
- Flow
Gate Context - Decision-relevant facts projected from the flow state.
- Flow
Gate Input - Canonical input to an authorization decision for a flow gate.
- Flow
Gate Principal - Principal facts projected from the flow host or application runtime.
- Flow
Gate Resource - Resource facts projected from the current flow state.
- Gate
Decision - Human’s decision on a HITL gate request.
- Gate
Event - Audit trail entry for HITL gate events.
- Gate
Request - Request for human approval, emitted when convergence pauses at a HITL gate.
- Hitl
Pause - State returned when convergence pauses at a HITL gate.
- Hitl
Policy - Policy controlling when HITL approval is required.
- Integrity
Proof - Cryptographic integrity proof for a converged context.
- Lamport
Clock - A Lamport logical clock for causal ordering of events.
- Lifecycle
Event - Record of a lifecycle state change.
- Local
Replay Trace - Local trace link — replay-eligible.
- Merkle
Root - A Merkle tree root hash representing the integrity of a set of facts.
- PackId
- Identifier for a named pack.
- Proposed
Fact - An unvalidated suggestion from a non-authoritative source.
- Provider
Assignment Payload - Typed fact payload for provider selection assignments.
- Provider
Request Payload - Typed fact payload for provider selection requests.
- Provider
Selection Suggestor - Routes required capabilities to available backends via bipartite matching.
- Recall
Candidate - A candidate returned by recall.
- Recall
Policy - Policy controlling recall behavior.
- Recall
Query - A query for semantic recall.
- Remote
Replay Trace - Remote trace link — audit-eligible only.
- Suggestor
Id - Unique identifier for a registered suggestor.
- Tenant
Id - Identifier for a tenant scope.
- Text
Payload - Human-readable text payload. This is explicit text, not a generic semantic escape hatch.
- Timeout
Policy - What happens when the human doesn’t respond in time.
- Trace
Link Id - Identifier for a stored replay trace link.
- TruthId
- Identifier for a truth definition.
- Types
Budgets - Execution budgets.
- Types
Intent Id - Unique identifier for an Intent.
- Types
Root Intent - Root Intent using builder pattern.
- Types
RunHooks - Per-run hooks for typed intent execution.
- Unit
Interval - A finite value in the inclusive
[0.0, 1.0]range. - User
Experience Event Envelope - Envelope for a
UserExperienceEvent— mirrorsExperienceEventEnvelopefor the user-side ledger. - Validation
Error - Error when a
ProposedFactfails validation.
Enums§
- Admission
Actor Kind - Actor class for an externally admitted observation.
- Admission
Error - Error raised while constructing an admission request.
- Artifact
Kind - Kind of governed artifact.
- Authority
Level - Authority level granted to a flow-gate principal.
- Boundary
Kind - Primitive boundary a human adjusted.
- Boundary
Target - Scope for a boundary adjustment.
- Budget
Resource - Budget dimension that was exhausted.
- Candidate
Source Type - Source type for a recall candidate.
- Context
Key - Typed keys for the shared context namespace.
- Converge
Error - Top-level error type for Converge operations.
- Correction
Target - What a user correction applies to.
- Criterion
Result - Machine-evaluable outcome for a single criterion.
- Decision
Step - A step in the multi-phase reasoning process.
- Experience
Event - Append-only experience event payloads.
- Experience
Event Kind - High-level event kinds for query filtering.
- Experience
Record - Unified query result spanning both ledger sides.
- Experience
Store Error - Experience store error type.
- Fact
Content Kind - Kind of fact content.
- Flow
Action - Action being attempted against a converging flow.
- Flow
Gate Outcome - Neutral outcome of a flow gate authorization decision.
- Flow
Phase - Current phase of a converging flow.
- Gate
Event Kind - Kind of gate event for audit trail.
- Gate
Verdict - The actual approve/reject verdict.
- Invariant
Class - The class of an invariant determines when it’s checked and how violations are handled.
- Invariant
Result - The result of checking an invariant.
- Override
Target - What a user override applies to.
- Recall
Use - Purpose of a recall operation.
- Relevance
Level - Relevance level for a recall candidate.
- Replay
Trace - Trace link for audit and (possibly) replay.
- RunResult
- Result of running the engine — either converged or paused at HITL gate.
- Stop
Reason - Why execution stopped. Exhaustive enumeration for audit trails.
- Timeout
Action - Action taken when HITL gate times out.
- Types
Intent Kind - Kind of intent (what problem class).
- User
Experience Event - User-side experience event.
Traits§
- Context
- Read-only view of the shared context.
- Criterion
Evaluator - Application-provided boundary for evaluating success criteria.
- Experience
Event Observer - Run-scoped observer for experience events emitted during convergence.
- Experience
Store - Experience store trait (append-only ledger boundary).
- Fact
Payload - Typed payload carried by proposed and promoted facts.
- Flow
Gate Authorizer - Deterministic decision provider for consequential flow actions.
- Invariant
- A runtime invariant that the engine enforces.
- Provenance
Source - Stable, audit-friendly identifier for an extension that emits facts into the convergence loop.
- Streaming
Callback - Callback trait for streaming fact emissions during convergence.
- Suggestor
- The core suggestor contract.
Functions§
- recall_
from_ store - Pull recall candidates from an
ExperienceStore.
Type Aliases§
- Experience
Store Result - Result type for experience store operations.