Skip to content

EmbeddingErrorRate metric

Bases: EmbeddingModelOperationalMetric

Fraction of embedding calls that failed: failed / (succeeded + failed).

Example:

program.compile(
    metrics=[
        synalinks.metrics.EmbeddingErrorRate(),
    ],
)
Source code in synalinks/src/metrics/em_metrics.py
@synalinks_export("synalinks.metrics.EmbeddingErrorRate")
class EmbeddingErrorRate(EmbeddingModelOperationalMetric):
    """Fraction of embedding calls that failed: failed / (succeeded + failed).

    Example:

    ```python
    program.compile(
        metrics=[
            synalinks.metrics.EmbeddingErrorRate(),
        ],
    )
    ```
    """

    def __init__(self, name="embedding_error_rate"):
        super().__init__(name=name)

    def result(self):
        failed = self._delta("failed_calls")
        total = self._delta("calls") + failed
        if total <= 0:
            return 0.0
        return failed / total