API Reference

pyrit.analytics¶

ApproximateTextMatching, AttackStats, ConversationAnalytics, ExactTextMatching, TextMatching, analyze_results()

pyrit.auth¶

AsyncTokenProviderCredential, Authenticator, AzureAuth, AzureStorageAuth, CopilotAuthenticator, ManualCopilotAuthenticator, TokenProviderCredential, ensure_async_token_provider() ... (12 total)

pyrit.cli.frontend_core¶

ConfigurationLoader, ConsoleScenarioResultPrinter, DatasetConfiguration, FrontendCore, InitializerMetadata, InitializerRegistry, ScenarioMetadata, ScenarioRegistry ... (27 total)

pyrit.cli.pyrit_backend¶

initialize_and_run_async(), main(), parse_args()

pyrit.cli.pyrit_scan¶

main(), parse_args()

pyrit.cli.pyrit_shell¶

PyRITShell, ScenarioResult, main(), print_deprecation_message()

pyrit.common¶

DefaultValueScope, Singleton, YamlLoadable, apply_defaults_to_method(), combine_dict(), combine_list(), convert_local_image_to_data_url(), display_image_response() ... (26 total)

pyrit.datasets¶

SeedDatasetFilter, SeedDatasetLoadTime, SeedDatasetMetadata, SeedDatasetProvider, TextJailBreak

pyrit.embedding¶

OpenAITextEmbedding

pyrit.exceptions¶

BadRequestException, ComponentRole, EmptyResponseException, ExecutionContext, ExecutionContextManager, InvalidJsonException, MissingPromptPlaceholderException, PyritException ... (20 total)

pyrit.executor.attack¶

AttackAdversarialConfig, AttackContext, AttackConverterConfig, AttackExecutor, AttackExecutorResult, AttackParameters, AttackResultPrinter, AttackScoringConfig ... (39 total)

pyrit.executor.benchmark¶

FairnessBiasBenchmark, FairnessBiasBenchmarkContext, QuestionAnsweringBenchmark, QuestionAnsweringBenchmarkContext

pyrit.executor.core¶

Strategy, StrategyContext, StrategyConverterConfig, StrategyEvent, StrategyEventData, StrategyEventHandler

pyrit.executor.promptgen¶

AnecdoctorContext, AnecdoctorGenerator, AnecdoctorResult, PromptGeneratorStrategy, PromptGeneratorStrategyContext, PromptGeneratorStrategyResult

pyrit.executor.workflow¶

XPIAContext, XPIAManualProcessingWorkflow, XPIAProcessingCallback, XPIAResult, XPIAStatus, XPIATestWorkflow, XPIAWorkflow

pyrit.identifiers¶

AtomicAttackEvaluationIdentifier, ChildEvalRule, ComponentIdentifier, EvaluationIdentifier, Identifiable, ScorerEvaluationIdentifier, build_atomic_attack_identifier(), build_seed_identifier() ... (12 total)

pyrit.memory¶

AttackResultEntry, AzureSQLMemory, CentralMemory, EmbeddingDataEntry, MemoryEmbedding, MemoryExporter, MemoryInterface, PromptMemoryEntry ... (10 total)

pyrit.message_normalizer¶

ChatMessageNormalizer, ConversationContextNormalizer, GenericSystemSquashNormalizer, MessageListNormalizer, MessageStringNormalizer, TokenizerTemplateNormalizer

pyrit.models¶

AttackOutcome, AttackResult, AudioPathDataTypeSerializer, AzureBlobStorageIO, BinaryPathDataTypeSerializer, ChatMessage, ChatMessageListDictContent, ChatMessagesDataset ... (50 total)

pyrit.prompt_converter¶

AddImageTextConverter, AddImageVideoConverter, AddTextImageConverter, AllWordsSelectionStrategy, AnsiAttackConverter, AsciiArtConverter, AsciiSmugglerConverter, AskToDecodeConverter ... (92 total)

pyrit.prompt_normalizer¶

NormalizerRequest, PromptConverterConfiguration, PromptNormalizer

pyrit.prompt_target¶

AzureBlobStorageTarget, AzureMLChatTarget, CopilotType, CrucibleTarget, GandalfLevel, GandalfTarget, HTTPTarget, HTTPXAPITarget ... (30 total)

pyrit.registry¶

BaseClassRegistry, BaseInstanceRegistry, ClassEntry, InitializerMetadata, InitializerRegistry, RegistryEntry, RegistryProtocol, ScenarioMetadata ... (14 total)

pyrit.scenario¶

AtomicAttack, DatasetConfiguration, Scenario, ScenarioCompositeStrategy, ScenarioIdentifier, ScenarioResult, ScenarioStrategy

pyrit.score¶

AudioFloatScaleScorer, AudioTrueFalseScorer, AzureContentFilterScorer, BatchScorer, ConsoleScorerPrinter, ContentClassifierPaths, ConversationScorer, DecodingScorer ... (62 total)

pyrit.setup¶

ConfigurationLoader, initialize_from_config_async(), initialize_pyrit_async()

pyrit.show_versions¶

show_versions()

pyrit.ui¶

print_deprecation_message()