azure-ai-evaluation 1.0.0b2__py3-none-any.whl → 1.13.3__py3-none-any.whl

azure/ai/evaluation/_user_agent.py

@@ -1,6 +1,37 @@
 # ---------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # ---------------------------------------------------------
+from contextlib import contextmanager
+from typing import Iterator
+
 from azure.ai.evaluation._version import VERSION
 
-USER_AGENT = "{}/{}".format("azure-ai-evaluation", VERSION)
+
+class UserAgentSingleton:
+    __BASE_USER_AGENT: str = "{}/{}".format("azure-ai-evaluation", VERSION)
+
+    @property
+    def value(self):
+        """Get the user-agent"""
+        return self.__BASE_USER_AGENT
+
+    def __str__(self) -> str:
+        return self.value
+
+    @classmethod
+    @contextmanager
+    def add_useragent_product(cls, *product: str) -> Iterator[None]:
+        """Appends a "product" (e.g. `name/version`) to the base user agent
+
+        :param product: User Agent products to append to the base user agent
+
+         ..see-also::
+
+             `User-Agent section of RFC 9110, <https://www.rfc-editor.org/rfc/rfc9110#name-user-agent>`
+        """
+        old_useragent = cls.__BASE_USER_AGENT
+        cls.__BASE_USER_AGENT = f"{old_useragent} {' '.join(product)}"
+
+        yield
+
+        cls.__BASE_USER_AGENT = old_useragent

azure/ai/evaluation/_vendor/__init__.py

@@ -0,0 +1,3 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------

azure/ai/evaluation/_vendor/rouge_score/__init__.py

@@ -0,0 +1,14 @@
+# coding=utf-8
+# Copyright 2024 The Google Research Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

azure/ai/evaluation/_vendor/rouge_score/rouge_scorer.py

@@ -0,0 +1,324 @@
+# coding=utf-8
+# Copyright 2024 The Google Research Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Portions Copyright (c) Microsoft Corporation
+
+"""Computes rouge scores between two text blobs.
+
+Implementation replicates the functionality in the original ROUGE package. See:
+
+Lin, Chin-Yew. ROUGE: a Package for Automatic Evaluation of Summaries. In
+Proceedings of the Workshop on Text Summarization Branches Out (WAS 2004),
+Barcelona, Spain, July 25 - 26, 2004.
+
+Default options are equivalent to running:
+ROUGE-1.5.5.pl -e data -n 2 -a settings.xml
+
+Or with use_stemmer=True:
+ROUGE-1.5.5.pl -m -e data -n 2 -a settings.xml
+
+In these examples settings.xml lists input files and formats.
+"""
+
+import collections
+import re
+
+from azure.ai.evaluation._vendor.rouge_score import scoring
+from azure.ai.evaluation._vendor.rouge_score import tokenizers
+
+import nltk
+
+
+class RougeScorer(scoring.BaseScorer):
+    """Calculate rouges scores between two blobs of text.
+
+    Sample usage:
+      scorer = RougeScorer(['rouge1', 'rougeL'], use_stemmer=True)
+      scores = scorer.score('The quick brown fox jumps over the lazy dog',
+                            'The quick brown dog jumps on the log.')
+    """
+
+    def __init__(self, rouge_types, use_stemmer=False, split_summaries=False, tokenizer=None):
+        """Initializes a new RougeScorer.
+
+        Valid rouge types that can be computed are:
+          rougen (e.g. rouge1, rouge2): n-gram based scoring.
+          rougeL: Longest common subsequence based scoring.
+
+        Args:
+          rouge_types: A list of rouge types to calculate.
+          use_stemmer: Bool indicating whether Porter stemmer should be used to
+            strip word suffixes to improve matching. This arg is used in the
+            DefaultTokenizer, but other tokenizers might or might not choose to
+            use this.
+          split_summaries: whether to add newlines between sentences for rougeLsum
+          tokenizer: Tokenizer object which has a tokenize() method.
+        Returns:
+          A dict mapping rouge types to Score tuples.
+        """
+
+        self.rouge_types = rouge_types
+        if tokenizer:
+            self._tokenizer = tokenizer
+        else:
+            self._tokenizer = tokenizers.DefaultTokenizer(use_stemmer)
+
+        self._split_summaries = split_summaries
+
+    def score_multi(self, targets, prediction):
+        """Calculates rouge scores between targets and prediction.
+
+        The target with the maximum f-measure is used for the final score for
+        each score type..
+
+        Args:
+          targets: list of texts containing the targets
+          prediction: Text containing the predicted text.
+        Returns:
+          A dict mapping each rouge type to a Score object.
+        Raises:
+          ValueError: If an invalid rouge type is encountered.
+        """
+        score_dicts = [self.score(t, prediction) for t in targets]
+        max_score = {}
+        for k in self.rouge_types:
+            fmeasures = [s[k].fmeasure for s in score_dicts]
+            index = fmeasures.index(max(fmeasures))
+            max_score[k] = score_dicts[index][k]
+
+        return max_score
+
+    def score(self, target, prediction):
+        """Calculates rouge scores between the target and prediction.
+
+        Args:
+          target: Text containing the target (ground truth) text,
+          or if a list
+          prediction: Text containing the predicted text.
+        Returns:
+          A dict mapping each rouge type to a Score object.
+        Raises:
+          ValueError: If an invalid rouge type is encountered.
+        """
+
+        # Pre-compute target tokens and prediction tokens for use by different
+        # types, except if only "rougeLsum" is requested.
+        if len(self.rouge_types) == 1 and self.rouge_types[0] == "rougeLsum":
+            target_tokens = None
+            prediction_tokens = None
+        else:
+            target_tokens = self._tokenizer.tokenize(target)
+            prediction_tokens = self._tokenizer.tokenize(prediction)
+        result = {}
+
+        for rouge_type in self.rouge_types:
+            if rouge_type == "rougeL":
+                # Rouge from longest common subsequences.
+                scores = _score_lcs(target_tokens, prediction_tokens)
+            elif rouge_type == "rougeLsum":
+                # Note: Does not support multi-line text.
+                def get_sents(text):
+                    if self._split_summaries:
+                        sents = nltk.sent_tokenize(text)
+                    else:
+                        # Assume sentences are separated by newline.
+                        sents = text.split("\n")
+                    sents = [x for x in sents if len(x)]
+                    return sents
+
+                target_tokens_list = [self._tokenizer.tokenize(s) for s in get_sents(target)]
+                prediction_tokens_list = [self._tokenizer.tokenize(s) for s in get_sents(prediction)]
+
+                scores = _summary_level_lcs(target_tokens_list, prediction_tokens_list)
+            elif re.match(r"rouge[0-9]$", rouge_type):
+                # Rouge from n-grams.
+                n = int(rouge_type[5:])
+                if n <= 0:
+                    raise ValueError("rougen requires positive n: %s" % rouge_type)
+                target_ngrams = _create_ngrams(target_tokens, n)
+                prediction_ngrams = _create_ngrams(prediction_tokens, n)
+                scores = _score_ngrams(target_ngrams, prediction_ngrams)
+            else:
+                raise ValueError("Invalid rouge type: %s" % rouge_type)
+            result[rouge_type] = scores
+
+        return result
+
+
+def _create_ngrams(tokens, n):
+    """Creates ngrams from the given list of tokens.
+
+    Args:
+      tokens: A list of tokens from which ngrams are created.
+      n: Number of tokens to use, e.g. 2 for bigrams.
+    Returns:
+      A dictionary mapping each bigram to the number of occurrences.
+    """
+
+    ngrams = collections.Counter()
+    for ngram in (tuple(tokens[i : i + n]) for i in range(len(tokens) - n + 1)):
+        ngrams[ngram] += 1
+    return ngrams
+
+
+def _score_lcs(target_tokens, prediction_tokens):
+    """Computes LCS (Longest Common Subsequence) rouge scores.
+
+    Args:
+      target_tokens: Tokens from the target text.
+      prediction_tokens: Tokens from the predicted text.
+    Returns:
+      A Score object containing computed scores.
+    """
+
+    if not target_tokens or not prediction_tokens:
+        return scoring.Score(precision=0, recall=0, fmeasure=0)
+
+    # Compute length of LCS from the bottom up in a table (DP appproach).
+    lcs_table = _lcs_table(target_tokens, prediction_tokens)
+    lcs_length = lcs_table[-1][-1]
+
+    precision = lcs_length / len(prediction_tokens)
+    recall = lcs_length / len(target_tokens)
+    fmeasure = scoring.fmeasure(precision, recall)
+
+    return scoring.Score(precision=precision, recall=recall, fmeasure=fmeasure)
+
+
+def _lcs_table(ref, can):
+    """Create 2-d LCS score table."""
+    rows = len(ref)
+    cols = len(can)
+    lcs_table = [[0] * (cols + 1) for _ in range(rows + 1)]
+    for i in range(1, rows + 1):
+        for j in range(1, cols + 1):
+            if ref[i - 1] == can[j - 1]:
+                lcs_table[i][j] = lcs_table[i - 1][j - 1] + 1
+            else:
+                lcs_table[i][j] = max(lcs_table[i - 1][j], lcs_table[i][j - 1])
+    return lcs_table
+
+
+def _backtrack_norec(t, ref, can):
+    """Read out LCS."""
+    i = len(ref)
+    j = len(can)
+    lcs = []
+    while i > 0 and j > 0:
+        if ref[i - 1] == can[j - 1]:
+            lcs.insert(0, i - 1)
+            i -= 1
+            j -= 1
+        elif t[i][j - 1] > t[i - 1][j]:
+            j -= 1
+        else:
+            i -= 1
+    return lcs
+
+
+def _summary_level_lcs(ref_sent, can_sent):
+    """ROUGE: Summary-level LCS, section 3.2 in ROUGE paper.
+
+    Args:
+      ref_sent: list of tokenized reference sentences
+      can_sent: list of tokenized candidate sentences
+
+    Returns:
+      summary level ROUGE score
+    """
+    if not ref_sent or not can_sent:
+        return scoring.Score(precision=0, recall=0, fmeasure=0)
+
+    m = sum(map(len, ref_sent))
+    n = sum(map(len, can_sent))
+    if not n or not m:
+        return scoring.Score(precision=0, recall=0, fmeasure=0)
+
+    # get token counts to prevent double counting
+    token_cnts_r = collections.Counter()
+    token_cnts_c = collections.Counter()
+    for s in ref_sent:
+        # s is a list of tokens
+        token_cnts_r.update(s)
+    for s in can_sent:
+        token_cnts_c.update(s)
+
+    hits = 0
+    for r in ref_sent:
+        lcs = _union_lcs(r, can_sent)
+        # Prevent double-counting:
+        # The paper describes just computing hits += len(_union_lcs()),
+        # but the implementation prevents double counting. We also
+        # implement this as in version 1.5.5.
+        for t in lcs:
+            if token_cnts_c[t] > 0 and token_cnts_r[t] > 0:
+                hits += 1
+                token_cnts_c[t] -= 1
+                token_cnts_r[t] -= 1
+
+    recall = hits / m
+    precision = hits / n
+    fmeasure = scoring.fmeasure(precision, recall)
+    return scoring.Score(precision=precision, recall=recall, fmeasure=fmeasure)
+
+
+def _union_lcs(ref, c_list):
+    """Find union LCS between a ref sentence and list of candidate sentences.
+
+    Args:
+      ref: list of tokens
+      c_list: list of list of indices for LCS into reference summary
+
+    Returns:
+      List of tokens in ref representing union LCS.
+    """
+    lcs_list = [lcs_ind(ref, c) for c in c_list]
+    return [ref[i] for i in _find_union(lcs_list)]
+
+
+def _find_union(lcs_list):
+    """Finds union LCS given a list of LCS."""
+    return sorted(list(set().union(*lcs_list)))
+
+
+def lcs_ind(ref, can):
+    """Returns one of the longest lcs."""
+    t = _lcs_table(ref, can)
+    return _backtrack_norec(t, ref, can)
+
+
+def _score_ngrams(target_ngrams, prediction_ngrams):
+    """Compute n-gram based rouge scores.
+
+    Args:
+      target_ngrams: A Counter object mapping each ngram to number of
+        occurrences for the target text.
+      prediction_ngrams: A Counter object mapping each ngram to number of
+        occurrences for the prediction text.
+    Returns:
+      A Score object containing computed scores.
+    """
+
+    intersection_ngrams_count = 0
+    for ngram in target_ngrams.keys():
+        intersection_ngrams_count += min(target_ngrams[ngram], prediction_ngrams[ngram])
+    target_ngrams_count = sum(target_ngrams.values())
+    prediction_ngrams_count = sum(prediction_ngrams.values())
+
+    precision = intersection_ngrams_count / max(prediction_ngrams_count, 1)
+    recall = intersection_ngrams_count / max(target_ngrams_count, 1)
+    fmeasure = scoring.fmeasure(precision, recall)
+
+    return scoring.Score(precision=precision, recall=recall, fmeasure=fmeasure)

azure/ai/evaluation/_vendor/rouge_score/scoring.py

@@ -0,0 +1,59 @@
+# coding=utf-8
+# Copyright 2024 The Google Research Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Portions Copyright (c) Microsoft Corporation
+
+"""Library for scoring and evaluation of text samples.
+
+Aggregation functions use bootstrap resampling to compute confidence intervals
+as per the original ROUGE perl implementation.
+"""
+
+import abc
+import collections
+from typing import Dict
+
+
+class Score(collections.namedtuple("Score", ["precision", "recall", "fmeasure"])):
+    """Tuple containing precision, recall, and f-measure values."""
+
+
+class BaseScorer(object, metaclass=abc.ABCMeta):
+    """Base class for Scorer objects."""
+
+    @abc.abstractmethod
+    def score(self, target, prediction):
+        """Calculates score between the target and prediction.
+
+        Args:
+          target: Text containing the target (ground truth) text.
+          prediction: Text containing the predicted text.
+
+        Returns:
+          A dict mapping each score_type (string) to Score object.
+        """
+
+
+class AggregateScore(collections.namedtuple("AggregateScore", ["low", "mid", "high"])):
+    """Tuple containing confidence intervals for scores."""
+
+
+def fmeasure(precision, recall):
+    """Computes f-measure given precision and recall values."""
+
+    if precision + recall > 0:
+        return 2 * precision * recall / (precision + recall)
+    else:
+        return 0.0

azure/ai/evaluation/_vendor/rouge_score/tokenize.py

@@ -0,0 +1,59 @@
+# coding=utf-8
+# Copyright 2024 The Google Research Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Portions Copyright (c) Microsoft Corporation
+
+"""A library for tokenizing text."""
+
+import re
+
+
+# Pre-compile regexes that are use often
+NON_ALPHANUM_PATTERN = r"[^a-z0-9]+"
+NON_ALPHANUM_RE = re.compile(NON_ALPHANUM_PATTERN)
+SPACES_PATTERN = r"\s+"
+SPACES_RE = re.compile(SPACES_PATTERN)
+VALID_TOKEN_PATTERN = r"^[a-z0-9]+$"
+VALID_TOKEN_RE = re.compile(VALID_TOKEN_PATTERN)
+
+
+def tokenize(text, stemmer):
+    """Tokenize input text into a list of tokens.
+
+    This approach aims to replicate the approach taken by Chin-Yew Lin in
+    the original ROUGE implementation.
+
+    Args:
+      text: A text blob to tokenize.
+      stemmer: An optional stemmer.
+
+    Returns:
+      A list of string tokens extracted from input text.
+    """
+
+    # Convert everything to lowercase.
+    text = text.lower()
+    # Replace any non-alpha-numeric characters with spaces.
+    text = NON_ALPHANUM_RE.sub(" ", text)
+
+    tokens = SPACES_RE.split(text)
+    if stemmer:
+        # Only stem words more than 3 characters long.
+        tokens = [stemmer.stem(x) if len(x) > 3 else x for x in tokens]
+
+    # One final check to drop any empty or invalid tokens.
+    tokens = [x for x in tokens if VALID_TOKEN_RE.match(x)]
+
+    return tokens

azure/ai/evaluation/_vendor/rouge_score/tokenizers.py

@@ -0,0 +1,53 @@
+# coding=utf-8
+# Copyright 2024 The Google Research Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Library containing Tokenizer definitions.
+
+The RougeScorer class can be instantiated with the tokenizers defined here. New
+tokenizers can be defined by creating a subclass of the Tokenizer abstract class
+and overriding the tokenize() method.
+"""
+import abc
+
+from nltk.stem import porter
+
+from azure.ai.evaluation._vendor.rouge_score import tokenize
+
+
+class Tokenizer(abc.ABC):
+    """Abstract base class for a tokenizer.
+
+    Subclasses of Tokenizer must implement the tokenize() method.
+    """
+
+    @abc.abstractmethod
+    def tokenize(self, text):
+        raise NotImplementedError("Tokenizer must override tokenize() method")
+
+
+class DefaultTokenizer(Tokenizer):
+    """Default tokenizer which tokenizes on whitespace."""
+
+    def __init__(self, use_stemmer=False):
+        """Constructor for DefaultTokenizer.
+
+        Args:
+          use_stemmer: boolean, indicating whether Porter stemmer should be used to
+          strip word suffixes to improve matching.
+        """
+        self._stemmer = porter.PorterStemmer() if use_stemmer else None
+
+    def tokenize(self, text):
+        return tokenize.tokenize(text, self._stemmer)

azure/ai/evaluation/_version.py

@@ -1,5 +1,6 @@
 # ---------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # ---------------------------------------------------------
+# represents upcoming version
 
-VERSION = "1.0.0b2"
+VERSION = "1.13.3"

azure/ai/evaluation/red_team/__init__.py

@@ -0,0 +1,22 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+try:
+    from ._red_team import RedTeam
+    from ._attack_strategy import AttackStrategy
+    from ._attack_objective_generator import RiskCategory, SupportedLanguages
+    from ._red_team_result import RedTeamResult
+except ImportError:
+    raise ImportError(
+        "Could not import Pyrit. Please install the dependency with `pip install azure-ai-evaluation[redteam]`."
+    )
+
+
+__all__ = [
+    "RedTeam",
+    "AttackStrategy",
+    "RiskCategory",
+    "RedTeamResult",
+    "SupportedLanguages",
+]

azure/ai/evaluation/red_team/_agent/__init__.py

@@ -0,0 +1,3 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------