API Reference - PyRIT Documentation

pyrit.analytics¶

ApproximateTextMatching, AttackResultAnalytics, AttackStats, ConversationAnalytics, ExactTextMatching, TextMatching, analyze_results(), combine_outcome_statistics() ... (17 total)

pyrit.auth¶

AsyncTokenProviderCredential, Authenticator, AzureAuth, AzureStorageAuth, BrowserSessionCopilotAuthenticator, CopilotAuthenticator, ManualCopilotAuthenticator, TokenProviderCredential ... (18 total)

pyrit.cli.api_client¶

CompatibilityError, Operation, PyRITApiClient, RegisteredInitializer, RegisteredScenario, RunScenarioRequest, ScenarioResult, ScenarioRunListItem ... (12 total)

pyrit.cli.pyrit_migrate¶

pyrit.cli.pyrit_scan¶

Parameter, RunScenarioRequest, ScenarioRunSummary, add_results_arguments(), build_dataset_request_fields(), build_parameters_from_api(), main(), parse_args() ... (12 total)

pyrit.cli.pyrit_shell¶

PyRITShell, main()

pyrit.common¶

DefaultValueScope, Singleton, YamlLoadable, apply_defaults_to_method(), combine_dict(), combine_list(), enforce_keyword_only_init(), forward_init_parameters() ... (22 total)

pyrit.converter¶

AcrosticConverter, AddImageTextConverter, AddImageVideoConverter, AddTextImageConverter, AllWordsSelectionStrategy, AnsiAttackConverter, ArabicPresentationFormConverter, ArabiziConverter ... (123 total)

pyrit.datasets¶

SeedDatasetFilter, SeedDatasetLoadTime, SeedDatasetMetadata, SeedDatasetProvider, TargetObjectiveProvider, TextJailBreak, get_lazy_dir(), resolve_lazy_export()

pyrit.embedding¶

OpenAITextEmbedding, get_lazy_dir(), resolve_lazy_export()

pyrit.exceptions¶

AdversarialChatRefusedException, AdversarialChatResponseBlockedException, BadRequestException, ComponentRole, EmptyResponseException, ExecutionContext, ExecutionContextManager, ExperimentalWarning ... (33 total)

pyrit.executor.attack¶

AttackAdversarialConfig, AttackContext, AttackConverterConfig, AttackExecutor, AttackExecutorResult, AttackParameters, AttackScoringConfig, AttackStrategy ... (45 total)

pyrit.executor.benchmark¶

FairnessBiasBenchmark, FairnessBiasBenchmarkContext, QuestionAnsweringBenchmark, QuestionAnsweringBenchmarkContext, get_lazy_dir(), resolve_lazy_export()

pyrit.executor.core¶

Strategy, StrategyContext, StrategyConverterConfig, StrategyEvent, StrategyEventData, StrategyEventHandler, get_lazy_dir(), resolve_lazy_export()

pyrit.executor.promptgen¶

AnecdoctorContext, AnecdoctorGenerator, AnecdoctorResult, PromptGeneratorStrategy, PromptGeneratorStrategyContext, PromptGeneratorStrategyResult, TargetObjectiveGenerator, get_lazy_dir() ... (9 total)

pyrit.executor.workflow¶

XPIAContext, XPIAManualProcessingWorkflow, XPIAProcessingCallback, XPIAResult, XPIAStatus, XPIATestWorkflow, XPIAWorkflow, get_lazy_dir() ... (9 total)

pyrit.memory¶

AttackResultEntry, AttackResultKeysetCursor, AudioPathDataTypeSerializer, AzureBlobStorageIO, AzureSQLMemory, BinaryPathDataTypeSerializer, CentralMemory, DataTypeSerializer ... (31 total)

pyrit.message_normalizer¶

ChatMessageNormalizer, ConversationContextNormalizer, GenericSystemSquashNormalizer, HistorySquashNormalizer, JsonSchemaNormalizer, MessageListNormalizer, MessageStringNormalizer, TokenizerTemplateNormalizer ... (10 total)

pyrit.models¶

Acquisition, AllAvailableDatasetSize, AnswerMatches, AtomicAttackEvaluationIdentifier, AtomicAttackIdentifier, AttackAnalyticsCell, AttackAnalyticsConverterDirection, AttackAnalyticsDimension ... (223 total)

pyrit.output¶

FileSink, IPythonMarkdownSink, PrinterBase, Sink, StdoutSink, get_default_sink(), get_lazy_dir(), output_attack_async() ... (16 total)

pyrit.prompt_normalizer¶

ConverterConfiguration, NormalizerRequest, PromptNormalizer, get_lazy_dir(), resolve_lazy_export(), send_json_with_retry_async()

pyrit.prompt_target¶

A2ATarget, AzureBlobStorageTarget, AzureMLChatTarget, CHAT_TARGET_REQUIREMENTS, CapabilityHandlingPolicy, CapabilityName, ConversationNormalizationPipeline, CopilotType ... (58 total)

pyrit.registry¶

AttackRegistry, AttackTechniqueMetadata, AttackTechniqueRegistry, ConverterMetadata, ConverterRegistry, DefaultInstanceRegistry, InitializerMetadata, InitializerRegistry ... (30 total)

pyrit.scenario¶

AtomicAttack, AttackTechnique, AttackTechniqueFactory, BaselineAttackPolicy, CompoundDatasetAttackConfiguration, DatasetAttackConfiguration, DatasetConfiguration, DatasetFetchPolicy ... (21 total)

pyrit.score¶

AgentThreatRulesScorer, AnsiEscapeOutputScorer, AnthraxKeywordScorer, AttemptObserver, AudioFloatScaleScorer, AudioTrueFalseScorer, AzureContentFilterScorer, BatchScorer ... (152 total)

pyrit.setup¶

ConfigurationLoader, get_lazy_dir(), initialize_from_config_async(), initialize_pyrit_async(), resolve_lazy_export()

pyrit.show_versions¶

show_versions()