Merge pull request #116 from LLAMATOR-Core/main-3-0-0

Pre-release v3.0.0

Author: RomiconEZ

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.3.1
+current_version = 3.0.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?

CONTRIBUTING.md

@@ -105,18 +105,24 @@ from ..client.client_config import ClientConfig
 logger = logging.getLogger(__name__)
 
 @register_test
-class NewAttack(TestBase):
+class TestNewAttack(TestBase):
     """Your attack description here."""
 
     info = {
         "name": "New Attack",
         "code_name": "new_attack",
-        "tags": [],
+        "tags": [
+            "lang:en",  # languages of available tested models
+            "dialog:single-stage",  # type of dialogs: single-stage or multi-stage
+            "owasp:llm01",  # OWASP TOP 10 for LLM risks
+            "eval:heuristic",  # type of resilience evaluation
+            "arxiv:2504.11111",  # original paper if exists
+        ],
         "description": {
             "en": "Description in English.",
             "ru": "Описание на русском.",
         },
-        "github_link": "Link to original paper/repository, if available",
+        "github_link": "Link to attack in release branch",
     }
 
     def __init__(
@@ -125,15 +131,13 @@ class NewAttack(TestBase):
         attack_config: AttackConfig,
         artifacts_path: Optional[str] = None,
         num_attempts: int = 0,
-        *args,
         **kwargs,
     ):
         super().__init__(
             client_config,
             attack_config,
             artifacts_path=artifacts_path,
             num_attempts=num_attempts,
-            *args,
             **kwargs,
         )
 

README.md

@@ -13,7 +13,7 @@ Red Teaming python-framework for testing chatbots and LLM systems
 ## Install 🚀
 
 ```bash
-pip install llamator==2.3.1
+pip install llamator==3.0.0
 ```
 
 ## Documentation 📚

docs/attack_descriptions.md

@@ -164,11 +164,6 @@ For managing a multi-stage interaction between an attacker and tested chat clien
  * `current_step` is the current step of the attacker.
  * `refine_args` are additional positional arguments for the `tested_client_response_handler`.
  * `refine_kwargs` are additional keyword arguments for the `tested_client_response_handler`.
-
-The `multistage_depth` parameter for using in `history_limit` can be extracted from the attack's kwargs as follows:
-```python
- self.multistage_depth = kwargs.get("multistage_depth", 20)
-```
 </details>
 
 ### OWASP [LLM01:2025](https://genai.owasp.org/llmrisk/llm01-prompt-injection/) Continuous Prompt Injection

docs/howtos.md

@@ -12,7 +12,7 @@
 ## Installation Guide
 
 ```bash
-pip install llamator==2.3.1
+pip install llamator==3.0.0
 ```
 
 ## Usage Guide (using LM Studio)

examples/.env.example

@@ -1,12 +1,6 @@
-OPENAI_CLIENT_API_KEY=lm-studio
-OPENAI_CLIENT_BASEURL=http://localhost:1234/v1
-OPENAI_CLIENT_MODEL=model-identifier
-
-MISTRAL_API_KEY=zzzzz
-MISTRAL_BASEURL=https://api.mistral.ai/v1
-MISTRAL_MODEL=mistral-large-2411
-
-GIGACHAT_KEY=xxxs
+OPENAI_API_KEY=lm-studio
+OPENAI_BASEURL=http://localhost:1234/v1
+OPENAI_MODEL=model-identifier
 
 TELEGRAM_APP_ID=12345678
 TELEGRAM_API_HASH=yyyyy

requirements-dev.txt

@@ -38,5 +38,6 @@ jupyter==1.1.1
 
 # Publish package
 build==1.2.2
-twine==5.1.1
-furo==2024.8.6
+twine==6.1.0
+furo==2024.8.6
+pkginfo==1.12.1.2

src/llamator/__version__.py

@@ -1,5 +1,5 @@
 """Version information."""
 
 # fmt: off
-__version__ = '2.3.1'  # noqa
+__version__ = '3.0.0'  # noqa
 # fmt: on

tests/langchain_client_test.py

@@ -1,15 +1,6 @@
 def langchain_client_openai_backend_test():
     """
     Tests OpenAI client from local llamator lib.
-
-    Environment variables
-    ----------
-    OPENAI_CLIENT_API_KEY : str
-        API key for OpenAI compatible API
-    OPENAI_CLIENT_BASEURL : str
-        URL of OpenAI compatible API
-    OPENAI_CLIENT_MODEL : str
-        Type of model
     """
     from llamator.client.specific_chat_clients import ClientLangChain
 

tests/openai_client_lm_studio_test.py

@@ -1,15 +1,6 @@
 def openai_client_lm_studio_test():
     """
     Tests OpenAI client from local llamator lib.
-
-    Environment variables
-    ----------
-    OPENAI_CLIENT_API_KEY : str
-        API key for OpenAI compatible API
-    OPENAI_CLIENT_BASEURL : str
-        URL of OpenAI compatible API
-    OPENAI_CLIENT_MODEL : str
-        Type of model
     """
     from llamator.client.specific_chat_clients import ClientOpenAI