Skip to navigation
ReferenceAPIPython Library Reference

Types

View as Markdown

module nemo_fabric.types

Public data contracts for the NeMo Fabric Python SDK.


class AdapterInfo

Resolved adapter identity attached to a run plan.

Attributes:

  • adapter_id: Stable identifier of the NeMo Fabric adapter implementation.
  • adapter_kind: Execution mechanism used by the adapter.
  • metadata: Adapter-specific, JSON-compatible metadata.

Fields

The mapping exposes the following typed fields:

FieldType
adapter_idstr
adapter_kindstr
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class RuntimeCapabilities

Operations declared by the resolved runtime and adapter.

Capabilities describe what the selected runtime can support; callers should still expect a capability-specific error when a transport is modeled but not implemented.

Attributes:

  • service: Whether long-lived service handles are supported.
  • streaming: Whether event streaming is supported.
  • updates: Whether runtime configuration updates are supported.
  • cancellation: Whether in-flight cancellation is supported.
  • metadata: Additional capability details.

Fields

The mapping exposes the following typed fields:

FieldType
servicebool
streamingbool
updatesbool
cancellationbool
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class RunPlan

Immutable execution plan produced before a runtime is started.

Attributes:

  • agent_name: Resolved agent name.
  • base_dir: Base directory used to resolve relative paths.
  • config: Typed configuration snapshot.
  • adapter: Resolved adapter identity.
  • capabilities: Operations declared by the resolved runtime.

Fields

The mapping exposes the following typed fields:

FieldType
agent_namestr
base_dirPath
config_FabricConfigSnapshot
adapterAdapterInfo
capabilitiesRuntimeCapabilities

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class DoctorCheck

One diagnostic check in a DoctorReport.

Attributes:

  • name: Stable check identifier.
  • status: Check outcome: pass, warn, or fail.
  • message: Human-readable result.
  • metadata: Structured check details.

Fields

The mapping exposes the following typed fields:

FieldType
namestr
statusstr
messagestr
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class DoctorReport

Aggregate preflight diagnostics for a resolved run plan.

Attributes:

  • agent_name: Resolved agent name.
  • status: Aggregate outcome: pass, warn, or fail.
  • checks: Ordered DoctorCheck results.

Fields

The mapping exposes the following typed fields:

FieldType
agent_namestr
statusstr
checksSequence[DoctorCheck]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class ErrorInfo

Structured failure returned inside a normalized RunResult.

Attributes:

  • stage: Lifecycle stage that failed.
  • code: Stable machine-readable error code.
  • message: Human-readable failure description.
  • retryable: Whether retrying may succeed without changing the request.
  • metadata: Adapter- or runtime-specific details.

Fields

The mapping exposes the following typed fields:

FieldType
stagestr
codestr
messagestr
retryablebool
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class ArtifactRef

Reference to one artifact produced by a run.

Attributes:

  • name: Stable artifact name.
  • kind: Artifact category.
  • path: Artifact path under the manifest root or workspace.
  • media_type: Optional MIME type.
  • metadata: Artifact-specific details.

Fields

The mapping exposes the following typed fields:

FieldType
namestr
kindstr
pathPath
media_typestr | None
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class ArtifactManifest

Normalized collection of artifacts produced by a run.

Attributes:

  • root: Optional common artifact root.
  • artifacts: Ordered ArtifactRef entries.

Fields

The mapping exposes the following typed fields:

FieldType
rootPath | None
artifactsSequence[ArtifactRef]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class TelemetryRef

Reference to external or persisted telemetry for a run.

Attributes:

  • provider: Telemetry provider, such as NVIDIA NeMo Relay.
  • kind: Reference kind, such as trace.
  • uri: Optional location of persisted telemetry.
  • trace_id: Optional provider trace identifier.
  • metadata: Provider-specific details.

Fields

The mapping exposes the following typed fields:

FieldType
providerstr
kindstr
uristr | None
trace_idstr | None
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class FabricEvent

One normalized lifecycle or invocation event.

Attributes:

  • event_id: Stable event identifier.
  • timestamp_millis: Event time as Unix epoch milliseconds.
  • kind: Machine-readable event kind.
  • message: Human-readable event description.
  • metadata: Event-specific structured details.

Fields

The mapping exposes the following typed fields:

FieldType
event_idstr
timestamp_millisint
kindstr
messagestr
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class EnvironmentReference

Provider-specific identity for an existing execution environment.

Pass this reference to Fabric.attach_environment(). The provider verifies the resource before returning a durable EnvironmentHandle and never gains deletion authority over the caller-owned resource.

Attributes:

  • provider: Stable environment-provider identifier.
  • resource: Provider-specific resource identity.

Fields

The mapping exposes the following typed fields:

FieldType
providerstr
resourceMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class EnvironmentHandle

Durable identity and provider binding for a prepared or attached environment.

Environment handles are independent of runtime sessions. Runtime and reuse limits are provider-specific. Release the environment separately after stopping its runtime and collecting results.

Attributes:

  • environment_id: Unique identifier for the prepared environment.
  • provider: Stable environment-provider identifier.
  • control_location: Whether Fabric control runs outside or inside the environment.
  • workspace: Optional workspace visible to the harness runtime.
  • artifacts: Optional artifact root visible to the harness runtime.
  • env: Environment variables visible to the harness and its tools.
  • ownership: Whether the caller or Fabric owns the environment resource.
  • connection: Provider connection metadata.
  • metadata: Provider-specific metadata.

Fields

The mapping exposes the following typed fields:

FieldType
environment_idstr
providerstr
control_locationstr
workspacestr | Path | None
artifactsstr | Path | None
envMapping[str, str]
ownershipstr
connectionMapping[str, Any]
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class RuntimeHandle

Opaque identity and binding for one started runtime.

Applications should treat runtime_binding as opaque. NeMo Fabric validates the handle against the run plan before invocation or shutdown.

Attributes:

  • runtime_id: Unique identifier for this runtime lifecycle.
  • runtime_binding: Opaque integrity-bound runtime binding.
  • agent_name: Resolved agent name.
  • harness: Stable harness identifier.
  • adapter_kind: Adapter execution mechanism.
  • adapter_id: Optional NeMo Fabric adapter identifier.
  • service_id: Optional service used by this runtime.
  • environment: Prepared environment snapshot.

Fields

The mapping exposes the following typed fields:

FieldType
runtime_idstr
runtime_bindingstr
agent_namestr
harnessstr
adapter_kindstr
adapter_idstr | None
service_idstr | None
environmentMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class ServiceReference

Reference to an already-running caller-owned service.

adapter_id selects the adapter that understands the service type and connection fields.

connection contains endpoints and credential references such as an environment-variable name. It must not contain credential values.

Fields

The mapping exposes the following typed fields:

FieldType
adapter_idstr
service_typestr
connectionMapping[str, Any]
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class ServiceHandle

Opaque identity and binding for one prepared or attached service.

service_id identifies the process-local Fabric service lifecycle, not the underlying remote deployment. service_binding is opaque and must be returned unchanged when the handle is used. adapter_id identifies the adapter that created or attached to the service, and service_type is that adapter’s stable service kind. ownership is fabric_owned or caller_owned. connection is a sanitized summary that never contains credential values, while metadata contains adapter-reported version and readiness information.

Fields

The mapping exposes the following typed fields:

FieldType
service_idstr
service_bindingstr
adapter_idstr
service_typestr
ownershipstr
connectionMapping[str, Any]
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class RunOutput

Normalized adapter output.

response is a known adapter response field whose value follows the core NeMo Fabric JSON contract. Other keys are adapter-specific extensions.

Fields

The mapping exposes the following typed fields:

FieldType
responseJSONValue | None

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


property response

Return the raw response JSON value, or None when absent.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class RunUsage

Normalized invocation-local usage reported by an adapter target.

Missing counters and cost are unknown, not zero. cached_input_tokens records cache usage; input_tokens_include_cache declares whether input already includes that count. An absent flag means the semantics are unknown. Descriptor-declared detailed usage is preserved in metadata.

Fields

The mapping exposes the following typed fields:

FieldType
input_tokensint | None
cached_input_tokensint | None
input_tokens_include_cachebool | None
output_tokensint | None
total_tokensint | None
cost_usdfloat | None
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class RuntimeResourceSnapshot

Timestamped resource usage of one runtime’s local adapter host process tree.

Memory, process count, and CPU time cover the adapter host process and its live descendants, not a shared service process. Values that cannot be read raise an error instead of reading as zero.

Attributes:

  • runtime_id: Runtime this snapshot describes.
  • started_at: When NeMo Fabric started the adapter host, as RFC 3339 UTC.
  • observed_at: When NeMo Fabric read these values, as RFC 3339 UTC.
  • resident_memory_bytes: Sum of the live processes’ resident set sizes. Pages shared between processes count once per process.
  • process_count: Live processes in the tree, including the adapter host.
  • cpu_time_seconds: CPU time used since the adapter host started, including exited descendants. It can drop when a descendant leaves the tree.

Fields

The mapping exposes the following typed fields:

FieldType
runtime_idstr
started_atstr
observed_atstr
resident_memory_bytesint
process_countint
cpu_time_secondsfloat

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class ResourceObservation

Adapter host process-tree reading, or an explicit collection failure.

Attributes:

  • status: available, unavailable, unsupported, or not_collected.
  • snapshot: Present only when available; a RuntimeResourceSnapshot.
  • reason: Present only when unavailable or unsupported.

Fields

The mapping exposes the following typed fields:

FieldType
statusstr

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


property reason

Return the collection failure reason, otherwise None.


property snapshot

Return the reading when available, otherwise None.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class Measurement

Measured numeric value, an unlimited limit, or explicit missing evidence.

Attributes:

  • status: available, unlimited, unavailable, unsupported, or not_collected.
  • value: Numeric reading when available, otherwise None.
  • reason: Collection failure/capability reason, otherwise None.

Fields

The mapping exposes the following typed fields:

FieldType
statusstr

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


property reason

Return the reason for missing evidence, otherwise None.


property value

Return an available reading, otherwise None.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class CgroupSnapshot

Native adapter-host cgroup measurements, separate from process RSS.

Counters cover this cgroup and its descendants, potentially including other workloads. Limits are visible ancestor bounds; hidden ancestors and actual exclusive capacity are unknown. memory_peak_bytes covers cgroup lifetime or its last external reset, never this invocation’s peak.

Fields

The mapping exposes the following typed fields:

FieldType
sourcestr
scopestr
targetstr
observed_atstr
visible_cpu_limit_coresMeasurement
visible_memory_limit_bytesMeasurement
memory_current_bytesMeasurement
memory_peak_bytesMeasurement
swap_current_bytesMeasurement
cpu_usage_microsecondsMeasurement
cpu_throttled_microsecondsMeasurement
oom_killsMeasurement
pressure_stall_microsecondsMapping[str, Measurement]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class CgroupObservation

Native cgroup snapshot or explicit unavailable/unsupported reason.

Fields

The mapping exposes the following typed fields:

FieldType
statusstr

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


property reason

Return the missing-evidence reason, otherwise None.


property snapshot

Return the cgroup reading, otherwise None.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class CgroupStats

Cgroup endpoint observations and counter deltas over an invocation.

Fields

The mapping exposes the following typed fields:

FieldType
beforeCgroupObservation
afterCgroupObservation
cpu_usage_microsecondsMeasurement
cpu_throttled_microsecondsMeasurement
oom_killsMeasurement

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class GaugeSummary

Sampled gauge extrema, hold-last-value mean, and covered time.

Sampled peak is not true high-water. Means exclude missing readings and gaps longer than twice the requested cadence. covered_fraction discloses how much of the invocation contributes to the mean.

Fields

The mapping exposes the following typed fields:

FieldType
unitstr
final_valueint | None
minint | None
sampled_peakint | None
time_weighted_meanfloat | None
valid_samplesint
covered_secondsfloat
covered_fractionfloat

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class SampleSummary

Retained native series, reductions, and collection-quality diagnostics.

Fields

The mapping exposes the following typed fields:

FieldType
target_interval_msint
max_samplesint
sample_countint
dropped_samplesint
largest_gap_secondsfloat
collection_secondsfloat
truncatedbool
diagnosticsSequence[str]
samplesArtifactRef | None
cgroup_target_continuousbool
resident_memory_bytesGaugeSummary | None
process_countGaugeSummary | None
cpu_time_seconds_estimateMeasurement
cpu_percent_one_coreMeasurement

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class InvocationSystemStats

System measurements for one invocation in its executing runner.

Observations cover the adapter host process tree, excluding the orchestrator and remote services. Endpoints are neither peaks nor time averages.

Attributes:

  • elapsed_seconds: Monotonic adapter exchange duration, excluding startup, endpoint collection, artifact preparation, and teardown.
  • before: Observation immediately before the adapter exchange.
  • after: Observation immediately after the exchange, under the same lock.
  • cgroup: Native adapter-host cgroup readings and counter deltas, or None.
  • sampled: Optional retained series, gauge reductions, and collection quality.
  • cpu_time_seconds_estimate: Nonnegative CPU counter difference, or None if an endpoint is missing, identities differ, or the counter fell. Process reaping and reparenting can make this underestimate work.

Fields

The mapping exposes the following typed fields:

FieldType
cgroupCgroupStats | None
sampledSampleSummary | None
collected_groupsSequence[str]
elapsed_secondsfloat
beforeResourceObservation
afterResourceObservation

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property cpu_time_seconds_estimate

Return the CPU counter difference estimate, or None when unknown.


property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class VersionObservation

Read-only version observation with source, origin and original capture time.

Fields

The mapping exposes the following typed fields:

FieldType
statusstr
valuestr | None
reasonstr | None
sourcestr
originstr
observed_atstr

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

class SoftwareEntry

One selected software component.

Fields

The mapping exposes the following typed fields:

FieldType
rolestr
kindstr
namestr
versionVersionObservation

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


class SoftwareEnvironment

Observed installation context and selected coverage.

Fields

The mapping exposes the following typed fields:

FieldType
context_refstr
participantsSequence[str]
statusstr
completebool
reasonstr | None
entriesSequence[SoftwareEntry]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

class ExecutionEvidence

Selected software evidence; malformed reports become explicit coverage gaps.

Fields

The mapping exposes the following typed fields:

FieldType
software_environmentsSequence[SoftwareEnvironment]
infrastructureMapping[str, Any] | None

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

class RunResult

Normalized terminal result from one NeMo Fabric invocation.

The model is both attribute-accessible and mapping-compatible. A harness failure can be represented by status and error without raising when the adapter successfully returns a normalized result.

Attributes:

  • agent_name: Resolved agent name.
  • harness: Stable harness identifier.
  • adapter_kind: Adapter execution mechanism.
  • adapter_id: NeMo Fabric adapter identifier.
  • runtime_id: Runtime lifecycle identifier.
  • invocation_id: Identifier for this invocation.
  • request_id: Correlated request identifier.
  • status: Terminal invocation status.
  • output: Object-shaped adapter output as RunOutput; non-object values are preserved as-is.
  • error: Structured failure, or None on success.
  • usage: Normalized invocation usage, or None when unavailable.
  • execution: Selected software inventories and conditional owner reports, or None in older results and when collection is disabled.
  • resource_snapshot: Runtime resource snapshot read once after the adapter returned this result, or None when the runtime’s resources could not be observed.
  • system_stats: Invocation duration and endpoint observations, or None for older results or execution backends without collection.
  • artifacts: Normalized artifact manifest.
  • telemetry: Ordered telemetry references.
  • events: Ordered lifecycle and invocation events.
  • metadata: Result-specific structured details.

Fields

The mapping exposes the following typed fields:

FieldType
agent_namestr
harnessstr
adapter_kindstr
adapter_idstr
runtime_idstr
invocation_idstr
request_idstr
statusstr
outputRunOutput | JSONValue
errorErrorInfo | None
usageRunUsage | None
system_statsInvocationSystemStats | None
executionExecutionEvidence | None
resource_snapshotRuntimeResourceSnapshot | None
artifactsArtifactManifest
telemetrySequence[TelemetryRef]
eventsSequence[FabricEvent]
metadataMapping[str, Any]

method __init__

def __init__(mapping: Mapping[str, Any]) -> None

property extra_fields

Return an immutable view of preserved extension fields.


classmethod from_mapping

def from_mapping(mapping: Mapping[str, Any]) -> Self

Validate and copy a mapping into the requested typed model.


method to_dict

def to_dict() -> dict[str, Any]

Return the same detached representation as to_mapping().


method to_mapping

def to_mapping() -> dict[str, Any]

Return a detached, JSON-compatible mapping for serialization.


This file was automatically generated via lazydocs.