API Reference - PyRIT Documentation

pyrit.analytics¶

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

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

pyrit.cli.api_client¶

PyRITApiClient, ServerNotAvailableError

pyrit.cli.pyrit_scan¶

main(), parse_args(), validate_log_level_argparse()

pyrit.cli.pyrit_shell¶

PyRITShell, main()

pyrit.common¶

DefaultValueScope, Parameter, Singleton, YamlLoadable, apply_defaults_to_method(), combine_dict(), combine_list(), get_global_default_values() ... (18 total)

pyrit.datasets¶

SeedDatasetFilter, SeedDatasetLoadTime, SeedDatasetMetadata, SeedDatasetProvider, TextJailBreak

pyrit.embedding¶

OpenAITextEmbedding

pyrit.exceptions¶

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

pyrit.executor.attack¶

AttackAdversarialConfig, AttackContext, AttackConverterConfig, AttackExecutor, AttackExecutorResult, AttackParameters, AttackResultPrinterBase, AttackScoringConfig ... (40 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, IdentifierFilter, IdentifierType, ScorerEvaluationIdentifier ... (15 total)

pyrit.memory¶

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

pyrit.message_normalizer¶

ChatMessageNormalizer, ConversationContextNormalizer, GenericSystemSquashNormalizer, HistorySquashNormalizer, MessageListNormalizer, MessageStringNormalizer, TokenizerTemplateNormalizer

pyrit.models¶

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

pyrit.output¶

FileSink, IPythonMarkdownSink, PrinterBase, Sink, StdoutSink, get_default_sink(), output_attack_async(), output_conversation_async() ... (11 total)

pyrit.prompt_converter¶

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

pyrit.prompt_normalizer¶

NormalizerRequest, PromptConverterConfiguration, PromptNormalizer

pyrit.prompt_target¶

AzureBlobStorageTarget, AzureMLChatTarget, CHAT_TARGET_REQUIREMENTS, CapabilityHandlingPolicy, CapabilityName, ConversationNormalizationPipeline, CopilotType, GandalfLevel ... (38 total)

pyrit.registry¶

AttackTechniqueRegistry, AttackTechniqueSpec, BaseClassRegistry, BaseInstanceRegistry, ClassEntry, ConverterRegistry, InitializerMetadata, InitializerRegistry ... (20 total)

pyrit.scenario¶

AtomicAttack, AttackTechnique, AttackTechniqueFactory, BaselineAttackPolicy, DatasetConfiguration, Parameter, Scenario, ScenarioCompositeStrategy ... (11 total)

pyrit.score¶

AudioFloatScaleScorer, AudioTrueFalseScorer, AzureContentFilterScorer, BatchScorer, PrettyScorerMemoryPrinter, ContentClassifierPaths, ConversationScorer, CredentialLeakScorer ... (65 total)

pyrit.setup¶

ConfigurationLoader, initialize_from_config_async(), initialize_pyrit_async()

pyrit.show_versions¶

show_versions()