Skip to content

Symbol Index

278 public types: 29 traits, 178 structs, 71 enums. This page exists to be searched — if you have a symbol name and want to know where it lives and what it is for, start here and follow the link.

Ten of these are marked pyclass. They are pub(crate) in Rust and public to Python, which makes them API in the way that matters: PyGraph is what a user writes as soma.Graph.

Excluded: anything inside a #[cfg(test)] module, and genuinely internal types even where the reference pages discuss them — PlanCtx, StreamNode, ChunkLru, McpTool, StepRuntime, Behaviour, StepSpec, StoreConfig, ScheduleState, Bm25Index, and the four FFI bridges (PyFilterBridge, PyStepBridge, PyToolAdapter, PyPbtExecutor). Look for those on the crate’s page.

The traits are the architecture. Everything else is a type that participates in one of them.

RoleTraits
Node behaviourFilter, Step, AsAny
CompilationNodeRegistry
ExecutionRunner, ForwardStrategy, Transport
Caching & storageCacheStore, ActionCache, BlobStore, DataStore, StateStore
EffectsEffectHandler
Search & tuningSampler, Pruner, Searchable, TrialExecutor, PbtExecutor, StudyIo
Distributed trainingStrategyContext, StrategyExecutor, GradientAggregator, StateAggregator
ObservabilityEventSink, Tracker
Models & toolsLlmProvider, Tool
KnowledgeKnowledgeBase, Embedder

Searchable and StudyIo are the only two that are not object-safe. Embedder has zero implementors, deliberately — it is a seam for an outside plug-in (soma-memory/src/retrieval.rs:55).

The table below is generated. After adding, removing or moving a public type:

Terminal window
cd docs && node scripts/gen-symbol-index.mjs

Everything above this heading is hand-written and preserved; only the table is replaced. npm run check verifies every row against the source, so a stale index fails the build rather than quietly misleading a reader.

SymbolKindCrateDefined at
Actionenumsoma-agentsoma-agent/src/action.rs:15
ActionCache«trait»soma-coresoma-core/src/action.rs:134
ActionResultstructsoma-coresoma-core/src/action.rs:110
AgentCoststructsoma-coresoma-core/src/summary.rs:121
AgenticActivitystructsoma-runtimesoma-runtime/src/tracking/reader.rs:149
AgentNodeActivitystructsoma-runtimesoma-runtime/src/tracking/reader.rs:181
ArchitectureFingerprintstructsoma-coresoma-core/src/fingerprint.rs:36
AsAny«trait»soma-coresoma-core/src/any.rs:13
Assignmentstructsoma-compilersoma-compiler/src/scheduler.rs:57
Authenumsoma-llmsoma-llm/src/catalog.rs:34
SymbolKindCrateDefined at
Batchedstructsoma-runtimesoma-runtime/src/forward.rs:99
BayesianSamplerstructsoma-runtimesoma-runtime/src/sampler/bayesian.rs:16
BlobStore«trait»soma-coresoma-core/src/action.rs:143
SymbolKindCrateDefined at
CacheActivitystructsoma-runtimesoma-runtime/src/tracking/reader.rs:89
CacheKeystructsoma-coresoma-core/src/cache.rs:18
CacheStore«trait»soma-coresoma-core/src/cache.rs:204
CacheTierenumsoma-coresoma-core/src/cache.rs:150
Capabilitiesstructsoma-workersoma-worker/src/protocol.rs:44
Catalogstructsoma-llmsoma-llm/src/catalog.rs:374
Changeenumsoma-memorysoma-memory/src/derivation.rs:31
ChangePointstructsoma-memorysoma-memory/src/record.rs:394
ChronosKnowledgeBasestructsoma-memorysoma-memory/src/chronos_kb.rs:24
ClientSelectionenumsoma-coresoma-core/src/strategy.rs:161
CommunicationProtocolenumsoma-coresoma-core/src/strategy.rs:119
CompileModeenumsoma-compilersoma-compiler/src/compiler.rs:17
Compilerstructsoma-compilersoma-compiler/src/compiler.rs:202
CompileResultstructsoma-compilersoma-compiler/src/compiler.rs:50
CompositeObjectivestructsoma-coresoma-core/src/study.rs:69
ContentBlockenumsoma-coresoma-core/src/message.rs:59
ContentHashstructsoma-coresoma-core/src/action.rs:52
ContentItemstructsoma-mcpsoma-mcp/src/protocol.rs:167
Contextstructsoma-runtimesoma-runtime/src/executor.rs:124
CoordinatorToWorkerenumsoma-workersoma-worker/src/protocol.rs:484
SymbolKindCrateDefined at
DataRefenumsoma-coresoma-core/src/store/mod.rs:98
DataStore«trait»soma-coresoma-core/src/store/mod.rs:208
DataTransferstructsoma-compilersoma-compiler/src/scheduler.rs:124
DataTypeenumsoma-coresoma-core/src/schema.rs:12
DerivationMovestructsoma-memorysoma-memory/src/derivation.rs:175
Diagnosticstructsoma-compilersoma-compiler/src/compiler.rs:28
DiagnosticLevelenumsoma-compilersoma-compiler/src/compiler.rs:40
Dimensionenumsoma-coresoma-core/src/schema.rs:115
Directionenumsoma-coresoma-core/src/study.rs:15
Distributionenumsoma-coresoma-core/src/filter.rs:53
DistributionPlanstructsoma-compilersoma-compiler/src/scheduler.rs:93
SymbolKindCrateDefined at
Edgestructsoma-coresoma-core/src/graph.rs:229
EdgeKindenumsoma-coresoma-core/src/graph.rs:220
EdgeRefstructsoma-coresoma-core/src/fingerprint.rs:60
Effectenumsoma-coresoma-core/src/effect.rs:35
EffectDriverstructsoma-runtimesoma-runtime/src/effects/mod.rs:57
EffectHandler«trait»soma-coresoma-core/src/effect.rs:262
EffectJournalstructsoma-runtimesoma-runtime/src/effects/journal.rs:51
EffectResultenumsoma-coresoma-core/src/effect.rs:278
EffectSitestructsoma-runtimesoma-runtime/src/effects/journal.rs:36
EffectSpanstructsoma-runtimesoma-runtime/src/tracking/reader.rs:218
Embedder«trait»soma-memorysoma-memory/src/retrieval.rs:64
Embeddingstructsoma-memorysoma-memory/src/record.rs:43
EntryMetastructsoma-coresoma-core/src/cache.rs:185
EnvLockfilestructsoma-workersoma-worker/src/env_manager.rs:25
EnvManagerstructsoma-workersoma-worker/src/env_manager.rs:38
EnvTypeenumsoma-workersoma-worker/src/env_manager.rs:14
Eventenumsoma-coresoma-core/src/event.rs:54
EventBusstructsoma-runtimesoma-runtime/src/event_bus.rs:22
EventEnvelopestructsoma-coresoma-core/src/tracking.rs:225
EventSink«trait»soma-coresoma-core/src/tracking.rs:243
ExecutionModeenumsoma-workersoma-worker/src/protocol.rs:192
ExecutionPlanenumsoma-compilersoma-compiler/src/plan.rs:19
ExperimentRecordstructsoma-memorysoma-memory/src/record.rs:53
ExploitStrategyenumsoma-coresoma-core/src/strategy.rs:180
ExploreStrategyenumsoma-coresoma-core/src/strategy.rs:200
SymbolKindCrateDefined at
FederatedAggregationenumsoma-coresoma-core/src/strategy.rs:136
FileKnowledgeBasestructsoma-memorysoma-memory/src/file_kb.rs:25
Filter«trait»soma-coresoma-core/src/filter.rs:120
FilterKindenumsoma-coresoma-core/src/filter.rs:16
FilterMetastructsoma-coresoma-core/src/filter.rs:73
FlagCountstructsoma-coresoma-core/src/summary.rs:76
FnPbtExecutorstructsoma-runtimesoma-runtime/src/executors/pbt.rs:63
FnToolstructsoma-llmsoma-llm/src/tools.rs:62
FnTrialExecutorstructsoma-runtimesoma-runtime/src/executors/study.rs:144
ForwardEnvstructsoma-runtimesoma-runtime/src/forward.rs:25
ForwardStrategy«trait»soma-runtimesoma-runtime/src/forward.rs:40
FsActionStorestructsoma-runtimesoma-runtime/src/cache/fs_store.rs:40
SymbolKindCrateDefined at
GcPolicystructsoma-runtimesoma-runtime/src/cache/gc.rs:29
GcReportstructsoma-runtimesoma-runtime/src/cache/gc.rs:48
GitInfostructsoma-coresoma-core/src/tracking.rs:58
GpuInfostructsoma-workersoma-worker/src/protocol.rs:59
GradientAggregationenumsoma-coresoma-core/src/strategy.rs:89
GradientAggregator«trait»soma-runtimesoma-runtime/src/strategy.rs:132
Graphstructsoma-coresoma-core/src/graph.rs:293
GraphEffectModeenumsoma-coresoma-core/src/effect.rs:134
GraphHandlerstructsoma-runtimesoma-runtime/src/effects/graph_handler.rs:47
GraphInfostructsoma-runtimesoma-runtime/src/executor.rs:28
GraphOverlaystructsoma-coresoma-core/src/viz.rs:53
GraphRunnerstructsoma-mcpsoma-mcp/src/exec.rs:256
GraphSessionstructsoma-runtimesoma-runtime/src/graph_session.rs:38
GraphSummaryInfostructsoma-coresoma-core/src/tracking.rs:74
GridSamplerstructsoma-runtimesoma-runtime/src/sampler/mod.rs:54
SymbolKindCrateDefined at
HashAlgoenumsoma-coresoma-core/src/action.rs:32
HealthFlagRecordstructsoma-runtimesoma-runtime/src/tracking/reader.rs:130
SymbolKindCrateDefined at
InitializeResultstructsoma-mcpsoma-mcp/src/protocol.rs:92
InputSourceenumsoma-workersoma-worker/src/protocol.rs:88
SymbolKindCrateDefined at
JoinPolicyenumsoma-coresoma-core/src/effect.rs:482
JsonlEventSinkstructsoma-runtimesoma-runtime/src/tracking/jsonl_sink.rs:19
JsonRpcErrorstructsoma-mcpsoma-mcp/src/protocol.rs:52
JsonRpcRequeststructsoma-mcpsoma-mcp/src/protocol.rs:7
JsonRpcResponsestructsoma-mcpsoma-mcp/src/protocol.rs:32
JudgeStepstructsoma-llmsoma-llm/src/steps.rs:527
SymbolKindCrateDefined at
KnowledgeBase«trait»soma-memorysoma-memory/src/knowledge_base.rs:50
SymbolKindCrateDefined at
Lineagestructsoma-memorysoma-memory/src/knowledge_base.rs:33
LineageNodestructsoma-memorysoma-memory/src/knowledge_base.rs:24
LlmErrorenumsoma-llmsoma-llm/src/error.rs:29
LlmHandlerstructsoma-llmsoma-llm/src/lib.rs:183
LlmProvider«trait»soma-llmsoma-llm/src/lib.rs:72
LlmRequeststructsoma-coresoma-core/src/effect.rs:144
LlmResponsestructsoma-coresoma-core/src/effect.rs:330
LlmStepstructsoma-llmsoma-llm/src/steps.rs:459
LoadMetricsstructsoma-workersoma-worker/src/protocol.rs:68
LocalCachestructsoma-runtimesoma-runtime/src/cache/local.rs:15
LocalDataStorestructsoma-coresoma-core/src/store/mod.rs:241
LocalRunnerstructsoma-runtimesoma-runtime/src/runner/local.rs:16
LocalTrackerstructsoma-runtimesoma-runtime/src/tracking/local_tracker.rs:27
LoopConditionenumsoma-coresoma-core/src/control.rs:28
LoopSignalenumsoma-coresoma-core/src/control.rs:46
SymbolKindCrateDefined at
McpClientstructsoma-llmsoma-llm/src/mcp_client.rs:29
MedianPrunerstructsoma-runtimesoma-runtime/src/pruner.rs:33
MemoryCachestructsoma-runtimesoma-runtime/src/cache/memory.rs:16
MemoryKnowledgeBasestructsoma-memorysoma-memory/src/knowledge_base.rs:318
MemoryStateStorestructsoma-coresoma-core/src/state.rs:46
Messagestructsoma-coresoma-core/src/message.rs:137
Messagesstructsoma-coresoma-core/src/message.rs:189
MetricDeltastructsoma-memorysoma-memory/src/derivation.rs:161
MetricPointstructsoma-runtimesoma-runtime/src/tracking/reader.rs:111
MetricRecordstructsoma-coresoma-core/src/event.rs:24
ModelInfostructsoma-llmsoma-llm/src/lib.rs:57
SymbolKindCrateDefined at
Nodestructsoma-coresoma-core/src/graph.rs:68
NodeCacheCountsstructsoma-runtimesoma-runtime/src/tracking/reader.rs:100
NodeCatalogstructsoma-runtimesoma-runtime/src/node_catalog.rs:79
NodeCoststructsoma-coresoma-core/src/summary.rs:65
NodeImplenumsoma-runtimesoma-runtime/src/node_catalog.rs:37
NodeKindenumsoma-coresoma-core/src/graph.rs:26
NodeMetastructsoma-coresoma-core/src/node.rs:72
NodeOutcomeenumsoma-coresoma-core/src/node.rs:44
NodeOverlaystructsoma-coresoma-core/src/viz.rs:33
NodeRegistry«trait»soma-compilersoma-compiler/src/compiler.rs:65
NodeSpanstructsoma-runtimesoma-runtime/src/tracking/reader.rs:66
NodeSpecstructsoma-coresoma-core/src/effect.rs:450
NodeStatusenumsoma-coresoma-core/src/viz.rs:20
SymbolKindCrateDefined at
Objectivestructsoma-coresoma-core/src/study.rs:36
OpenAiCompatiblestructsoma-llmsoma-llm/src/openai_compat.rs:188
Originenumsoma-coresoma-core/src/cache.rs:161
OutputDeliveryenumsoma-workersoma-worker/src/protocol.rs:560
SymbolKindCrateDefined at
Partitionstructsoma-coresoma-core/src/strategy.rs:107
PbtConfigstructsoma-runtimesoma-runtime/src/executors/pbt.rs:22
PbtExecutor«trait»soma-runtimesoma-runtime/src/executors/pbt.rs:55
PbtRunnerstructsoma-runtimesoma-runtime/src/executors/pbt.rs:84
PercentilePrunerstructsoma-runtimesoma-runtime/src/pruner.rs:106
Phaseenumsoma-compilersoma-compiler/src/scheduler.rs:76
PipelineFilestructsoma-workersoma-worker/src/protocol.rs:474
PlanPhasestructsoma-compilersoma-compiler/src/scheduler.rs:109
PlanResultenumsoma-workersoma-worker/src/protocol.rs:585
PlanSummarystructsoma-coresoma-core/src/event.rs:37
PopulationMemberstructsoma-runtimesoma-runtime/src/executors/pbt.rs:41
ProviderConfigstructsoma-llmsoma-llm/src/catalog.rs:231
Pruner«trait»soma-runtimesoma-runtime/src/pruner.rs:10
PruningStrategyenumsoma-coresoma-core/src/study.rs:179
PyAgentstruct · pyclasssoma-pythonsoma-python/src/agentic.rs:283
PyGraphstruct · pyclasssoma-pythonsoma-python/src/graph.rs:28
PyJudgestruct · pyclasssoma-pythonsoma-python/src/agentic.rs:422
PyPbtstruct · pyclasssoma-pythonsoma-python/src/pbt.rs:35
PyRunstruct · pyclasssoma-pythonsoma-python/src/run.rs:13
PyStepCtxstruct · pyclasssoma-pythonsoma-python/src/agentic.rs:506
PyStudystruct · pyclasssoma-pythonsoma-python/src/study.rs:173
PythonPipelineJobstructsoma-workersoma-worker/src/protocol.rs:451
PythonProcessstructsoma-workersoma-worker/src/python_process.rs:538
PyToolstruct · pyclasssoma-pythonsoma-python/src/agentic.rs:47
PyTrialstruct · pyclasssoma-pythonsoma-python/src/study.rs:112
PyWorkerstruct · pyclasssoma-pythonsoma-python/src/worker.rs:54
SymbolKindCrateDefined at
Quirksstructsoma-llmsoma-llm/src/catalog.rs:96
SymbolKindCrateDefined at
RandomSamplerstructsoma-runtimesoma-runtime/src/sampler/mod.rs:175
ReactStepstructsoma-llmsoma-llm/src/steps.rs:32
RecordKindenumsoma-memorysoma-memory/src/record.rs:26
RemoteRunnerstructsoma-runtimesoma-runtime/src/runner/remote.rs:73
RemoteTargetenumsoma-coresoma-core/src/filter.rs:64
ResearchLinestructsoma-memorysoma-memory/src/record.rs:355
ResearchStepstructsoma-agentsoma-agent/src/research.rs:38
ResourceLimitsstructsoma-workersoma-worker/src/detect.rs:19
RetrievalQuerystructsoma-memorysoma-memory/src/retrieval.rs:98
RetryPolicystructsoma-llmsoma-llm/src/catalog.rs:144
Roleenumsoma-coresoma-core/src/message.rs:22
Routerstructsoma-llmsoma-llm/src/lib.rs:93
RunConclusionstructsoma-coresoma-core/src/summary.rs:157
RunContextstructsoma-runtimesoma-runtime/src/runner/mod.rs:32
RunInfostructsoma-runtimesoma-runtime/src/tracking/reader.rs:42
RunKindenumsoma-coresoma-core/src/tracking.rs:27
RunManifeststructsoma-coresoma-core/src/tracking.rs:93
RunModeenumsoma-runtimesoma-runtime/src/executor.rs:92
Runner«trait»soma-runtimesoma-runtime/src/runner/mod.rs:124
RunOutcomeenumsoma-coresoma-core/src/summary.rs:27
RunReaderstructsoma-runtimesoma-runtime/src/tracking/reader.rs:36
RunStateenumsoma-coresoma-core/src/tracking.rs:46
RunStatusstructsoma-coresoma-core/src/tracking.rs:193
RunSummarystructsoma-coresoma-core/src/summary.rs:331
SymbolKindCrateDefined at
S3DataStorestructsoma-storesoma-store/src/s3.rs:24
Sampler«trait»soma-runtimesoma-runtime/src/sampler/mod.rs:22
Scalarizerenumsoma-coresoma-core/src/study.rs:48
Scaleenumsoma-coresoma-core/src/search.rs:17
Schemastructsoma-coresoma-core/src/schema.rs:104
ScoreComponentsstructsoma-memorysoma-memory/src/retrieval.rs:163
ScoredRecordstructsoma-memorysoma-memory/src/retrieval.rs:177
Searchable«trait»soma-coresoma-core/src/search.rs:321
SearchDimensionenumsoma-coresoma-core/src/search.rs:36
SearchSpacestructsoma-coresoma-core/src/search.rs:172
SearchStrategyenumsoma-coresoma-core/src/study.rs:113
SerializedFilterstructsoma-workersoma-worker/src/protocol.rs:152
SerializedPlanstructsoma-workersoma-worker/src/protocol.rs:209
ServerCapabilitiesstructsoma-mcpsoma-mcp/src/protocol.rs:110
ServerInfostructsoma-mcpsoma-mcp/src/protocol.rs:127
ShutdownSignalstructsoma-workersoma-worker/src/server.rs:33
SimpleNodeRegistrystructsoma-compilersoma-compiler/src/compiler.rs:91
SleepHandlerstructsoma-runtimesoma-runtime/src/effects/sleep_handler.rs:18
SomaContextstructsoma-mcpsoma-mcp/src/context.rs:9
SomaErrorenumsoma-coresoma-core/src/error.rs:14
Standardstructsoma-runtimesoma-runtime/src/forward.rs:46
StateAggregator«trait»soma-runtimesoma-runtime/src/strategy.rs:139
StateStore«trait»soma-coresoma-core/src/state.rs:24
Step«trait»soma-coresoma-core/src/step.rs:250
StepCtxstructsoma-coresoma-core/src/step.rs:115
StepMetastructsoma-coresoma-core/src/step.rs:177
StopReasonenumsoma-coresoma-core/src/effect.rs:392
StorageConfigenumsoma-coresoma-core/src/store/mod.rs:161
StoreMetastructsoma-coresoma-core/src/store/mod.rs:21
StrategyContext«trait»soma-runtimesoma-runtime/src/strategy.rs:33
StrategyExecutor«trait»soma-runtimesoma-runtime/src/strategy.rs:120
Streamstructsoma-runtimesoma-runtime/src/forward.rs:58
StreamFormatenumsoma-coresoma-core/src/store/mod.rs:145
StreamMessageenumsoma-workersoma-worker/src/protocol.rs:620
StreamModeenumsoma-coresoma-core/src/filter.rs:37
StreamOutputstructsoma-runtimesoma-runtime/src/executors/stream.rs:283
StreamRunstructsoma-runtimesoma-runtime/src/executors/stream.rs:73
Studystructsoma-coresoma-core/src/study.rs:319
StudyIo«trait»soma-runtimesoma-runtime/src/study_io.rs:19
StudyRunnerstructsoma-runtimesoma-runtime/src/executors/study.rs:160
SubprocessFilterstructsoma-workersoma-worker/src/python_process.rs:982
SuspendReasonenumsoma-coresoma-core/src/effect.rs:507
SymbolKindCrateDefined at
TieredCachestructsoma-runtimesoma-runtime/src/cache/tiered.rs:11
Tool«trait»soma-llmsoma-llm/src/tools.rs:53
Toolboxstructsoma-llmsoma-llm/src/tools.rs:92
ToolCallResultstructsoma-mcpsoma-mcp/src/protocol.rs:149
ToolOutcomestructsoma-llmsoma-llm/src/tools.rs:26
ToolsCapabilitystructsoma-mcpsoma-mcp/src/protocol.rs:117
ToolSpecstructsoma-coresoma-core/src/tool.rs:16
Tracker«trait»soma-coresoma-core/src/tracking.rs:255
TrainingStrategyenumsoma-coresoma-core/src/strategy.rs:22
Transitionenumsoma-coresoma-core/src/step.rs:43
Transport«trait»soma-runtimesoma-runtime/src/runner/remote.rs:18
TransportContextstructsoma-runtimesoma-runtime/src/strategy.rs:541
Trendenumsoma-memorysoma-memory/src/record.rs:370
Trialstructsoma-coresoma-core/src/study.rs:235
TrialContextstructsoma-runtimesoma-runtime/src/executors/study.rs:48
TrialExecutor«trait»soma-runtimesoma-runtime/src/executors/study.rs:133
TrialMetricHistorystructsoma-runtimesoma-runtime/src/pruner.rs:25
TrialOutcomeenumsoma-runtimesoma-runtime/src/executors/study.rs:24
TrialSpanstructsoma-runtimesoma-runtime/src/tracking/reader.rs:241
TrialStateenumsoma-coresoma-core/src/study.rs:210
TrialSummarystructsoma-coresoma-core/src/summary.rs:138
SymbolKindCrateDefined at
Usagestructsoma-coresoma-core/src/effect.rs:411
SymbolKindCrateDefined at
Valueenumsoma-coresoma-core/src/value.rs:15
ValueStatusenumsoma-coresoma-core/src/virtual_value.rs:65
Verdictstructsoma-llmsoma-llm/src/steps.rs:508
VirtualValueenumsoma-coresoma-core/src/virtual_value.rs:26
SymbolKindCrateDefined at
Workerstructsoma-workersoma-worker/src/worker.rs:16
WorkerErrorenumsoma-workersoma-worker/src/error.rs:24
WorkerIdentitystructsoma-runtimesoma-runtime/src/strategy.rs:557
WorkerInfostructsoma-compilersoma-compiler/src/scheduler.rs:15
WorkerRegistrystructsoma-coordinatorsoma-coordinator/src/registry.rs:73
WorkerStatusstructsoma-coordinatorsoma-coordinator/src/registry.rs:22
WorkerToCoordinatorenumsoma-workersoma-worker/src/protocol.rs:333
WsTransportstructsoma-workersoma-worker/src/ws_transport.rs:17
SymbolKindCrateDefined at
ZarrStorestructsoma-storesoma-store/src/zarr.rs:201