BREAKING MAINT rename PromptRequestResponse to Message, and PromptRequestPiece to MessagePiece (#1141)

Author: romanlutz

.github/instructions/style-guide.instructions.md

@@ -14,11 +14,11 @@ Follow these coding standards to ensure consistent, readable, and maintainable c
 
 ```python
 # CORRECT
-async def send_prompt_async(self, prompt: str) -> PromptResponse:
+async def send_prompt_async(self, prompt: str) -> Message:
     ...
 
 # INCORRECT
-async def send_prompt(self, prompt: str) -> PromptResponse:  # Missing _async suffix
+async def send_prompt(self, prompt: str) -> Message:  # Missing _async suffix
     ...
 ```
 
@@ -230,7 +230,7 @@ from tqdm import tqdm
 
 # Local application imports
 from pyrit.attacks.base import AttackStrategy
-from pyrit.models import AttackResult, PromptResponse
+from pyrit.models import AttackResult
 from pyrit.prompt_target import PromptTarget
 ```
 

assets/prompt_request_piece.png

@@ -12,6 +12,8 @@ API Reference
     :nosignatures:
     :toctree: _autosummary/
 
+    analyze_results
+    AttackStats
     ConversationAnalytics
 
 :py:mod:`pyrit.auth`
@@ -312,14 +314,13 @@ API Reference
     EmbeddingSupport
     EmbeddingUsageInformation
     ErrorDataTypeSerializer
-    group_conversation_request_pieces_by_sequence
+    group_conversation_message_pieces_by_sequence
     Identifier
     ImagePathDataTypeSerializer
-    PromptRequestPiece
-    PromptResponse
-    PromptResponseError
+    Message
+    MessagePiece
     PromptDataType
-    PromptRequestResponse
+    PromptResponseError
     QuestionAnsweringDataset
     QuestionAnsweringEntry
     QuestionChoice

doc/api.rst

@@ -7,7 +7,7 @@
    "source": [
     "# 3. Audio Converters\n",
     "\n",
-    "Converters can also be multi-modal. Because it's an abstract function used interchangeably on a single `PromptRequestPiece`, it can only deal with one input value and type per time, and have one output value and type per time. Below is an example of using `AzureSpeechTextToAudioConverter`, which has an input type of `text` and an output type of `audio_path`."
+    "Converters can also be multi-modal. Because it's an abstract function used interchangeably on a single `MessagePiece`, it can only deal with one input value and type per time, and have one output value and type per time. Below is an example of using `AzureSpeechTextToAudioConverter`, which has an input type of `text` and an output type of `audio_path`."
    ]
   },
   {

doc/code/converters/3_audio_converters.ipynb

@@ -12,7 +12,7 @@
 # %% [markdown]
 # # 3. Audio Converters
 #
-# Converters can also be multi-modal. Because it's an abstract function used interchangeably on a single `PromptRequestPiece`, it can only deal with one input value and type per time, and have one output value and type per time. Below is an example of using `AzureSpeechTextToAudioConverter`, which has an input type of `text` and an output type of `audio_path`.
+# Converters can also be multi-modal. Because it's an abstract function used interchangeably on a single `MessagePiece`, it can only deal with one input value and type per time, and have one output value and type per time. Below is an example of using `AzureSpeechTextToAudioConverter`, which has an input type of `text` and an output type of `audio_path`.
 
 # %%
 import os

doc/code/converters/3_audio_converters.py

@@ -977,15 +977,15 @@
    "source": [
     "from pyrit.datasets import TextJailBreak\n",
     "from pyrit.executor.attack import AttackExecutor, PromptSendingAttack\n",
-    "from pyrit.models.prompt_request_response import PromptRequestResponse\n",
+    "from pyrit.models import Message\n",
     "from pyrit.prompt_target import OpenAIChatTarget\n",
     "\n",
     "target = OpenAIChatTarget()\n",
     "\n",
     "jailbreak = TextJailBreak(template_file_name=\"dan_1.yaml\")\n",
     "system_prompt_str = jailbreak.get_jailbreak_system_prompt()\n",
     "\n",
-    "prepend_conversation = [PromptRequestResponse.from_system_prompt(system_prompt_str)]\n",
+    "prepend_conversation = [Message.from_system_prompt(system_prompt_str)]\n",
     "\n",
     "attack = PromptSendingAttack(objective_target=target)\n",
     "executor = AttackExecutor()\n",

doc/code/executor/attack/1_prompt_sending_attack.ipynb

@@ -211,15 +211,15 @@
 # %%
 from pyrit.datasets import TextJailBreak
 from pyrit.executor.attack import AttackExecutor, PromptSendingAttack
-from pyrit.models.prompt_request_response import PromptRequestResponse
+from pyrit.models import Message
 from pyrit.prompt_target import OpenAIChatTarget
 
 target = OpenAIChatTarget()
 
 jailbreak = TextJailBreak(template_file_name="dan_1.yaml")
 system_prompt_str = jailbreak.get_jailbreak_system_prompt()
 
-prepend_conversation = [PromptRequestResponse.from_system_prompt(system_prompt_str)]
+prepend_conversation = [Message.from_system_prompt(system_prompt_str)]
 
 attack = PromptSendingAttack(objective_target=target)
 executor = AttackExecutor()

doc/code/executor/attack/1_prompt_sending_attack.py

@@ -335,14 +335,14 @@
     "import os\n",
     "\n",
     "from pyrit.datasets import TextJailBreak\n",
-    "from pyrit.models import PromptRequestPiece, PromptRequestResponse\n",
+    "from pyrit.models import Message, MessagePiece\n",
     "\n",
     "jailbreak = TextJailBreak(template_file_name=\"dan_1.yaml\")\n",
     "\n",
     "prepended_conversation = [\n",
-    "    PromptRequestResponse(\n",
-    "        request_pieces=[\n",
-    "            PromptRequestPiece(\n",
+    "    Message(\n",
+    "        message_pieces=[\n",
+    "            MessagePiece(\n",
     "                role=\"system\",\n",
     "                original_value=jailbreak.get_jailbreak_system_prompt(),\n",
     "            )\n",
@@ -378,9 +378,9 @@
     "# To customize the last user message sent to the objective target:\n",
     "\"\"\"\n",
     "prepended_conversation.append(\n",
-    "    PromptRequestResponse(\n",
-    "        request_pieces=[\n",
-    "            PromptRequestPiece(\n",
+    "    Message(\n",
+    "        message_pieces=[\n",
+    "            MessagePiece(\n",
     "                role=\"user\",\n",
     "                original_value=\"Custom message to continue the conversation with the objective target\",\n",
     "            )\n",

doc/code/executor/attack/2_red_teaming_attack.ipynb

@@ -120,14 +120,14 @@
 import os
 
 from pyrit.datasets import TextJailBreak
-from pyrit.models import PromptRequestPiece, PromptRequestResponse
+from pyrit.models import Message, MessagePiece
 
 jailbreak = TextJailBreak(template_file_name="dan_1.yaml")
 
 prepended_conversation = [
-    PromptRequestResponse(
-        request_pieces=[
-            PromptRequestPiece(
+    Message(
+        message_pieces=[
+            MessagePiece(
                 role="system",
                 original_value=jailbreak.get_jailbreak_system_prompt(),
             )
@@ -163,9 +163,9 @@
 # To customize the last user message sent to the objective target:
 """
 prepended_conversation.append(
-    PromptRequestResponse(
-        request_pieces=[
-            PromptRequestPiece(
+    Message(
+        message_pieces=[
+            MessagePiece(
                 role="user",
                 original_value="Custom message to continue the conversation with the objective target",
             )

doc/code/executor/attack/2_red_teaming_attack.py

@@ -391,7 +391,7 @@
     "from pyrit.memory import CentralMemory\n",
     "\n",
     "memory = CentralMemory.get_memory_instance()\n",
-    "processing_response = memory.get_prompt_request_pieces(conversation_id=result.processing_conversation_id)\n",
+    "processing_response = memory.get_message_pieces(conversation_id=result.processing_conversation_id)\n",
     "\n",
     "print(f\"Attack result status: {result.status}\")\n",
     "print(f\"Response from processing callback: {processing_response}\")"