PyRIT/doc/_toc.yml at 8cf617d18aa0fa57cf1243e95140a8770cff6acc · fitzpr/PyRIT · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
format: jb-book
root: index
chapters:
  - file: cookbooks/README
    sections:
    - file: cookbooks/1_sending_prompts
    - file: cookbooks/2_precomputing_turns
    - file: cookbooks/3_copyright_violations
    - file: cookbooks/4_testing_bias
    - file: cookbooks/5_psychosocial_harms
  - file: setup/1a_install_uv
    sections:
    - file: setup/1b_install_docker
    - file: setup/1c_install_conda
    - file: setup/jupyter_setup
    - file: setup/populating_secrets
    - file: setup/use_azure_sql_db
  - file: contributing/README
    sections:
    - file: contributing/1a_install_uv
    - file: contributing/1b_install_devcontainers
    - file: contributing/1c_install_conda
    - file: contributing/2_git
    - file: contributing/3_incorporating_research
    - file: contributing/4_style_guide
    - file: contributing/5_running_tests
    - file: contributing/6_unit_tests
    - file: contributing/7_integration_tests
    - file: contributing/8_notebooks
    - file: contributing/9_pre_commit
    - file: contributing/10_exception
    - file: contributing/11_release_process
  - file: code/architecture
  - file: code/user_guide
    sections:
    - file: code/datasets/0_dataset
      sections:
      - file: code/datasets/1_loading_datasets
      - file: code/datasets/2_seed_programming
      - file: code/datasets/3_dataset_writing
      - file: code/datasets/4_dataset_coding
    - file: code/executor/0_executor
      sections:
        - file: code/executor/attack/0_attack
          sections:
          - file: code/executor/attack/1_prompt_sending_attack
          - file: code/executor/attack/2_red_teaming_attack
          - file: code/executor/attack/3_crescendo_attack
          - file: code/executor/attack/chunked_request_attack
          - file: code/executor/attack/context_compliance_attack
          - file: code/executor/attack/flip_attack
          - file: code/executor/attack/many_shot_jailbreak_attack
          - file: code/executor/attack/multi_prompt_sending_attack
          - file: code/executor/attack/role_play_attack
          - file: code/executor/attack/skeleton_key_attack
          - file: code/executor/attack/tap_attack
          - file: code/executor/attack/violent_durian_attack
        - file: code/executor/workflow/0_workflow
          sections:
          - file: code/executor/workflow/1_xpia_website
          - file: code/executor/workflow/2_xpia_ai_recruiter
        - file: code/executor/benchmark/0_benchmark
          sections:
          - file: code/executor/benchmark/1_qa_benchmark
        - file: code/executor/promptgen/0_promptgen
          sections:
          - file: code/executor/promptgen/1_anecdoctor_generator
          - file: code/executor/promptgen/fuzzer_generator
    - file: code/targets/0_prompt_targets
      sections:
      - file: code/targets/1_openai_chat_target
      - file: code/targets/2_custom_targets
      - file: code/targets/3_non_open_ai_chat_targets
      - file: code/targets/4_non_llm_targets
      - file: code/targets/5_multi_modal_targets
      - file: code/targets/6_rate_limiting
      - file: code/targets/7_http_target
      - file: code/targets/8_openai_responses_target
      - file: code/targets/9_message_normalizer
      - file: code/targets/open_ai_completions
      - file: code/targets/playwright_target
      - file: code/targets/playwright_target_copilot
      - file: code/targets/prompt_shield_target
      - file: code/targets/use_huggingface_chat_target
      - file: code/targets/realtime_target
    - file: code/converters/0_converters
      sections:
        - file: code/converters/1_text_to_text_converters
        - file: code/converters/2_audio_converters
        - file: code/converters/3_image_converters
        - file: code/converters/4_video_converters
        - file: code/converters/5_file_converters
        - file: code/converters/6_selectively_converting
        - file: code/converters/7_human_converter
    - file: code/scoring/0_scoring
      sections:
      - file: code/scoring/1_azure_content_safety_scorers
      - file: code/scoring/2_true_false_scorers
      - file: code/scoring/3_classification_scorers
      - file: code/scoring/4_likert_scorers
      - file: code/scoring/5_human_in_the_loop_scorer
      - file: code/scoring/6_refusal_scorer
      - file: code/scoring/7_batch_scorer
      - file: code/scoring/insecure_code_scorer
      - file: code/scoring/persuasion_full_conversation_scorer
      - file: code/scoring/prompt_shield_scorer
      - file: code/scoring/generic_scorers
      - file: code/scoring/scorer_evals
    - file: code/memory/0_memory
      sections:
      - file: code/memory/1_sqlite_memory
      - file: code/memory/2_basic_memory_programming
      - file: code/memory/3_memory_data_types
      - file: code/memory/4_manually_working_with_memory
      - file: code/memory/5_memory_labels
      - file: code/memory/6_azure_sql_memory
      - file: code/memory/7_azure_sql_memory_attacks
      - file: code/memory/8_seed_database
      - file: code/memory/9_exporting_data
      - file: code/memory/10_schema_diagram.md
      - file: code/memory/embeddings
    - file: code/setup/0_setup
      sections:
      - file: code/setup/1_configuration
      - file: code/setup/2_resiliency
      - file: code/setup/default_values
      - file: code/setup/pyrit_initializer
    - file: code/auxiliary_attacks/0_auxiliary_attacks
      sections:
      - file: code/auxiliary_attacks/1_gcg_azure_ml
    - file: code/scenarios/0_scenarios
      sections:
      - file: code/scenarios/1_configuring_scenarios
    - file: code/front_end/0_front_end
      sections:
      - file: code/front_end/1_pyrit_scan
      - file: code/front_end/2_pyrit_shell
  - file: deployment/README
    sections:
    - file: deployment/deploy_hf_model_aml
    - file: deployment/download_and_register_hf_model_aml
    - file: deployment/hf_aml_model_endpoint_guide
    - file: deployment/score_aml_endpoint
    - file: deployment/troubleshooting_guide_hf_azureml
  - file: api.rst
  - file: blog/README
    sections:
    - file: blog/2025_06_06
    - file: blog/2025_03_03
    - file: blog/2025_02_11
    - file: blog/2025_01_27
    - file: blog/2025_01_14
    - file: blog/2024_12_3