Manage Audit Configurations

An AuditConfig selects which garak probes and detectors run during an audit, how many generations to make per probe, and where the reports land. Configurations are persisted in the NeMo Platform entity store and referenced by name from client.auditor.run(...).

What an AuditConfig Holds

A configuration has four sub-blocks plus a free-form description. Each sub-block has sensible defaults, so a minimal configuration only needs a workspace and a name.

The full field reference is in Configuration Schema.

The Seeded Default

The plugin seeds a default configuration in the system workspace at install time. Retrieve it to see a reasonable starting point:

1
default_config = client.auditor.configs.get(workspace="system", name="default")
2
print(default_config.model_dump_json(indent=2))

You can pass "system/default" directly to client.auditor.run(config=..., ...) to run an audit with the seeded configuration without creating your own.

Create a Configuration

Build a configuration by populating any of the four sub-blocks. Omitted sub-blocks fall back to their pydantic defaults.

1
from nemo_auditor.entities import (
2
    AuditPluginsData,
3
    AuditReportData,
4
    AuditRunData,
5
    AuditSystemData,
6
)
7
8
9
config = client.auditor.configs.create(
10
    workspace="default",
11
    name="quick-scan",
12
    description="Lite latentinjection scan, 3 generations per probe.",
13
    system=AuditSystemData(lite=True, parallel_attempts=4),
14
    run=AuditRunData(generations=3),
15
    plugins=AuditPluginsData(probe_spec="latentinjection", detector_spec="auto"),
16
    reporting=AuditReportData(report_prefix="quick-scan"),
17
)

The probe_spec field takes a comma-separated list of probe categories or fully-qualified probe classes. See Selecting Probes for the syntax and worked examples.

List Configurations

1
listing = client.auditor.configs.list(workspace="default")
2
for entry in listing["data"]:
3
    print(entry["name"], entry["description"])

list() returns the standard envelope (data, pagination, sort); pass page, page_size, and sort keyword arguments for pagination.

Retrieve a Configuration

1
config = client.auditor.configs.get(workspace="default", name="quick-scan")

Update a Configuration

update() replaces every sub-block — any sub-block you omit resets to its default. Pass each block you want to keep.

1
updated = client.auditor.configs.update(
2
    workspace="default",
3
    name="quick-scan",
4
    description="Updated probe selection.",
5
    system=AuditSystemData(parallel_attempts=8),
6
    run=AuditRunData(generations=5),
7
    plugins=AuditPluginsData(probe_spec="latentinjection,encoding.InjectROT13"),
8
    reporting=AuditReportData(report_prefix="quick-scan"),
9
)

Delete a Configuration

1
client.auditor.configs.delete(workspace="default", name="quick-scan")