Neumera SDK reference
Programmatic SDK index generated from neumera_self_aware.__all__.
The hosted API is the primary public integration route today. SDK/package-level integration is available for advanced approved contexts.
Exported SDK surface
| Symbol | Kind | Call shape | Module | Description |
|---|---|---|---|---|
AgentSession | class | AgentSession(runtime: 'SingleEntityCRRuntime', goal_id: 'str', target_condition: 'str', _history: 'list[dict[str, object]]' = <factory>) -> None | neumera_self_aware.agent | AgentSession(runtime: 'SingleEntityCRRuntime', goal_id: 'str', target_condition: 'str', _history: 'list[dict[str, object]]' = <factory>) |
CanonicalPlatformAPI | class | CanonicalPlatformAPI(runtime: 'SingleEntityCRRuntime | None' = None, *, external_events_db_path: 'str' = './data/external_events.db', external_actions_db_path: 'str' = './data/external_actions.db') -> 'None' | neumera_self_aware._platform_api.core | Canonical SDK/API access layer for `SingleEntityCRRuntime`. |
ExternalActionRequest | class | ExternalActionRequest(action_type: 'str', target_handle: 'str | None' = None, payload: 'dict[str, Any]' = <factory>, expected_effect: 'dict[str, Any]' = <factory>, source: 'str' = 'sdk') -> None | neumera_self_aware._platform_api.core | Typed world action request for external callers. |
LifecycleState | class | LifecycleState(/, *args, **kwargs) | neumera_self_aware.continuous_ops | An enumeration. |
MembraneAPI | class | MembraneAPI(*, config: 'MembraneConfig | None' = None) -> 'None' | neumera_self_aware.membrane.api | No inline docstring is available for this symbol. |
MembraneConfig | class | MembraneConfig(default_model: 'str' = 'gpt-5-mini', upgraded_model: 'str' = 'gpt-5', adapter_id: 'str' = 'openai.responses', enable_model: 'bool' = False) -> None | neumera_self_aware.membrane.config | MembraneConfig(default_model: 'str' = 'gpt-5-mini', upgraded_model: 'str' = 'gpt-5', adapter_id: 'str' = 'openai.responses', enable_model: 'bool' = False) |
MultiEntityRuntime | class | MultiEntityRuntime() -> 'None' | neumera_self_aware.multi_entity | No inline docstring is available for this symbol. |
NaturalLanguageMembrane | class | NaturalLanguageMembrane(config: 'MembraneConfig | None' = None, adapter: 'ResponseAdapter | None' = None) -> 'None' | neumera_self_aware.membrane.translation | No inline docstring is available for this symbol. |
OpenAIResponsesAdapter | class | OpenAIResponsesAdapter(adapter_id: 'str' = 'openai.responses') -> None | neumera_self_aware.membrane.openai_adapter | Replaceable OpenAI Responses API adapter. |
PersistentAssistant | class | PersistentAssistant(runtime: 'SingleEntityCRRuntime', assistant_id: 'str' = 'assistant:single-entity-cr', assistant_identity_handle: 'str' = '', continuity_state: 'str' = 'uninitialized', assistant_role_state: 'str' = 'structured_runtime_assistant', active_commitments: 'dict[str, AssistantCommitment]' = <factory>, task_threads: 'dict[str, AssistantTaskThread]' = <factory>, assistant_integrity_state: 'str' = 'nominal', active_session_id: 'str | None' = None, continuity_report: 'dict[str, object]' = <factory>) -> None | neumera_self_aware.assistant | PersistentAssistant(runtime: 'SingleEntityCRRuntime', assistant_id: 'str' = 'assistant:single-entity-cr', assistant_identity_handle: 'str' = '', continuity_state: 'str' = 'uninitialized', assistant_role_state: 'str' = 'structured_runtime_assistant', active_commitments: 'dict[str, AssistantCommitment]' = <factory>, task_threads: 'dict[str, AssistantTaskThread]' = <factory>, assistant_integrity_state: 'str' = 'nominal', active_session_id: 'str | None' = None, continuity_report: 'dict[str, object]' = <factory>) |
RepairSession | class | RepairSession(runtime: 'SingleEntityCRRuntime', repair_key: 'str', started: 'bool' = False) -> None | neumera_self_aware.repair | RepairSession(runtime: 'SingleEntityCRRuntime', repair_key: 'str', started: 'bool' = False) |
RuntimeConfig | class | RuntimeConfig(thresholds: 'GuardThresholds', deterministic_seed: 'int' = 7, schedule: 'str' = 'single', projection: 'str' = 'default', coupling: 'str' = 'none', replay_mode: 'str' = 'strict', strict_symbolic_mode: 'bool' = True) -> None | neumera_self_aware.config | RuntimeConfig(thresholds: 'GuardThresholds', deterministic_seed: 'int' = 7, schedule: 'str' = 'single', projection: 'str' = 'default', coupling: 'str' = 'none', replay_mode: 'str' = 'strict', strict_symbolic_mode: 'bool' = True) |
RuntimeLifecycleManager | class | RuntimeLifecycleManager(runtime: 'SingleEntityCRRuntime | None' = None) -> 'None' | neumera_self_aware.continuous_ops | Phase 16 operations envelope for continuous runtime control. |
SDKResult | class | SDKResult(ok: 'bool', category: 'str', operation: 'str', payload: 'dict[str, Any]' = <factory>, uncertainty: 'dict[str, Any]' = <factory>) -> None | neumera_self_aware._platform_api.core | Stable result envelope returned by canonical SDK calls. |
SingleEntityCRRuntime | class | SingleEntityCRRuntime(substrate_profile: 'SubstrateProfile | None' = None) -> 'None' | neumera_self_aware.canonical | No inline docstring is available for this symbol. |
SubstrateCompiler | class | SubstrateCompiler(/, *args, **kwargs) | neumera_self_aware.substrates.compiler | No inline docstring is available for this symbol. |
SubstrateEnvironmentBuilder | class | SubstrateEnvironmentBuilder(*, environment_id: 'str', world_name: 'str', version: 'str' = '20a') -> 'None' | neumera_self_aware.substrates.builders | No inline docstring is available for this symbol. |
SubstrateEnvironmentSpec | class | SubstrateEnvironmentSpec(environment_id: 'str', world_name: 'str', version: 'str' = '20a', description: 'str' = '', top_shell_id: 'str | None' = None, shells: 'list[ShellSpec]' = <factory>, guards: 'list[GuardSpec]' = <factory>, cadence: 'list[CadenceSpec]' = <factory>, channels: 'list[ChannelSpec]' = <factory>, perturbations: 'list[PerturbationSpec]' = <factory>, populations: 'list[PopulationSpec]' = <factory>, mind_seeds: 'list[MindSeedSpec]' = <factory>, memory_registries: 'list[MemoryRegistrySpec]' = <factory>, observation_envelope: 'ObservationEnvelopeSpec | None' = None, assay_pack: 'AssayPackSpec | None' = None, recognition: 'MotifRecognitionSpec | None' = None, evidence_envelope: 'EvidenceEnvelopeSpec | None' = None, certification_envelope: 'CertificationEnvelopeSpec | None' = None, constitutional_envelope: 'ConstitutionalEnvelopeSpec | None' = None, institution_scaffolds: 'list[InstitutionScaffoldSpec]' = <factory>) -> None | neumera_self_aware.substrates.schema | SubstrateEnvironmentSpec(environment_id: 'str', world_name: 'str', version: 'str' = '20a', description: 'str' = '', top_shell_id: 'str | None' = None, shells: 'list[ShellSpec]' = <factory>, guards: 'list[GuardSpec]' = <factory>, cadence: 'list[CadenceSpec]' = <factory>, channels: 'list[ChannelSpec]' = <factory>, perturbations: 'list[PerturbationSpec]' = <factory>, populations: 'list[PopulationSpec]' = <factory>, mind_seeds: 'list[MindSeedSpec]' = <factory>, memory_registries: 'list[MemoryRegistrySpec]' = <factory>, observation_envelope: 'ObservationEnvelopeSpec | None' = None, assay_pack: 'AssayPackSpec | None' = None, recognition: 'MotifRecognitionSpec | None' = None, evidence_envelope: 'EvidenceEnvelopeSpec | None' = None, certification_envelope: 'CertificationEnvelopeSpec | None' = None, constitutional_envelope: 'ConstitutionalEnvelopeSpec | None' = None, institution_scaffolds: 'list[InstitutionScaffoldSpec]' = <factory>) |
SymbolicRequest | class | SymbolicRequest(command: 'str', args: 'dict[str, Any]' = <factory>, packet_id: 'str | None' = None) -> None | neumera_self_aware._platform_api.core | Typed symbolic command request for external callers. |
TemporalPacingConfig | class | TemporalPacingConfig(max_steps: 'int', pause_at_steps: 'tuple[int, ...]' = (), checkpoint_every_steps: 'int' = 0, symbolic_command: 'str' = 'list_objects', step_plan: 'tuple[TemporalStepSpec, ...]' = (), degrade_at_steps: 'tuple[int, ...]' = (), recover_at_steps: 'tuple[int, ...]' = ()) -> None | neumera_self_aware.continuous_ops | TemporalPacingConfig(max_steps: 'int', pause_at_steps: 'tuple[int, ...]' = (), checkpoint_every_steps: 'int' = 0, symbolic_command: 'str' = 'list_objects', step_plan: 'tuple[TemporalStepSpec, ...]' = (), degrade_at_steps: 'tuple[int, ...]' = (), recover_at_steps: 'tuple[int, ...]' = ()) |
WorldBinder | class | WorldBinder(*, runtime: 'MultiEntityRuntime | None' = None, compiler: 'WorldCompiler | None' = None) -> 'None' | neumera_self_aware.worlds.binder | Binder above the canonical API/runtime surfaces. |
WorldCompiler | class | WorldCompiler(/, *args, **kwargs) | neumera_self_aware.worlds.compiler | Declaration compiler from inert ROG/Glyphx models to a binding plan. |
WorldSpec | class | WorldSpec(world_id: 'str', world_name: 'str', version: 'str', description: 'str' = '', top_shell_id: 'str | None' = None, defaults: 'dict[str, Any]' = <factory>, imports: 'list[str]' = <factory>, assay_intents: 'list[AssayIntentSpec]' = <factory>, shells: 'list[ShellSpec]' = <factory>, populations: 'list[PopulationSpec]' = <factory>, entities: 'list[EntitySeed]' = <factory>, relationships: 'list[RelationshipSeed]' = <factory>, channels: 'list[ChannelSpec]' = <factory>, objects: 'list[WorldObjectSpec]' = <factory>, symbolic_artifacts: 'list[SymbolicArtifactSpec]' = <factory>, cadences: 'list[CadenceSpec]' = <factory>, residues: 'list[ResidueSpec]' = <factory>, perturbations: 'list[PerturbationSpec]' = <factory>) -> None | neumera_self_aware.worlds.schema | Declarative world declaration surface. |
answer_reflective_query | function | answer_reflective_query(runtime: 'SingleEntityCRRuntime', *, query_type: 'str', query_payload: 'dict[str, object] | None' = None, observer_mode: 'str' = 'observer_sustained_low') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
create_agent_session | function | create_agent_session(runtime: 'SingleEntityCRRuntime', *, target_condition: 'str', goal_id: 'str | None' = None) -> 'AgentSession' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
create_assistant | function | create_assistant(runtime: 'SingleEntityCRRuntime') -> 'PersistentAssistant' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
create_observer_session | function | create_observer_session(runtime: 'SingleEntityCRRuntime') -> 'ObserverSession' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
create_platform_api | function | create_platform_api(runtime: 'SingleEntityCRRuntime | None' = None) -> 'CanonicalPlatformAPI' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
create_repair_session | function | create_repair_session(runtime: 'SingleEntityCRRuntime', *, repair_key: 'str') -> 'RepairSession' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
create_runtime | function | create_runtime() -> 'SingleEntityCRRuntime' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
export_long_run_evidence | function | export_long_run_evidence(manager: 'RuntimeLifecycleManager', *, output_path: 'str | Path') -> 'dict[str, Any]' | neumera_self_aware.continuous_ops | No inline docstring is available for this symbol. |
export_platform_state | function | export_platform_state(runtime: 'SingleEntityCRRuntime') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
export_scenario_summary | function | export_scenario_summary(result: 'dict[str, object]') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
get_latest_certification_status | function | get_latest_certification_status(runtime: 'SingleEntityCRRuntime') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
get_observer_self_report | function | get_observer_self_report(runtime: 'SingleEntityCRRuntime', *, observer_mode: 'str' = 'observer_sustained_low') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
get_observer_state | function | get_observer_state(runtime: 'SingleEntityCRRuntime') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
get_observer_tradeoff_summary | function | get_observer_tradeoff_summary(runtime: 'SingleEntityCRRuntime') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
get_runtime_summary | function | get_runtime_summary(runtime: 'SingleEntityCRRuntime') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
load_world_spec | function | load_world_spec(path: 'str | Path') -> 'WorldSpec' | neumera_self_aware.worlds.glyphx_parser | No inline docstring is available for this symbol. |
parse_glyphx_world_text | function | parse_glyphx_world_text(text: 'str') -> 'WorldSpec' | neumera_self_aware.worlds.glyphx_parser | Parse a minimal Glyphx-like declarative form into the canonical ROG model. |
replay_saved_run | function | replay_saved_run(runtime: 'SingleEntityCRRuntime', artifact_path: 'str') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
run_long_horizon_assay | function | run_long_horizon_assay(manager: 'RuntimeLifecycleManager', *, max_steps: 'int', output_dir: 'str | Path', command: 'str' = 'list_objects') -> 'dict[str, Any]' | neumera_self_aware.continuous_ops | No inline docstring is available for this symbol. |
run_named_scenario | function | run_named_scenario(runtime: 'SingleEntityCRRuntime', *, scenario_name: 'str') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
run_scenario | function | run_scenario(runtime: 'SingleEntityCRRuntime', definition: 'ScenarioDefinition') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
run_world_assay | function | run_world_assay(bound_world: 'BoundWorld') -> 'dict[str, Any]' | neumera_self_aware.worlds.binder | Thin adapter that collects runtime-native evidence per bound world. |
save_run_artifact | function | save_run_artifact(path: 'str', result: 'dict[str, object]') -> 'str' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |
set_observer_activation | function | set_observer_activation(runtime: 'SingleEntityCRRuntime', *, observer_mode: 'str') -> 'dict[str, object]' | neumera_self_aware._platform_api.core | No inline docstring is available for this symbol. |