AI Reports
Generate AI-powered model reports and explanations.
All methods are accessed via client.gpt.
generate_report()
POST/v1/models/report/generate
Generate a GPT-powered report for a model.
Parameters
model_idstrRequired
ID of the model
version_idstrRequired
ID of the model version
target_descriptionstrdefault:
'text'Description of the target variable
project_objectivestrdefault:
'text'Objective of the project/model
max_featuresintdefault:
15Maximum number of features to include in report
temperaturefloatdefault:
0.7GPT temperature parameter (0-2, higher = more creative)
Returns
GPTReportResponse — Generated report with insights
Example
1result = client.gpt.generate_report(
2 model_id="model_abc123",
3 version_id="version_xyz789",
4 target_description="Customer churn",
5 project_objective="Predict which customers will churn",
6 max_features=15,
7 temperature=0.7
8)
explain_model()
POST/v1/models/explain
Get a natural language explanation of the model.
Parameters
model_idstrRequired
ID of the model
version_idstrRequired
ID of the model version
languagestrdefault:
'en'Language for the explanation (e.g., "en", "es", "fr")
detail_levelstrdefault:
'medium'Level of detail ("low", "medium", "high")
Returns
ModelExplanationResponse — Natural language explanation of the model
Example
1result = client.gpt.explain_model(
2 model_id="model_abc123",
3 version_id="version_xyz789",
4 language="en",
5 detail_level="medium"
6)
generate_documentation()
Generate comprehensive documentation for a model.
Parameters
model_idstrRequired
ID of the model
version_idstrRequired
ID of the model version
include_technicalbooldefault:
TrueInclude technical details
include_businessbooldefault:
TrueInclude business context
formatstrdefault:
'markdown'Output format ("markdown", "html", "pdf")
Returns
str — Generated documentation
Example
1result = client.gpt.generate_documentation(
2 model_id="model_abc123",
3 version_id="version_xyz789",
4 include_technical=True,
5 include_business=True,
6 format="markdown"
7)