Report Templates

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.report_templates.list(page=1, page_size=25)

result = await client.report_templates.a_list(...)

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.reportTemplates.list({ page: 1, pageSize: 25 });

from confident_ai import ConfidentAI
from confident_ai.report_templates import ReportTemplateSectionConfig
from confident_ai.report_templates import ReportTemplateSectionContent
from confident_ai.report_templates import ReportTemplateSectionSeverity
from confident_ai.report_templates import ReportTemplateSectionType
from confident_ai.common import ScheduleIntervalUnit
from confident_ai.common import ScheduleRecurrenceType

client = ConfidentAI()

result = client.report_templates.create(
    name="Weekly Health Check",
    description="Give me an overall health check for the last week: request volume, error rate, latency, total cost and user activity.",
    template_sections=[
        ReportTemplateSectionConfig(
            id="<REPORT-TEMPLATE-SECTION-ID>",
            type=ReportTemplateSectionType.CONTENT,
            heading="What's Failing",
            use_ai=True,
            prompt="Summarize the dominant failure modes in 2-4 sentences, citing error counts.",
            content=ReportTemplateSectionContent(
                text="Generated daily for the platform team.",
                severity=ReportTemplateSectionSeverity.INFO
            ),
            start_on_new_page=False
        )
    ],
    enabled=True,
    recurrence=ScheduleRecurrenceType.ONCE,
    repeat_every=1,
    repeat_unit=ScheduleIntervalUnit.MINUTE,
    start_at="2025-02-01T09:00:00+00:00",
    max_runs=12,
    end_at="2025-12-31T23:59:59+00:00",
)

result = await client.report_templates.a_create(...)

import { ConfidentAI } from "confident-ai";
import {
  ScheduleIntervalUnit,
  ScheduleRecurrenceType,
} from "confident-ai/common";
import {
  ReportTemplateSectionSeverity,
  ReportTemplateSectionType,
} from "confident-ai/report-templates";

const client = new ConfidentAI();

const result = await client.reportTemplates.create(
  "Weekly Health Check",
  {
    description: "Give me an overall health check for the last week: request volume, error rate, latency, total cost and user activity.",
    templateSections: [
      {
        id: "<REPORT-TEMPLATE-SECTION-ID>",
        type: ReportTemplateSectionType.CONTENT,
        heading: "What's Failing",
        useAI: true,
        prompt: "Summarize the dominant failure modes in 2-4 sentences, citing error counts.",
        content: {
            text: "Generated daily for the platform team.",
            severity: ReportTemplateSectionSeverity.INFO
          },
        startOnNewPage: false
      }
    ],
    enabled: true,
    recurrence: ScheduleRecurrenceType.ONCE,
    repeatEvery: 1,
    repeatUnit: ScheduleIntervalUnit.MINUTE,
    startAt: "2025-02-01T09:00:00+00:00",
    maxRuns: 12,
    endAt: "2025-12-31T23:59:59+00:00"
  },
);

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.report_templates.get(
    report_template_id="<REPORT-TEMPLATE-ID>",
)

result = await client.report_templates.a_get(...)

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.reportTemplates.get("<REPORT-TEMPLATE-ID>");

from confident_ai import ConfidentAI
from confident_ai.report_templates import ReportTemplateSectionConfig
from confident_ai.report_templates import ReportTemplateSectionContent
from confident_ai.report_templates import ReportTemplateSectionSeverity
from confident_ai.report_templates import ReportTemplateSectionType
from confident_ai.common import ScheduleIntervalUnit
from confident_ai.common import ScheduleRecurrenceType

client = ConfidentAI()

result = client.report_templates.update(
    report_template_id="<REPORT-TEMPLATE-ID>",
    name="Weekly Production Health",
    description="How did production do this week compared with the week before?",
    template_sections=[
        ReportTemplateSectionConfig(
            id="<REPORT-TEMPLATE-SECTION-ID>",
            type=ReportTemplateSectionType.CONTENT,
            heading="What's Failing",
            use_ai=True,
            prompt="Summarize the dominant failure modes in 2-4 sentences, citing error counts.",
            content=ReportTemplateSectionContent(
                text="Generated daily for the platform team.",
                severity=ReportTemplateSectionSeverity.INFO
            ),
            start_on_new_page=False
        )
    ],
    enabled=False,
    recurrence=ScheduleRecurrenceType.ONCE,
    repeat_every=1,
    repeat_unit=ScheduleIntervalUnit.MINUTE,
    start_at="2025-02-01T09:00:00+00:00",
    max_runs=12,
    end_at="2025-12-31T23:59:59+00:00",
)

result = await client.report_templates.a_update(...)

import { ConfidentAI } from "confident-ai";
import {
  ScheduleIntervalUnit,
  ScheduleRecurrenceType,
} from "confident-ai/common";
import {
  ReportTemplateSectionSeverity,
  ReportTemplateSectionType,
} from "confident-ai/report-templates";

const client = new ConfidentAI();

const result = await client.reportTemplates.update(
  "<REPORT-TEMPLATE-ID>",
  {
    name: "Weekly Production Health",
    description: "How did production do this week compared with the week before?",
    templateSections: [
      {
        id: "<REPORT-TEMPLATE-SECTION-ID>",
        type: ReportTemplateSectionType.CONTENT,
        heading: "What's Failing",
        useAI: true,
        prompt: "Summarize the dominant failure modes in 2-4 sentences, citing error counts.",
        content: {
            text: "Generated daily for the platform team.",
            severity: ReportTemplateSectionSeverity.INFO
          },
        startOnNewPage: false
      }
    ],
    enabled: false,
    recurrence: ScheduleRecurrenceType.ONCE,
    repeatEvery: 1,
    repeatUnit: ScheduleIntervalUnit.MINUTE,
    startAt: "2025-02-01T09:00:00+00:00",
    maxRuns: 12,
    endAt: "2025-12-31T23:59:59+00:00"
  },
);

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.report_templates.delete(
    report_template_id="<REPORT-TEMPLATE-ID>",
)

result = await client.report_templates.a_delete(...)

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.reportTemplates.delete("<REPORT-TEMPLATE-ID>");

class ReportTemplate:
    id: str
    name: str
    description: Optional[str]
    type: Optional[ReportTemplateType]
    enabled: bool
    created_at: str = Field(alias="createdAt")
    schedule: Optional[ReportTemplateSchedule]
    template_sections: List[ReportTemplateSection] = Field(alias="templateSections")

interface ReportTemplate {
  id: string;
  name: string;
  description: string | null;
  type: ReportTemplateType | null;
  enabled: boolean;
  createdAt: string;
  schedule: ReportTemplateSchedule | null;
  templateSections: ReportTemplateSection[];
}

class ReportTemplateList:
    report_templates: List[ReportTemplateSummary] = Field(alias="reportTemplates")
    total_report_templates: int = Field(alias="totalReportTemplates")
    page: int
    page_size: int = Field(alias="pageSize")

interface ReportTemplateList {
  reportTemplates: ReportTemplateSummary[];
  totalReportTemplates: number;
  page: number;
  pageSize: number;
}

class ReportTemplateRef:
    id: str

interface ReportTemplateRef {
  id: string;
}

class ReportTemplateSchedule:
    recurrence: ScheduleRecurrenceType
    repeat_every: Optional[int] = Field(alias="repeatEvery")
    repeat_unit: Optional[ScheduleIntervalUnit] = Field(alias="repeatUnit")
    start_at: Optional[str] = Field(alias="startAt")
    max_runs: Optional[int] = Field(alias="maxRuns")
    end_at: Optional[str] = Field(alias="endAt")
    run_count: int = Field(alias="runCount")
    last_run_at: Optional[str] = Field(alias="lastRunAt")

interface ReportTemplateSchedule {
  recurrence: ScheduleRecurrenceType;
  repeatEvery: number | null;
  repeatUnit: ScheduleIntervalUnit | null;
  startAt: string | null;
  maxRuns: number | null;
  endAt: string | null;
  runCount: number;
  lastRunAt: string | null;
}

class ReportTemplateSection:
    id: str
    type: ReportTemplateSectionType
    heading: Optional[str]
    order: int
    use_ai: bool = Field(alias="useAI")
    prompt: Optional[str]
    content: Optional[ReportTemplateSectionContent]
    start_on_new_page: bool = Field(alias="startOnNewPage")

interface ReportTemplateSection {
  id: string;
  type: ReportTemplateSectionType;
  heading: string | null;
  order: number;
  useAI: boolean;
  prompt: string | null;
  content: ReportTemplateSectionContent | null;
  startOnNewPage: boolean;
}

class ReportTemplateSectionConfig:
    id: Optional[str] = None
    type: ReportTemplateSectionType
    heading: Optional[str] = None
    use_ai: Optional[bool] = Field(default=None, alias="useAI")
    prompt: Optional[str] = None
    content: Optional[ReportTemplateSectionContent] = None
    start_on_new_page: Optional[bool] = Field(default=None, alias="startOnNewPage")

interface ReportTemplateSectionConfig {
  id?: string;
  type: ReportTemplateSectionType;
  heading?: string | null;
  useAI?: boolean;
  prompt?: string | null;
  content?: ReportTemplateSectionContent | null;
  startOnNewPage?: boolean;
}

class ReportTemplateSectionContent:
    text: Optional[str] = None
    severity: Optional[ReportTemplateSectionSeverity] = None

interface ReportTemplateSectionContent {
  text?: string | null;
  severity?: ReportTemplateSectionSeverity | null;
}

class ReportTemplateSectionSeverity(Enum):
    INFO = "INFO"
    SUCCESS = "SUCCESS"
    WARNING = "WARNING"
    DANGER = "DANGER"

enum ReportTemplateSectionSeverity {
  INFO = "INFO",
  SUCCESS = "SUCCESS",
  WARNING = "WARNING",
  DANGER = "DANGER",
}

class ReportTemplateSectionType(Enum):
    CONTENT = "CONTENT"
    STAT_CARDS = "STAT_CARDS"
    TABLE = "TABLE"
    GRAPH = "GRAPH"
    ADMONITION = "ADMONITION"

enum ReportTemplateSectionType {
  CONTENT = "CONTENT",
  STAT_CARDS = "STAT_CARDS",
  TABLE = "TABLE",
  GRAPH = "GRAPH",
  ADMONITION = "ADMONITION",
}

class ReportTemplateSummary:
    id: str
    name: str
    description: Optional[str]
    type: Optional[ReportTemplateType]
    enabled: bool
    created_at: str = Field(alias="createdAt")

interface ReportTemplateSummary {
  id: string;
  name: string;
  description: string | null;
  type: ReportTemplateType | null;
  enabled: boolean;
  createdAt: string;
}

class ReportTemplateType(Enum):
    RISK_ASSESSMENT_REPORT = "RISK_ASSESSMENT_REPORT"
    EXECUTIVE_REPORT = "EXECUTIVE_REPORT"

enum ReportTemplateType {
  RISK_ASSESSMENT_REPORT = "RISK_ASSESSMENT_REPORT",
  EXECUTIVE_REPORT = "EXECUTIVE_REPORT",
}

class ScheduleIntervalUnit(Enum):
    MINUTE = "MINUTE"
    HOUR = "HOUR"
    DAY = "DAY"
    WEEK = "WEEK"
    MONTH = "MONTH"

enum ScheduleIntervalUnit {
  MINUTE = "MINUTE",
  HOUR = "HOUR",
  DAY = "DAY",
  WEEK = "WEEK",
  MONTH = "MONTH",
}

class ScheduleRecurrenceType(Enum):
    ONCE = "ONCE"
    INTERVAL = "INTERVAL"

enum ScheduleRecurrenceType {
  ONCE = "ONCE",
  INTERVAL = "INTERVAL",
}