DeepTeam is a framework to red team LLMs and AI agents.
rename
A-Vamshif7fd6fd7df97
diff --git a/docs/guides/guide-custom-vulnerability.mdx b/docs/guides/guide-custom-vulnerability.mdxindex fe2509fb..16426320 100644--- a/docs/guides/guide-custom-vulnerability.mdx+++ b/docs/guides/guide-custom-vulnerability.mdx@@ -33,7 +33,7 @@ To begin, create a class that inherits from `deepteam`'s `BaseVulnerability` cla```pythonfrom deepteam.vulnerabilities import BaseVulnerability-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):...```@@ -57,7 +57,7 @@ from typing import List, Optional, Unionfrom enum import Enumfrom deepeval.models import DeepEvalBaseLLM-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):def __init__(self,types: List[str],@@ -90,7 +90,7 @@ Create a method that returns a prompt template that allows you to generate a lis```pythonfrom deepteam.vulnerabilities import BaseVulnerability-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):...def get_prompt_template(self, name, vulnerability_type, max_goldens, prupose):return f"""@@ -148,7 +148,7 @@ from deepteam.attacks.attack_simulator.schema import SyntheticDataListfrom deepeval.metrics.utils import initialize_model-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):...def simulate_attacks(self,@@ -213,7 +213,7 @@ The `_get_metric()` method **MUST** take a `type` as an argument. This argument```pythonfrom deepteam.vulnerabilities import BaseVulnerability-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):def __init__(...):...self.type_to_criteria = {@@ -230,7 +230,7 @@ Now use the type to fetch the `HarmMetric` using the `_get_metric()` method.from deepteam.vulnerabilities import BaseVulnerabilityfrom deepteam.metrics import HarmMetric-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):...def _get_metric(self, type: str):return HarmMetric(@@ -252,7 +252,7 @@ Now, all that's left is to name your custom vulnerability as a cherry on top.```pythonfrom deepteam.vulnerabilities import BaseVulnerability-class CustomVulnerability(BaseVulnerability):+class MyCustomVulnerability(BaseVulnerability):...def get_name(self):return "My Custom Vulnerability"