chore: import upstream snapshot with attribution
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled

This commit is contained in:
wehub-resource-sync
2026-07-13 13:25:44 +08:00
commit 5a558eb09e
11579 changed files with 1795921 additions and 0 deletions
@@ -0,0 +1,6 @@
Dataset
=======
.. autoclass:: opik.Dataset
:members:
:special-members: __init__
@@ -0,0 +1,4 @@
evaluate
========
.. autofunction:: opik.evaluation.evaluate
@@ -0,0 +1,4 @@
evaluate_experiment
===================
.. autofunction:: opik.evaluation.evaluate_experiment
@@ -0,0 +1,4 @@
evaluate_prompt
===============
.. autofunction:: opik.evaluation.evaluate_prompt
@@ -0,0 +1,5 @@
evaluate_threads
================
.. autofunction:: opik.evaluation.evaluate_threads
@@ -0,0 +1,6 @@
AnswerRelevance
===============
.. autoclass:: opik.evaluation.metrics.AnswerRelevance
:members:
:inherited-members:
@@ -0,0 +1,6 @@
BaseMetric
==========
.. autoclass:: opik.evaluation.metrics.BaseMetric
:members:
:inherited-members:
@@ -0,0 +1,6 @@
Contains
========
.. autoclass:: opik.evaluation.metrics.Contains
:members:
:inherited-members:
@@ -0,0 +1,6 @@
ContextPrecision
================
.. autoclass:: opik.evaluation.metrics.ContextPrecision
:members:
:inherited-members:
@@ -0,0 +1,6 @@
ContextRecall
=============
.. autoclass:: opik.evaluation.metrics.ContextRecall
:members:
:inherited-members:
@@ -0,0 +1,16 @@
Conversation Heuristic Metrics
==============================
.. currentmodule:: opik.evaluation.metrics
Use these fast, rule-based metrics when you want lightweight signals about dialogue
quality without invoking an LLM judge. They operate over full conversation
transcripts and surface issues such as repetition and missing context.
.. autoclass:: ConversationDegenerationMetric
:special-members: __init__
:members: score
.. autoclass:: KnowledgeRetentionMetric
:special-members: __init__
:members: score
@@ -0,0 +1,56 @@
Conversation LLM Judges
=======================
.. currentmodule:: opik.evaluation.metrics
These evaluators wrap GEval-style LLM judges so you can score full conversations
without manually extracting turns. They expect transcripts in the same format used
by :class:`~opik.evaluation.metrics.ConversationThreadMetric` and typically rely on
an OpenAI- or Azure-compatible backend. Refer to the relevant Fern guides for API
keys, rate limits, and pricing considerations.
Core Conversation Judges
------------------------
.. autoclass:: GEvalConversationMetric
:special-members: __init__
:members: score
.. autoclass:: ConversationalCoherenceMetric
:special-members: __init__
:members: score
.. autoclass:: SessionCompletenessQuality
:special-members: __init__
:members: score
.. autoclass:: UserFrustrationMetric
:special-members: __init__
:members: score
Specialized Variants
--------------------
.. autoclass:: ConversationComplianceRiskMetric
:special-members: __init__
:members: score
.. autoclass:: ConversationDialogueHelpfulnessMetric
:special-members: __init__
:members: score
.. autoclass:: ConversationQARelevanceMetric
:special-members: __init__
:members: score
.. autoclass:: ConversationSummarizationCoherenceMetric
:special-members: __init__
:members: score
.. autoclass:: ConversationSummarizationConsistencyMetric
:special-members: __init__
:members: score
.. autoclass:: ConversationPromptUncertaintyMetric
:special-members: __init__
:members: score
@@ -0,0 +1,7 @@
ConversationThreadMetric
========================
.. autoclass:: opik.evaluation.metrics.conversation.conversation_thread_metric.ConversationThreadMetric
:members:
:inherited-members:
@@ -0,0 +1,6 @@
Equals
======
.. autoclass:: opik.evaluation.metrics.Equals
:members:
:inherited-members:
@@ -0,0 +1,6 @@
GEval
=====
.. autoclass:: opik.evaluation.metrics.GEval
:members:
:inherited-members:
@@ -0,0 +1,6 @@
Hallucination
=============
.. autoclass:: opik.evaluation.metrics.Hallucination
:members:
:inherited-members:
@@ -0,0 +1,89 @@
Heuristic Metrics
=================
.. currentmodule:: opik.evaluation.metrics
This section lists the text-similarity, readability, safety, and sentiment metrics
that can be composed into larger test suites. Several metrics rely on optional
dependencies (for example, ``bert-score``, ``sacrebleu``, ``fasttext``, ``nltk``);
install the relevant packages before scoring.
Sentence & Token Overlap
------------------------
.. autoclass:: SentenceBLEU
:special-members: __init__
:members: score
.. autoclass:: CorpusBLEU
:special-members: __init__
:members: score
.. autoclass:: GLEU
:special-members: __init__
:members: score
.. autoclass:: ROUGE
:special-members: __init__
:members: score
.. autoclass:: ChrF
:special-members: __init__
:members: score
.. autoclass:: METEOR
:special-members: __init__
:members: score
.. autoclass:: BERTScore
:special-members: __init__
:members: score
Distribution Comparisons
------------------------
.. autoclass:: JSDivergence
:special-members: __init__
:members: score
.. autoclass:: JSDistance
:special-members: __init__
:members: score
.. autoclass:: KLDivergence
:special-members: __init__
:members: score
Rank & Readability
------------------
.. autoclass:: SpearmanRanking
:special-members: __init__
:members: score
.. autoclass:: Readability
:special-members: __init__
:members: score
.. autoclass:: Tone
:special-members: __init__
:members: score
Prompt Safety & Sentiment
-------------------------
.. autoclass:: PromptInjection
:special-members: __init__
:members: score
.. autoclass:: LanguageAdherenceMetric
:special-members: __init__
:members: score
.. autoclass:: Sentiment
:special-members: __init__
:members: score
.. autoclass:: VADERSentiment
:special-members: __init__
:members: score
@@ -0,0 +1,6 @@
IsJson
======
.. autoclass:: opik.evaluation.metrics.IsJson
:members:
:inherited-members:
@@ -0,0 +1,69 @@
LLM Judge Presets
=================
.. currentmodule:: opik.evaluation.metrics
These presets wrap common GEval prompt templates so you can instantiate judges with
one line of code. Provide an appropriate ``model`` (for example, ``"gpt-4o"``) and
ensure the backing provider is configured via ``opik.configure``.
Agent & Task Presets
--------------------
.. autoclass:: AgentTaskCompletionJudge
:special-members: __init__
:members: score
.. autoclass:: AgentToolCorrectnessJudge
:special-members: __init__
:members: score
Conversation Quality Presets
----------------------------
.. autoclass:: DialogueHelpfulnessJudge
:special-members: __init__
:members: score
.. autoclass:: QARelevanceJudge
:special-members: __init__
:members: score
.. autoclass:: SummarizationCoherenceJudge
:special-members: __init__
:members: score
.. autoclass:: SummarizationConsistencyJudge
:special-members: __init__
:members: score
.. autoclass:: PromptUncertaintyJudge
:special-members: __init__
:members: score
Risk & Bias Presets
-------------------
.. autoclass:: ComplianceRiskJudge
:special-members: __init__
:members: score
.. autoclass:: DemographicBiasJudge
:special-members: __init__
:members: score
.. autoclass:: GenderBiasJudge
:special-members: __init__
:members: score
.. autoclass:: PoliticalBiasJudge
:special-members: __init__
:members: score
.. autoclass:: RegionalBiasJudge
:special-members: __init__
:members: score
.. autoclass:: ReligiousBiasJudge
:special-members: __init__
:members: score
@@ -0,0 +1,12 @@
LLM Juries
==========
.. currentmodule:: opik.evaluation.metrics
Use :class:`LLMJuriesJudge` when you want to call multiple judges and aggregate the
results into a single decision. Provide a list of judge instances plus an
aggregation strategy (majority vote, max confidence, etc.).
.. autoclass:: LLMJuriesJudge
:special-members: __init__
:members: score
@@ -0,0 +1,6 @@
LevenshteinRatio
================
.. autoclass:: opik.evaluation.metrics.LevenshteinRatio
:members:
:inherited-members:
@@ -0,0 +1,6 @@
Moderation
==========
.. autoclass:: opik.evaluation.metrics.Moderation
:members:
:inherited-members:
@@ -0,0 +1,6 @@
RegexMatch
==========
.. autoclass:: opik.evaluation.metrics.RegexMatch
:members:
:inherited-members:
@@ -0,0 +1,15 @@
Utility Metrics
===============
.. currentmodule:: opik.evaluation.metrics
Helper components that adapt or combine other metrics. Use them to stitch existing
evaluators together without rewriting orchestration logic.
.. autoclass:: AggregatedMetric
:special-members: __init__
:members: score, validate_score_arguments
.. autoclass:: RagasMetricWrapper
:special-members: __init__
:members: score
@@ -0,0 +1,68 @@
metrics
=======
Opik includes a number of pre-built metrics to help you evaluate your LLM application.
Each metric can be called as a standalone function using the `score` method::
from opik.evaluation.metrics import Hallucination
metric = Hallucination()
metric.score(
input="What is the capital of France?",
output="The capital of France is Paris. It is famous for its iconic Eiffel Tower and rich cultural heritage.",
context=["France is a country in Western Europe. Its capital is Paris, which is known for landmarks like the Eiffel Tower."],
)
Or as part of an evaluation run using the `evaluate` function.
You can learn more about each metric in the following sections:
.. toctree::
:maxdepth: 4
:titlesonly:
Equals
RegexMatch
Contains
IsJson
LevenshteinRatio
Hallucination
GEval
Moderation
AnswerRelevance
ContextPrecision
ContextRecall
BaseMetric
ConversationThreadMetric
HeuristicMetrics
ConversationHeuristicMetrics
ConversationLLMJudges
LLMJudgePresets
LLMJuries
UtilityMetrics
The pages above fall into two categories:
- Established metric guides (e.g., ``Equals``, ``Hallucination``) that remain the
authoritative deep dives.
- Aggregation pages that collect the expanded metric families so every class
exported via :mod:`opik.evaluation.metrics` has an accompanying API reference.
Use these aggregation pages to browse the extended catalog:
- :doc:`HeuristicMetrics` — sentence/word overlap, readability, sentiment, prompt safety, and distribution comparisons.
- :doc:`ConversationHeuristicMetrics` — fast heuristics for degeneracy and knowledge retention.
- :doc:`ConversationLLMJudges` — LLM-as-a-judge conversation evaluators and session quality metrics.
- :doc:`LLMJudgePresets` — pre-built GEval presets and bias checks.
- :doc:`LLMJuries` — multi-judge aggregation.
- :doc:`UtilityMetrics` — helpers such as ``AggregatedMetric`` and ``RagasMetricWrapper``.
Import any metric directly from :mod:`opik.evaluation.metrics`, and pair these API
references with the Fern guides in
``apps/opik-documentation/documentation/fern/docs/evaluation/metrics`` for workflow
context.