Reports

Create and manage model reports.

All methods are accessed via client.reports.

available_widgets()

Return the available widget tags and their descriptions. Visual widgets (baseValue, confusionMatrix, etc.) should be used at most once per report. Text widgets (h2, p, divider) can repeat.

Returns

dict

Example

1result = client.reports.available_widgets()

---

create_report()

Start async report generation via the wizard.

Parameters

run_idstrRequired

report_namestrRequired

report_descriptionstrdefault: ''

is_publicbooldefault: False

widgetslistdefault: None

modestrdefault: 'dynamic'

max_featuresintdefault: 40

constraintsDictdefault: None

audienceDictdefault: None

Returns

dict — Dict with job_id and status ("accepted")

Example

1result = client.reports.create_report(

2 run_id="run_abc123",

3 report_name="Model Report",

4 report_description="Detailed analysis",

5 is_public=False,

6 widgets=[],

7 mode="dynamic"

8)

---

get_job_status()

Get the status of a wizard report job.

Parameters

job_idstrRequired

Returns

dict

Example

1result = client.reports.get_job_status(

2 job_id="job_abc123"

3)

---

create_report_sync()

Create a report synchronously (polls until complete or timeout).

Parameters

run_idstrRequired

report_namestrRequired

report_descriptionstrdefault: ''

is_publicbooldefault: False

widgetslistdefault: None

modestrdefault: 'dynamic'

max_featuresintdefault: 40

constraintsDictdefault: None

audienceDictdefault: None

timeoutintdefault: 120

poll_intervalfloatdefault: 2.0

Returns

dict — Dict with status, report_id, version_id

Example

1result = client.reports.create_report_sync(

2 run_id="run_abc123",

3 report_name="Model Report",

4 report_description="Detailed analysis",

5 is_public=False,

6 widgets=[],

7 mode="dynamic"

8)

---