pyrit.orchestrator.OrchestratorResult#

class OrchestratorResult(conversation_id: str, objective: str, status: Annotated[Literal['success', 'failure', 'pruned', 'adversarial_generation', 'in_progress', 'error', 'unknown'], 'The status of an orchestrator result.\n\n    Completion States:\n        - success: The orchestrator run is complete and achieved its objective.\n        - failure: The orchestrator run is complete and failed to achieve its objective.\n        - error: The orchestrator run is complete and encountered an error.\n        - unknown: The orchestrator run is complete and it is unknown whether it achieved its objective.\n\n    Intermediate States:\n        - in_progress: The orchestrator is still running.\n\n    Special States:\n        - pruned: The conversation was pruned as part of an attack and not related to success/failure/unknown/error.\n        - adversarial_generation: The conversation was used as part of adversarial generation and not related to\n          success/failure/unknown/error.\n    '] = 'in_progress', objective_score: Score = None, confidence: float = 0.1)[source]#

Bases: object

The result of an orchestrator.

__init__(conversation_id: str, objective: str, status: Annotated[Literal['success', 'failure', 'pruned', 'adversarial_generation', 'in_progress', 'error', 'unknown'], 'The status of an orchestrator result.\n\n    Completion States:\n        - success: The orchestrator run is complete and achieved its objective.\n        - failure: The orchestrator run is complete and failed to achieve its objective.\n        - error: The orchestrator run is complete and encountered an error.\n        - unknown: The orchestrator run is complete and it is unknown whether it achieved its objective.\n\n    Intermediate States:\n        - in_progress: The orchestrator is still running.\n\n    Special States:\n        - pruned: The conversation was pruned as part of an attack and not related to success/failure/unknown/error.\n        - adversarial_generation: The conversation was used as part of adversarial generation and not related to\n          success/failure/unknown/error.\n    '] = 'in_progress', objective_score: Score = None, confidence: float = 0.1)[source]#

Methods

__init__(conversation_id, objective[, ...])

print_conversation_async(*[, ...])

Prints the conversation between the objective target and the adversarial chat, including the scores.

async print_conversation_async(*, include_auxiliary_scores: bool = False)[source]#

Prints the conversation between the objective target and the adversarial chat, including the scores.

Parameters:

prompt_target_conversation_id (str) – the conversation ID for the prompt target.