RT Frameworks

from confident_ai import ConfidentAI

client = ConfidentAI()

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

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

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

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

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.rt_frameworks.create(
    name="OWASP Top 10 for LLMs",
    description="Our baseline coverage before each release.",
    template="EU Artificial Intelligence Act",
)

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

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.rtFrameworks.create(
  "OWASP Top 10 for LLMs",
  {
    description: "Our baseline coverage before each release.",
    template: "EU Artificial Intelligence Act"
  },
);

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.rt_frameworks.get(rt_framework_id="<RT-FRAMEWORK-ID>")

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

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.rtFrameworks.get("<RT-FRAMEWORK-ID>");

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.rt_frameworks.update(
    rt_framework_id="<RT-FRAMEWORK-ID>",
    name="OWASP Top 10 for LLMs",
    description="Our baseline coverage before each release.",
)

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

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.rtFrameworks.update(
  "<RT-FRAMEWORK-ID>",
  {
    name: "OWASP Top 10 for LLMs",
    description: "Our baseline coverage before each release."
  },
);

from confident_ai import ConfidentAI

client = ConfidentAI()

result = client.rt_frameworks.delete(rt_framework_id="<RT-FRAMEWORK-ID>")

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

import { ConfidentAI } from "confident-ai";

const client = new ConfidentAI();

const result = await client.rtFrameworks.delete("<RT-FRAMEWORK-ID>");

from confident_ai import ConfidentAI
from confident_ai.rt_frameworks import AttackEngine
from confident_ai.common import GenerationMode
from confident_ai.common import Level

client = ConfidentAI()

result = client.rt_frameworks.run(
    rt_framework_id="<RT-FRAMEWORK-ID>",
    risk_categories=["Data protection"],
    exposure=Level.LOW,
    identifier="pre-release-2025-01",
    ai_connection_id="<AI-CONNECTION-ID>",
    prompt_alias="customer-support",
    prompt_commit="bab04ce",
    generation_mode=GenerationMode.AI_CONNECTION,
    attack_engine=AttackEngine(
        generation_guidelines=[
            "Write in the voice of a frustrated customer."
        ]
    ),
)

result = await client.rt_frameworks.a_run(...)

import { ConfidentAI } from "confident-ai";
import { GenerationMode, Level } from "confident-ai/common";

const client = new ConfidentAI();

const result = await client.rtFrameworks.run(
  "<RT-FRAMEWORK-ID>",
  ["Data protection"],
  Level.LOW,
  {
    identifier: "pre-release-2025-01",
    aiConnectionId: "<AI-CONNECTION-ID>",
    promptAlias: "customer-support",
    promptCommit: "bab04ce",
    generationMode: GenerationMode.AI_CONNECTION,
    attackEngine: {
      generationGuidelines: ["Write in the voice of a frustrated customer."]
    }
  },
);

class AttackEngine:
    generation_guidelines: Optional[List[str]] = Field(default=None, alias="generationGuidelines")

interface AttackEngine {
  generationGuidelines?: string[];
}

class FrameworkAttackMethod:
    name: str
    multi_turn: bool = Field(alias="multiTurn")
    parameters: Optional[Dict[str, Any]]

interface FrameworkAttackMethod {
  name: string;
  multiTurn: boolean;
  parameters: Record<string, unknown> | null;
}

class FrameworkRiskCategory:
    id: str
    name: str
    description: Optional[str]
    vulnerabilities: List[FrameworkVulnerability]
    attack_methods: List[FrameworkAttackMethod] = Field(alias="attackMethods")

interface FrameworkRiskCategory {
  id: string;
  name: string;
  description: string | null;
  vulnerabilities: FrameworkVulnerability[];
  attackMethods: FrameworkAttackMethod[];
}

class FrameworkRiskCategorySummary:
    name: str
    num_vulnerability_types: int = Field(alias="numVulnerabilityTypes")
    num_attack_methods: int = Field(alias="numAttackMethods")

interface FrameworkRiskCategorySummary {
  name: string;
  numVulnerabilityTypes: number;
  numAttackMethods: number;
}

class FrameworkVulnerability:
    name: str
    types: List[str]
    criteria: Optional[str]
    evaluation_guidelines: List[str] = Field(alias="evaluationGuidelines")
    evaluation_examples: Optional[List[FrameworkVulnerabilityEvaluationExample]] = Field(alias="evaluationExamples")

interface FrameworkVulnerability {
  name: string;
  types: string[];
  criteria: string | null;
  evaluationGuidelines: string[];
  evaluationExamples: FrameworkVulnerabilityEvaluationExample[] | null;
}

class GenerationMode(Enum):
    AI_CONNECTION = "AI_CONNECTION"
    PROMPT = "PROMPT"

enum GenerationMode {
  AI_CONNECTION = "AI_CONNECTION",
  PROMPT = "PROMPT",
}

class Level(Enum):
    LOW = "LOW"
    MEDIUM = "MEDIUM"
    HIGH = "HIGH"

enum Level {
  LOW = "LOW",
  MEDIUM = "MEDIUM",
  HIGH = "HIGH",
}

class RTFramework:
    id: str
    name: str
    description: Optional[str]
    risk_categories: List[FrameworkRiskCategory] = Field(alias="riskCategories")

interface RTFramework {
  id: string;
  name: string;
  description: string | null;
  riskCategories: FrameworkRiskCategory[];
}

class RTFrameworkList:
    rt_frameworks: List[RTFrameworkSummary] = Field(alias="rtFrameworks")
    total_rt_frameworks: int = Field(alias="totalRTFrameworks")
    page: int
    page_size: int = Field(alias="pageSize")

interface RTFrameworkList {
  rtFrameworks: RTFrameworkSummary[];
  totalRTFrameworks: number;
  page: number;
  pageSize: number;
}

class RTFrameworkRef:
    id: str

interface RTFrameworkRef {
  id: string;
}

class RTFrameworkSummary:
    id: str
    name: str
    description: Optional[str]
    risk_categories: List[FrameworkRiskCategorySummary] = Field(alias="riskCategories")

interface RTFrameworkSummary {
  id: string;
  name: string;
  description: string | null;
  riskCategories: FrameworkRiskCategorySummary[];
}

class RiskAssessmentRef:
    id: str

interface RiskAssessmentRef {
  id: string;
}