ReferenceAPIPython Library Reference

Models

View as Markdown

module nemo_fabric.models

Pydantic SDK models for NVIDIA NeMo Fabric configuration and requests.

The Rust core remains the source of truth for persisted schema snapshots. These models provide the Python SDK’s typed authoring surface and intentionally keep extension fields so consumers can carry adapter- or application-owned data without waiting for a schema release.


class FabricBaseModel

Base class for SDK-facing Pydantic models.


property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class MetadataConfig

Human-readable agent identity.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
namestrYesMinLen(min_length=1)
descriptionstr | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class HarnessConfig

Harness adapter selection plus adapter-owned settings.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
adapter_idstrYesMinLen(min_length=1)
resolutionLiteral['preinstalled', 'image_provided', 'pip_uv', 'npm', 'source', 'service', 'native_plugin'] | NoneNoNone
settingsdict[str, Any]Nodict()

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class InstructionConfig

One portable instruction value.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
contentstrYesMinLen(min_length=1), _PydanticGeneralMetadata(pattern='\\S')
modeLiteral['replace']No'replace'

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class InstructionsConfig

Harness-neutral agent instructions.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
systemInstructionConfig | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RuntimeConfig

Invocation runtime contract.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
input_schemastr | NoneNoNone
output_schemastr | NoneNoNone
artifactsstr | Path | NoneNoNone
timeout_secondsfloat | NoneNoNoneGt(gt=0), _PydanticGeneralMetadata(allow_inf_nan=False)
max_turnsint | NoneNoNoneGt(gt=0), Le(le=4294967295)

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class EnvironmentConfig

Execution environment configuration supplied by the consumer.

provider selects the environment implementation. workspace is the path visible to the harness, while artifacts is the provider-specific output location. settings configures the selected provider; connection describes how NeMo Fabric reaches an existing environment; and metadata carries consumer-owned values that NeMo Fabric does not interpret. ownership identifies who tears the environment down, and control_location identifies whether NeMo Fabric control code runs inside or outside it.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
providerstrNo'local'MinLen(min_length=1)Environment provider, such as local, docker, opensandbox, or k8s.
workspacestr | Path | NoneNoNoneWorkspace path visible to the harness.
artifactsstr | Path | NoneNoNoneEnvironment-specific artifact path.
envdict[str, str]Nodict()Environment variables visible to the harness and its tools. Values are serialized into configuration and run plans; prefer api_key_env-style environment-variable-name indirection for credentials.
settingsdict[str, Any]Nodict()Provider-specific configuration interpreted by the environment provider.
metadatadict[str, Any]Nodict()Consumer-owned environment metadata passed through without NeMo Fabric semantics.
connectiondict[str, Any]Nodict()Connection data for an existing environment, such as URL, namespace, or credential reference.
ownershipLiteral['caller_owned', 'fabric_owned']No'caller_owned'Whether the caller or NeMo Fabric owns environment teardown.
control_locationLiteral['external_control', 'in_env_control']No'in_env_control'Whether NeMo Fabric control code runs outside or inside the environment.

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class ModelConfig

Configuration for one model role.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
providerstrYesMinLen(min_length=1)
modelstrYesMinLen(min_length=1)
api_key_envstr | NoneNoNone
temperaturefloat | NoneNoNone
base_urlstr | NoneNoNoneMinLen(min_length=1)
settingsdict[str, Any]Nodict()

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class SkillConfig

Skill capability configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
pathslist[str | Path]Nolist()

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


method add_path

1def add_path(path: str | Path) -> Self

Add a skill path if absent.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method remove_path

1def remove_path(path: str | Path) -> Self

Remove a skill path if present.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class McpServerConfig

MCP server configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
transportstrYesMinLen(min_length=1)
urlstrYesMinLen(min_length=1)
exposureLiteral['harness_native', 'fabric_managed']No'harness_native'

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class McpConfig

MCP capability configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
serversdict[str, McpServerConfig]Nodict()

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


method add_server

1def add_server(
2 name: str,
3 *,
4 transport: str,
5 url: str,
6 exposure: Literal['harness_native', 'fabric_managed'] = 'harness_native',
7 extra_fields: Mapping[str, Any] | None = None,
8) -> Self

Add or replace a named MCP server.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method remove_server

1def remove_server(name: str) -> Self

Remove a named MCP server if present.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayConfigPolicy

NVIDIA NeMo Relay config validation policy.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
unknown_componentLiteral['ignore', 'warn', 'error']No'warn'
unknown_fieldLiteral['ignore', 'warn', 'error']No'warn'
unsupported_valueLiteral['ignore', 'warn', 'error']No'error'

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayAtofFileSinkConfig

NeMo Relay ATOF file sink configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
typeLiteral['file']No'file'
output_directorystr | Path | NoneNoNone
filenamestr | NoneNoNone
modeLiteral['append', 'overwrite']No'append'

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayAtofStreamSinkConfig

NeMo Relay ATOF stream sink configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
typeLiteral['stream']No'stream'
urlstrYes
transportLiteral['http_post', 'websocket', 'ndjson']No'http_post'
headersdict[str, str]Nodict()
header_envdict[str, str]Nodict()
timeout_millisintNo3000
field_name_policyLiteral['preserve', 'replace_dots']No'preserve'
namestr | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayAtofConfig

NeMo Relay ATOF export configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
enabledboolNoFalse
sinkslist[Annotated[RelayAtofFileSinkConfig | RelayAtofStreamSinkConfig, Field(discriminator='type')] | dict[str, Any]] | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayS3StorageConfig

NeMo Relay ATIF S3 storage configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
typeLiteral['s3']No's3'
bucketstrNo''
key_prefixstr | NoneNoNone
access_key_idstr | NoneNoNone
secret_access_key_varstr | NoneNoNone
session_token_varstr | NoneNoNone
regionstr | NoneNoNone
endpoint_urlstr | NoneNoNone
allow_httpbool | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayHttpStorageConfig

NeMo Relay ATIF HTTP storage configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
typeLiteral['http']No'http'
endpointstrNo''
headersdict[str, str]Nodict()
header_envdict[str, str]Nodict()
timeout_millisintNo3000

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayAtifConfig

NeMo Relay ATIF export configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
enabledboolNoFalse
agent_namestrNo'NeMo Relay'
agent_versionstr | NoneNoNone
model_namestrNo'unknown'
tool_definitionslist[dict[str, Any]] | NoneNoNone
extradict[str, Any] | NoneNoNone
output_directorystr | Path | NoneNoNone
filename_templatestrNo'nemo-relay-atif-{session_id}.json'
storagelist[Annotated[RelayS3StorageConfig | RelayHttpStorageConfig, Field(discriminator='type')] | dict[str, Any]] | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayOtlpConfig

NeMo Relay OTLP export configuration for OpenTelemetry/OpenInference.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
enabledboolNoFalse
transportLiteral['http_binary', 'grpc']No'http_binary'
endpointstr | NoneNoNone
headersdict[str, str]Nodict()
resource_attributesdict[str, str]Nodict()
service_namestrNo'nemo-relay'
service_namespacestr | NoneNoNone
service_versionstr | NoneNoNone
instrumentation_scopestr | NoneNoNone
timeout_millisintNo3000

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayObservabilityConfig

NeMo Relay observability component configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
versionintNo2
atofRelayAtofConfig | dict[str, Any] | NoneNoNone
atifRelayAtifConfig | dict[str, Any] | NoneNoNone
opentelemetryRelayOtlpConfig | dict[str, Any] | NoneNoNone
openinferenceRelayOtlpConfig | dict[str, Any] | NoneNoNone
policyRelayConfigPolicy | dict[str, Any] | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayComponentConfig

Generic NeMo Relay plugin component configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
kindstrYesMinLen(min_length=1)
enabledboolNoTrue
configdict[str, Any]Nodict()

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class RelayConfig

First-class NeMo Relay integration configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
projectstr | NoneNoNone
output_dirstr | Path | NoneNoNone
observabilityRelayObservabilityConfig | dict[str, Any] | NoneNoNone
componentslist[RelayComponentConfig | dict[str, Any]]Nolist()
policyRelayConfigPolicy | dict[str, Any] | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class TelemetryProviderConfig

Provider-specific telemetry configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
configdict[str, Any] | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class TelemetryConfig

Telemetry configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
providersdict[Literal['relay', 'native'], TelemetryProviderConfig | dict[str, Any]]Nodict()

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


method enable_native

1def enable_native(*, config: Mapping[str, Any] | None = None) -> Self

Let the selected adapter handle telemetry natively.


method enable_relay

1def enable_relay() -> Self

Enable NeMo Relay telemetry for subsequently started runtimes.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method remove_provider

1def remove_provider(provider: Literal['relay', 'native']) -> Self

Remove a configured telemetry provider.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class ToolsConfig

Harness-neutral tool capability configuration.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
enabledlist[str] | NoneNoNoneAdapter-native tools to expose. None preserves the harness default; an empty list exposes no tools.
blockedlist[str]Nolist()Adapter-native tool names to deny.

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached JSON-compatible mapping for Rust/core calls.


class FabricConfig

SDK-facing typed NeMo Fabric agent configuration.

NeMo Fabric-owned fields apply uniformly. Adapter-translated fields are checked against the selected descriptor; refer to the normalized configuration compatibility table.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
schema_versionstrNo'fabric.agent/v1alpha1'
metadataMetadataConfigYes
harnessHarnessConfigYes
runtimeRuntimeConfigNoRuntimeConfig()
environmentEnvironmentConfig | NoneNoNone
modelsdict[str, ModelConfig]Nodict()
instructionsInstructionsConfig | NoneNoNone
mcpMcpConfig | NoneNoNone
skillsSkillConfig | NoneNoNone
telemetryTelemetryConfig | NoneNoNone
relayRelayConfig | dict[str, Any] | NoneNoNone
toolsToolsConfig | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


method add_mcp_server

1def add_mcp_server(
2 name: str,
3 *,
4 transport: str,
5 url: str,
6 exposure: Literal['harness_native', 'fabric_managed'] = 'harness_native',
7 extra_fields: Mapping[str, Any] | None = None,
8) -> Self

Add or replace a named MCP server and return this config.


method add_skill_path

1def add_skill_path(path: str | Path) -> Self

Add a skill path and return this config.


method block_tools

1def block_tools(*tools: str) -> Self

Block adapter-native tool names and return this config.


method enable_relay

1def enable_relay(
2 *,
3 project: str | None = None,
4 output_dir: str | Path | None = None,
5 observability: RelayObservabilityConfig | Mapping[str, Any] | None = None,
6 components: Sequence[RelayComponentConfig | Mapping[str, Any]] | None = None,
7 policy: RelayConfigPolicy | Mapping[str, Any] | None = None,
8) -> Self

Enable NeMo Relay telemetry and return this config.


classmethod from_mapping

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

Validate the public agent config mapping shape.


method remove_mcp_server

1def remove_mcp_server(name: str) -> Self

Remove a named MCP server and return this config.


method remove_skill_path

1def remove_skill_path(path: str | Path) -> Self

Remove a skill path and return this config.


method to_mapping

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

Return a detached mapping matching the Rust FabricConfig schema.


class RunRequest

One validated NeMo Fabric invocation request.

Fields

The model defines the following fields:

FieldTypeRequiredDefaultConstraintsDescription
inputAnyNo''
request_idstrNo<generated>MinLen(min_length=1)
contextdict[str, Any]Nodict()
overridesdict[str, Any] | NoneNoNone

property extra_fields

Return fields preserved by the extension point for this model.


property model_extra

Get extra fields set during validation.

Returns: A dictionary of extra fields, or None if config.extra is not set to "allow".


property model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

Returns: A set of strings representing the fields that have been set, i.e. that were not filled from defaults.


classmethod from_mapping

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

Validate a mapping using this Pydantic model.


method to_mapping

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

Return a detached request mapping for the Rust runtime.


This file was automatically generated via lazydocs.