feat(Update docs):

This commit is contained in:
Alexander Myasoedov
2025-01-25 12:28:50 +02:00
parent 9817ab495a
commit 50436e1f1d
13 changed files with 334 additions and 415 deletions
+4
View File
@@ -5,6 +5,7 @@ The `probe_actor` module is a critical component of the Agentic Security project
## Files and Key Components
### fuzzer.py
- **Functions:**
- `async def generate_prompts(...)`: Asynchronously generates prompts for scanning.
- `def multi_modality_spec(llm_spec)`: Defines specifications for multi-modality.
@@ -14,6 +15,7 @@ The `probe_actor` module is a critical component of the Agentic Security project
- `def scan_router(...)`: Routes scan requests.
### refusal.py
- **Functions:**
- `def check_refusal(response: str, refusal_phrases: list = REFUSAL_MARKS) -> bool`: Checks if a response contains refusal phrases.
- `def refusal_heuristic(request_json)`: Applies heuristics to determine refusal.
@@ -21,6 +23,7 @@ The `probe_actor` module is a critical component of the Agentic Security project
## Usage Examples
### Performing a Single-Shot Scan
```python
from agentic_security.probe_actor.fuzzer import perform_single_shot_scan
@@ -28,6 +31,7 @@ await perform_single_shot_scan(prompt="Test prompt")
```
### Checking for Refusal
```python
from agentic_security.probe_actor.refusal import check_refusal