pyrit.score.AzureContentFilterScorer

pyrit.score.AzureContentFilterScorer#

class AzureContentFilterScorer(*, endpoint: str | None = None, api_key: str | None = None, use_aad_auth: bool = False, harm_categories: list[TextCategory] | None = None)[source]#

Bases: Scorer

__init__(*, endpoint: str | None = None, api_key: str | None = None, use_aad_auth: bool = False, harm_categories: list[TextCategory] | None = None) → None[source]#

Class that initializes an Azure Content Filter Scorer

Parameters:

  • api_key (str, Optional) – The API key for accessing the Azure OpenAI service. Defaults to the API_KEY_ENVIRONMENT_VARIABLE environment variable.

  • endpoint (str, Optional) – The endpoint URL for the Azure OpenAI service. Defaults to the ENDPOINT_URI_ENVIRONMENT_VARIABLE environment variable.

  • use_aad_auth (bool, Optional) – Attempt to use DefaultAzureCredential If set to true, attempt to use DefaultAzureCredential for auth

  • harm_categories – The harm categories you want to query for as per defined in azure.ai.contentsafety.models.TextCategory.

Methods

__init__(*[, endpoint, api_key, ...])

Class that initializes an Azure Content Filter Scorer

get_identifier()

Returns an identifier dictionary for the scorer.

get_scorer_metrics(dataset_name[, metrics_type])

Returns evaluation statistics for the scorer using the dataset_name of the human labeled dataset that this scorer was run against.

scale_value_float(value, min_value, max_value)

Scales a value from 0 to 1 based on the given min and max values.

score_async(request_response, *[, task])

Score the request_response, add the results to the database and return a list of Score objects.

score_image_async(image_path, *[, task])

Scores the given image using the chat target.

score_prompts_with_tasks_batch_async(*, ...)

score_response_async(*, response, scorers[, ...])

Score a response using multiple scorers in parallel.

score_response_select_first_success_async(*, ...)

Score response pieces sequentially until finding a successful score.

score_response_with_objective_async(*, response)

Score a response using both auxiliary and objective scorers.

score_responses_inferring_tasks_batch_async(*, ...)

Scores a batch of responses (ignores non-assistant messages).

score_text_async(text, *[, task])

Scores the given text based on the task using the chat target.

score_text_batch_async(*, texts[, tasks, ...])

validate(request_response, *[, task])

Validates the request_response piece to score.

Attributes

API_KEY_ENVIRONMENT_VARIABLE

ENDPOINT_URI_ENVIRONMENT_VARIABLE

scorer_type

API_KEY_ENVIRONMENT_VARIABLE: str = 'AZURE_CONTENT_SAFETY_API_KEY'#
ENDPOINT_URI_ENVIRONMENT_VARIABLE: str = 'AZURE_CONTENT_SAFETY_API_ENDPOINT'#
validate(request_response: PromptRequestPiece, *, task: str | None = None)[source]#

Validates the request_response piece to score. Because some scorers may require specific PromptRequestPiece types or values.

Parameters:

  • request_response (PromptRequestPiece) – The request response to be validated.

  • task (str) – The task based on which the text should be scored (the original attacker model’s objective).

Contents