DOCS: expand use_entra_auth deprecation guidance and drop v prefix

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: romanlutz

pyrit/prompt_converter/azure_speech_audio_to_text_converter.py

@@ -66,8 +66,16 @@ def __init__(
                 If omitted, Entra ID auth via ``DefaultAzureCredential`` is used automatically.
             azure_speech_resource_id (str, Optional): The resource ID for accessing the service when using
                 Entra ID auth. Required when using a callable token provider or when no API key is available.
-            use_entra_auth (bool, Optional): **Deprecated.** Will be removed in v0.15.0.
-                Authentication is now auto-detected from the provided credentials.
+            use_entra_auth (bool, Optional): **Deprecated.** Will be removed in 0.15.0.
+                Authentication is now selected automatically based on what you pass to
+                ``azure_speech_key`` (and ``AZURE_SPEECH_KEY`` env var):
+
+                - Pass a **string** API key (or set ``AZURE_SPEECH_KEY``) to use API-key auth.
+                - Pass a **callable token provider** (sync or async returning a token string)
+                  to use Entra ID with a custom token; ``azure_speech_resource_id`` must also
+                  be set.
+                - Omit ``azure_speech_key`` entirely to use Entra ID via
+                  ``DefaultAzureCredential``; ``azure_speech_resource_id`` must be set.
             recognition_language (str): Recognition voice language. Defaults to "en-US".
                 For more on supported languages, see the following link:
                 https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support
@@ -79,9 +87,8 @@ def __init__(
             print_deprecation_message(
                 old_item="AzureSpeechAudioToTextConverter(use_entra_auth=...)",
                 new_item=(
-                    "AzureSpeechAudioToTextConverter(...) with automatic auth detection: "
-                    "pass a key string for key auth, a callable token provider for token auth, "
-                    "or omit for automatic Entra ID auth"
+                    "AzureSpeechAudioToTextConverter("
+                    "azure_speech_key=<api-key-string-or-callable-token-provider-or-omit>)"
                 ),
                 removed_in="0.15.0",
             )

pyrit/prompt_converter/azure_speech_text_to_audio_converter.py

@@ -70,8 +70,16 @@ def __init__(
                 If omitted, Entra ID auth via ``DefaultAzureCredential`` is used automatically.
             azure_speech_resource_id (str, Optional): The resource ID for accessing the service when using
                 Entra ID auth. Required when using a callable token provider or when no API key is available.
-            use_entra_auth (bool, Optional): **Deprecated.** Will be removed in v0.15.0.
-                Authentication is now auto-detected from the provided credentials.
+            use_entra_auth (bool, Optional): **Deprecated.** Will be removed in 0.15.0.
+                Authentication is now selected automatically based on what you pass to
+                ``azure_speech_key`` (and ``AZURE_SPEECH_KEY`` env var):
+
+                - Pass a **string** API key (or set ``AZURE_SPEECH_KEY``) to use API-key auth.
+                - Pass a **callable token provider** (sync or async returning a token string)
+                  to use Entra ID with a custom token; ``azure_speech_resource_id`` must also
+                  be set.
+                - Omit ``azure_speech_key`` entirely to use Entra ID via
+                  ``DefaultAzureCredential``; ``azure_speech_resource_id`` must be set.
             synthesis_language (str): Synthesis voice language.
             synthesis_voice_name (str): Synthesis voice name.
                 For more details see the following link for synthesis language and synthesis voice:
@@ -85,9 +93,8 @@ def __init__(
             print_deprecation_message(
                 old_item="AzureSpeechTextToAudioConverter(use_entra_auth=...)",
                 new_item=(
-                    "AzureSpeechTextToAudioConverter(...) with automatic auth detection: "
-                    "pass a key string for key auth, a callable token provider for token auth, "
-                    "or omit for automatic Entra ID auth"
+                    "AzureSpeechTextToAudioConverter("
+                    "azure_speech_key=<api-key-string-or-callable-token-provider-or-omit>)"
                 ),
                 removed_in="0.15.0",
             )

pyrit/prompt_target/azure_ml_chat_target.py

@@ -85,7 +85,7 @@ def __init__(
             message_normalizer (MessageListNormalizer[Any] | None): **Deprecated.** Use
                 ``custom_configuration`` with ``CapabilityHandlingPolicy`` instead. Previously used for
                 models that do not allow system prompts.
-                Will be removed in v0.15.0.
+                Will be removed in 0.15.0.
             max_new_tokens (int): The maximum number of tokens to generate in the response.
                 Defaults to 400.
             temperature (float): The temperature for generating diverse responses. 1.0 is most random,
@@ -120,7 +120,7 @@ def __init__(
                 raise ValueError(
                     "Cannot specify both 'message_normalizer' and 'custom_configuration'. "
                     "Use 'custom_configuration' only; 'message_normalizer' is deprecated and "
-                    "will be removed in v0.15.0."
+                    "will be removed in 0.15.0."
                 )
             print_deprecation_message(
                 old_item="AzureMLChatTarget(message_normalizer=...)",

pyrit/score/audio_transcript_scorer.py

@@ -114,8 +114,12 @@ def __init__(
         Args:
             text_capable_scorer (Scorer): A scorer capable of processing text that will be used to score
                 the transcribed audio content.
-            use_entra_auth (bool, Optional): **Deprecated.** Will be removed in v0.15.0.
-                Authentication is now auto-detected by the underlying converter.
+            use_entra_auth (bool, Optional): **Deprecated.** Will be removed in 0.15.0.
+                Authentication is now configured on the underlying
+                ``AzureSpeechAudioToTextConverter`` via its ``azure_speech_key`` parameter:
+                pass a string API key (or set ``AZURE_SPEECH_KEY``) for key auth, a callable
+                token provider for Entra ID with a custom token, or omit it to use Entra ID
+                via ``DefaultAzureCredential``.
 
         Raises:
             ValueError: If text_capable_scorer does not support text data type.
@@ -124,8 +128,8 @@ def __init__(
             print_deprecation_message(
                 old_item="AudioTranscriptHelper(use_entra_auth=...)",
                 new_item=(
-                    "AudioTranscriptHelper(...) (authentication is now auto-detected "
-                    "by the underlying AzureSpeechAudioToTextConverter)"
+                    "AudioTranscriptHelper(...) (configure auth on the underlying "
+                    "AzureSpeechAudioToTextConverter via azure_speech_key)"
                 ),
                 removed_in="0.15.0",
             )

pyrit/score/float_scale/audio_float_scale_scorer.py

@@ -34,8 +34,12 @@ def __init__(
             text_capable_scorer: A FloatScaleScorer capable of processing text.
                 This scorer will be used to evaluate the transcribed audio content.
             validator: Validator for the scorer. Defaults to audio_path data type validator.
-            use_entra_auth: **Deprecated.** Will be removed in v0.15.0.
-                Authentication is now auto-detected by the underlying converter.
+            use_entra_auth: **Deprecated.** Will be removed in 0.15.0.
+                Authentication is now configured on the underlying
+                ``AzureSpeechAudioToTextConverter`` via its ``azure_speech_key`` parameter:
+                pass a string API key (or set ``AZURE_SPEECH_KEY``) for key auth, a callable
+                token provider for Entra ID with a custom token, or omit it to use Entra ID
+                via ``DefaultAzureCredential``.
 
         Raises:
             ValueError: If text_capable_scorer does not support text data type.

pyrit/score/true_false/audio_true_false_scorer.py

@@ -34,8 +34,12 @@ def __init__(
             text_capable_scorer: A TrueFalseScorer capable of processing text.
                 This scorer will be used to evaluate the transcribed audio content.
             validator: Validator for the scorer. Defaults to audio_path data type validator.
-            use_entra_auth: **Deprecated.** Will be removed in v0.15.0.
-                Authentication is now auto-detected by the underlying converter.
+            use_entra_auth: **Deprecated.** Will be removed in 0.15.0.
+                Authentication is now configured on the underlying
+                ``AzureSpeechAudioToTextConverter`` via its ``azure_speech_key`` parameter:
+                pass a string API key (or set ``AZURE_SPEECH_KEY``) for key auth, a callable
+                token provider for Entra ID with a custom token, or omit it to use Entra ID
+                via ``DefaultAzureCredential``.
 
         Raises:
             ValueError: If text_capable_scorer does not support text data type.