> This page is for NeMo Fabric, version v0.5.0. > For other versions, use one of these documentation indexes: > - Latest (v0.4.0) (default): https://docs.nvidia.com/nemo/fabric/latest/llms.txt > - dev: https://docs.nvidia.com/nemo/fabric/dev/llms.txt > - v0.5.0: https://docs.nvidia.com/nemo/fabric/v0.5.0/llms.txt > - v0.4.0: https://docs.nvidia.com/nemo/fabric/v0.4.0/llms.txt > - v0.3.0: https://docs.nvidia.com/nemo/fabric/v0.3.0/llms.txt > - v0.2.0: https://docs.nvidia.com/nemo/fabric/v0.2.0/llms.txt > - v0.1.1: https://docs.nvidia.com/nemo/fabric/v0.1.1/llms.txt > - v0.1.0: https://docs.nvidia.com/nemo/fabric/v0.1.0/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/nemo/fabric/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/fabric/_mcp/server. # Python SDK Reference > Complete reference for the public NeMo Fabric Python SDK. # API Overview ## Modules - [`nemo_fabric.client`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/client#module-nemo_fabricclient): Native Python client for resolving and running NVIDIA NeMo Fabric agents. - [`nemo_fabric.capabilities`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/capabilities#module-nemo_fabriccapabilities): Metadata-only adapter inspection for host-side admission. - [`nemo_fabric.runtime`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/runtime#module-nemo_fabricruntime): Runtime lifecycle support for the NVIDIA NeMo Fabric Python SDK. - [`nemo_fabric.service`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/service#module-nemo_fabricservice): Long-lived service lifecycle support for the NeMo Fabric Python SDK. - [`nemo_fabric.streaming`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/streaming#module-nemo_fabricstreaming): NVIDIA NeMo Relay streaming support for the NVIDIA NeMo Fabric Python SDK. - [`nemo_fabric.openai_streaming`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/openai-streaming#module-nemo_fabricopenai_streaming): Adapter-native OpenAI streaming for the NVIDIA NeMo Fabric Python SDK. - [`nemo_fabric.models`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#module-nemo_fabricmodels): Pydantic SDK models for NVIDIA NeMo Fabric configuration and requests. - [`nemo_fabric.types`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#module-nemo_fabrictypes): Public data contracts for the NeMo Fabric Python SDK. - [`nemo_fabric.errors`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#module-nemo_fabricerrors): Public exception hierarchy for the NeMo Fabric Python SDK. ## Classes - [`client.Fabric`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/client#class-fabric): Primary Python entrypoint for NeMo Fabric. - [`capabilities.AdapterCapabilityProfile`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/capabilities#class-adaptercapabilityprofile): Declared support for a standalone runtime, not observed execution provenance. - [`runtime.Runtime`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/runtime#class-runtime): One logical, stateful harness execution. - [`runtime.RuntimeStatus`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/runtime#class-runtimestatus): Lifecycle state of a runtime. - [`service.Service`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/service#class-service): One prepared or attached long-lived adapter service. - [`service.ServiceStatus`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/service#class-servicestatus): Lifecycle state of a prepared or attached service. - [`streaming.InvokeStream`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/streaming#class-invokestream): Async iterator of raw ATOF records for one runtime invocation. - [`openai_streaming.OpenAIInvokeStream`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/openai-streaming#class-openaiinvokestream): Async iterator of OpenAI chat-completion chunks for one invocation. - [`models.DiscoveryConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-discoveryconfig): Explicit local descriptor discovery paths. - [`models.EnvironmentConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-environmentconfig): Execution environment configuration supplied by the consumer. - [`models.FabricBaseModel`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-fabricbasemodel): Base class for SDK-facing Pydantic models. - [`models.FabricConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-fabricconfig): SDK-facing typed NeMo Fabric agent configuration. - [`models.HarnessConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-harnessconfig): Harness adapter selection plus adapter-owned settings. - [`models.InstructionConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-instructionconfig): One portable instruction value. - [`models.InstructionsConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-instructionsconfig): Harness-neutral agent instructions. - [`models.McpAuthenticationConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-mcpauthenticationconfig): MCP server authentication configuration. - [`models.McpConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-mcpconfig): MCP capability configuration. - [`models.McpServerConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-mcpserverconfig): MCP server configuration. - [`models.MetadataConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-metadataconfig): Human-readable agent identity. - [`models.ModelConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-modelconfig): Configuration for one model role. - [`models.RelayAtifConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayatifconfig): NeMo Relay ATIF export configuration. - [`models.RelayAtofConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayatofconfig): NeMo Relay ATOF export configuration. - [`models.RelayAtofFileSinkConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayatoffilesinkconfig): NeMo Relay ATOF file sink configuration. - [`models.RelayAtofStreamSinkConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayatofstreamsinkconfig): NeMo Relay ATOF stream sink configuration. - [`models.RelayComponentConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relaycomponentconfig): Generic NeMo Relay plugin component configuration. - [`models.RelayConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayconfig): First-class NeMo Relay integration configuration. - [`models.RelayConfigPolicy`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayconfigpolicy): NeMo Relay config validation policy. - [`models.RelayHttpStorageConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayhttpstorageconfig): NeMo Relay ATIF HTTP storage configuration. - [`models.RelayObservabilityConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayobservabilityconfig): NeMo Relay observability component configuration. - [`models.RelayOpenTelemetryConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayopentelemetryconfig): NeMo Relay typed OpenTelemetry destination configuration. - [`models.RelayOpenTelemetryEndpointConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relayopentelemetryendpointconfig): One typed NeMo Relay OpenTelemetry destination. - [`models.RelayS3StorageConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-relays3storageconfig): NeMo Relay ATIF S3 storage configuration. - [`models.RunRequest`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-runrequest): One validated NeMo Fabric invocation request. - [`models.RuntimeConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-runtimeconfig): Invocation runtime contract. - [`models.SkillConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-skillconfig): Skill capability configuration. - [`models.TelemetryConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-telemetryconfig): Telemetry configuration. - [`models.TelemetryProviderConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-telemetryproviderconfig): Provider-specific telemetry configuration. - [`models.ToolDefinitionConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-tooldefinitionconfig): One named normalized tool or tool-group definition. - [`models.ToolsConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-toolsconfig): Harness-neutral tool capability configuration. - [`models.WorkflowConfig`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/models#class-workflowconfig): Registered workflow target and immutable construction settings. - [`types.AdapterInfo`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-adapterinfo): Resolved adapter identity attached to a run plan. - [`types.ArtifactManifest`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-artifactmanifest): Normalized collection of artifacts produced by a run. - [`types.ArtifactRef`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-artifactref): Reference to one artifact produced by a run. - [`types.DoctorCheck`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-doctorcheck): One diagnostic check in a ``DoctorReport``. - [`types.DoctorReport`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-doctorreport): Aggregate preflight diagnostics for a resolved run plan. - [`types.ErrorInfo`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-errorinfo): Structured failure returned inside a normalized ``RunResult``. - [`types.FabricEvent`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-fabricevent): One normalized lifecycle or invocation event. - [`types.RunOutput`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-runoutput): Normalized adapter output. - [`types.RunPlan`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-runplan): Immutable execution plan produced before a runtime is started. - [`types.RunResult`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-runresult): Normalized terminal result from one NeMo Fabric invocation. - [`types.RunUsage`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-runusage): Normalized invocation-local usage reported by an adapter target. - [`types.RuntimeCapabilities`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-runtimecapabilities): Operations declared by the resolved runtime and adapter. - [`types.RuntimeHandle`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-runtimehandle): Opaque identity and binding for one started runtime. - [`types.ServiceHandle`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-servicehandle): Opaque identity and binding for one prepared or attached service. - [`types.ServiceReference`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-servicereference): Reference to an already-running caller-owned service. - [`types.TelemetryRef`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/types#class-telemetryref): Reference to external or persisted telemetry for a run. - [`errors.FabricCapabilityError`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#class-fabriccapabilityerror): Operation rejected by resolved runtime capabilities or implementation status. - [`errors.FabricConfigError`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#class-fabricconfigerror): Invalid SDK input, request shape, factory, or resolved config. - [`errors.FabricError`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#class-fabricerror): Base class for structured SDK-level NeMo Fabric errors. - [`errors.FabricNativeUnavailableError`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#class-fabricnativeunavailableerror): SDK call requires the PyO3 extension, but it is not installed or importable. - [`errors.FabricRuntimeError`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#class-fabricruntimeerror): Failure while starting, invoking, stopping, or otherwise driving a runtime. - [`errors.FabricStateError`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/errors#class-fabricstateerror): Operation rejected because a local runtime is in the wrong state. ## Functions - [`capabilities.inspect_adapter`](/nemo/fabric/v0.5.0/reference/api/python-library-reference/capabilities#function-inspect_adapter): Inspect a standalone runtime using descriptor metadata without loading its SDK. --- _This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._