rubric_llm 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +2 -2
- data/lib/rubric_llm/metrics/base.rb +23 -0
- data/lib/rubric_llm/metrics/context_precision.rb +11 -8
- data/lib/rubric_llm/metrics/context_recall.rb +15 -8
- data/lib/rubric_llm/metrics/correctness.rb +6 -2
- data/lib/rubric_llm/metrics/factual_accuracy.rb +22 -6
- data/lib/rubric_llm/metrics/faithfulness.rb +6 -3
- data/lib/rubric_llm/metrics/relevance.rb +5 -2
- data/lib/rubric_llm/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fe5f964e023687c815cf95b56673d05f3103f15a679ebb6f5d272d287c396163
|
|
4
|
+
data.tar.gz: f082d306d7e50347dc6a53caf453dc7e24abbd0213012711506692516ff38a47
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8cdba0f5196529eed16d2c19edaca418f8feedca62244724a206e6b4baa1ab9ef13660a3cf24f1711ad52e43856f325648b88ee8443da0cce7bee9a9f9b637d7
|
|
7
|
+
data.tar.gz: c2828756fca3eb3395567bd61ebac9b80bdffd12dbdd4b410f000b5001b68169be14101a95bde4c0541f98526c9bdc7ff665e22e2d918fda75072af4dd1e4dc2
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.8.0] - 2026-09-22
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
|
|
12
|
+
- Calculate faithfulness, context precision, and context recall scores from the judge's item-level decisions instead of its suggested score
|
|
13
|
+
- Define scoring criteria for correctness, relevance, and factual accuracy, with factual accuracy measuring contradictions against the reference rather than missing facts
|
|
14
|
+
- Reject missing or malformed metric details, including missing reasoning, empty claim or fact lists, invalid context indices, and factual accuracy scores that conflict with their discrepancy lists. Context indices must be 1-based integers. Evaluation returns `nil` with an error for these responses; direct metric calls raise `JudgeError`
|
|
15
|
+
|
|
8
16
|
## [0.7.0] - 2026-09-22
|
|
9
17
|
|
|
10
18
|
### Added
|
data/README.md
CHANGED
|
@@ -165,14 +165,14 @@ RubyLLM classifies OpenAI's HTTP 429 `insufficient_quota` response as a rate-lim
|
|
|
165
165
|
|
|
166
166
|
### LLM-as-Judge Metrics
|
|
167
167
|
|
|
168
|
-
These metrics use a judge LLM to evaluate quality. Each
|
|
168
|
+
These metrics use a judge LLM to evaluate quality. Each returns a 0.0–1.0 score. Faithfulness counts supported answer claims, context precision counts relevant non-empty chunks, and context recall counts covered reference facts. These three scores are calculated from the judge's item-level decisions, not its suggested score. An empty or malformed item list (including an answer with no factual claims) is an evaluation error, not a quality score. Correctness, relevance, and factual accuracy use judge scores with metric-specific scoring criteria. The judge still decides what counts as a claim, fact, or relevant chunk, so scores are not deterministic across models.
|
|
169
169
|
|
|
170
170
|
| Metric | Question it answers | Requires |
|
|
171
171
|
|--------|-------------------|----------|
|
|
172
172
|
| **Correctness** | Does the answer match the known correct answer? | `ground_truth` |
|
|
173
173
|
| **Relevance** | Does the answer address what was asked? | `question` |
|
|
174
174
|
| **Context Precision** | Are the retrieved context chunks actually relevant? | `question`, `context` |
|
|
175
|
-
| **Factual Accuracy** |
|
|
175
|
+
| **Factual Accuracy** | Does the candidate contradict the reference (not omit it)? | `ground_truth` |
|
|
176
176
|
| **Context Recall** | Do the contexts cover the information in the ground truth? | `context`, `ground_truth` |
|
|
177
177
|
| **Faithfulness** | Is every claim in the answer supported by the context? | `context` |
|
|
178
178
|
|
|
@@ -35,6 +35,29 @@ module RubricLLM
|
|
|
35
35
|
def judge_eval(system_prompt:, user_prompt:)
|
|
36
36
|
judge.call(system_prompt:, user_prompt:)
|
|
37
37
|
end
|
|
38
|
+
|
|
39
|
+
def checked_items(result, key, label:, value_key:, text_key:, count: nil)
|
|
40
|
+
items = result[key]
|
|
41
|
+
valid = items.is_a?(Array) && items.any? && (count.nil? || items.size == count)
|
|
42
|
+
valid &&= items.all? do |item|
|
|
43
|
+
item.is_a?(Hash) && item[text_key].is_a?(String) && !item[text_key].strip.empty? &&
|
|
44
|
+
[true, false].include?(item[value_key])
|
|
45
|
+
end
|
|
46
|
+
raise JudgeError, "Judge response has invalid #{label}" unless valid
|
|
47
|
+
|
|
48
|
+
items
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
def fraction(items, key)
|
|
52
|
+
items.count { |item| item[key] }.to_f / items.size
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
def reasoning_for(result)
|
|
56
|
+
reasoning = result["reasoning"]
|
|
57
|
+
raise JudgeError, "Judge response missing reasoning" unless reasoning.is_a?(String) && !reasoning.strip.empty?
|
|
58
|
+
|
|
59
|
+
reasoning
|
|
60
|
+
end
|
|
38
61
|
end
|
|
39
62
|
end
|
|
40
63
|
end
|
|
@@ -5,7 +5,8 @@ module RubricLLM
|
|
|
5
5
|
class ContextPrecision < Base
|
|
6
6
|
SYSTEM_PROMPT = <<~PROMPT
|
|
7
7
|
You are an evaluation judge. Assess whether the retrieved contexts are relevant to the question.
|
|
8
|
-
Context precision
|
|
8
|
+
Context precision is the fraction of retrieved chunks useful for answering the question.
|
|
9
|
+
Classify every numbered chunk once, in order. Use the displayed 1-based index.
|
|
9
10
|
|
|
10
11
|
Respond with JSON only:
|
|
11
12
|
{
|
|
@@ -29,18 +30,20 @@ module RubricLLM
|
|
|
29
30
|
PROMPT
|
|
30
31
|
|
|
31
32
|
result = judge_eval(system_prompt: SYSTEM_PROMPT, user_prompt:)
|
|
32
|
-
normalize(result)
|
|
33
|
+
normalize(result, context_chunks.size)
|
|
33
34
|
end
|
|
34
35
|
|
|
35
36
|
private
|
|
36
37
|
|
|
37
|
-
def normalize(result)
|
|
38
|
+
def normalize(result, count)
|
|
39
|
+
context_scores = checked_items(result, "context_scores", label: "context scores", count:, value_key: "relevant", text_key: "reason")
|
|
40
|
+
unless context_scores.each_with_index.all? { |item, index| item["index"].is_a?(Integer) && item["index"] == index + 1 }
|
|
41
|
+
raise JudgeError, "Judge response has invalid context indices"
|
|
42
|
+
end
|
|
43
|
+
|
|
38
44
|
{
|
|
39
|
-
score:
|
|
40
|
-
details: {
|
|
41
|
-
context_scores: result["context_scores"],
|
|
42
|
-
reasoning: result["reasoning"]
|
|
43
|
-
}
|
|
45
|
+
score: fraction(context_scores, "relevant"),
|
|
46
|
+
details: { context_scores:, reasoning: reasoning_for(result) }
|
|
44
47
|
}
|
|
45
48
|
end
|
|
46
49
|
end
|
|
@@ -5,7 +5,10 @@ module RubricLLM
|
|
|
5
5
|
class ContextRecall < Base
|
|
6
6
|
SYSTEM_PROMPT = <<~PROMPT
|
|
7
7
|
You are an evaluation judge. Assess whether the provided contexts cover the information in the ground truth.
|
|
8
|
-
Context recall
|
|
8
|
+
Context recall is the fraction of facts in the ground truth supported by the contexts.
|
|
9
|
+
List every distinct factual claim in the ground truth. Mark it covered only if a numbered
|
|
10
|
+
context supports it, and use that context's 1-based index as source_context.
|
|
11
|
+
Use null for source_context when a fact is not covered.
|
|
9
12
|
|
|
10
13
|
Respond with JSON only:
|
|
11
14
|
{
|
|
@@ -31,18 +34,22 @@ module RubricLLM
|
|
|
31
34
|
PROMPT
|
|
32
35
|
|
|
33
36
|
result = judge_eval(system_prompt: SYSTEM_PROMPT, user_prompt:)
|
|
34
|
-
normalize(result)
|
|
37
|
+
normalize(result, context_chunks.size)
|
|
35
38
|
end
|
|
36
39
|
|
|
37
40
|
private
|
|
38
41
|
|
|
39
|
-
def normalize(result)
|
|
42
|
+
def normalize(result, count)
|
|
43
|
+
covered_facts = checked_items(result, "covered_facts", label: "covered facts", value_key: "covered", text_key: "fact")
|
|
44
|
+
valid_sources = covered_facts.all? do |item|
|
|
45
|
+
source = item["source_context"]
|
|
46
|
+
item["covered"] ? source.is_a?(Integer) && (1..count).cover?(source) : source.nil?
|
|
47
|
+
end
|
|
48
|
+
raise JudgeError, "Judge response has invalid source contexts" unless valid_sources
|
|
49
|
+
|
|
40
50
|
{
|
|
41
|
-
score:
|
|
42
|
-
details: {
|
|
43
|
-
covered_facts: result["covered_facts"],
|
|
44
|
-
reasoning: result["reasoning"]
|
|
45
|
-
}
|
|
51
|
+
score: fraction(covered_facts, "covered"),
|
|
52
|
+
details: { covered_facts:, reasoning: reasoning_for(result) }
|
|
46
53
|
}
|
|
47
54
|
end
|
|
48
55
|
end
|
|
@@ -5,7 +5,11 @@ module RubricLLM
|
|
|
5
5
|
class Correctness < Base
|
|
6
6
|
SYSTEM_PROMPT = <<~PROMPT
|
|
7
7
|
You are an evaluation judge. Assess whether the answer matches the ground truth.
|
|
8
|
-
Consider semantic equivalence, not just exact string matching.
|
|
8
|
+
Consider semantic equivalence, not just exact string matching. Score the answer against
|
|
9
|
+
the question and reference: 1.0 if it fully answers with no material errors, 0.5 if it
|
|
10
|
+
is partly correct but misses required information or includes a material error, and 0.0
|
|
11
|
+
if it is wrong or does not answer. Use intermediate values for partial cases and explain
|
|
12
|
+
what is correct, missing, or wrong. Do not require irrelevant reference details.
|
|
9
13
|
|
|
10
14
|
Respond with JSON only:
|
|
11
15
|
{
|
|
@@ -36,7 +40,7 @@ module RubricLLM
|
|
|
36
40
|
def normalize(result)
|
|
37
41
|
{
|
|
38
42
|
score: Float(result["score"]),
|
|
39
|
-
details: { reasoning: result
|
|
43
|
+
details: { reasoning: reasoning_for(result) }
|
|
40
44
|
}
|
|
41
45
|
end
|
|
42
46
|
end
|
|
@@ -5,7 +5,12 @@ module RubricLLM
|
|
|
5
5
|
class FactualAccuracy < Base
|
|
6
6
|
SYSTEM_PROMPT = <<~PROMPT
|
|
7
7
|
You are an evaluation judge. Compare the factual claims in the candidate answer against the reference answer.
|
|
8
|
-
Identify
|
|
8
|
+
Identify contradictions in candidate factual claims against the reference. Do not penalize
|
|
9
|
+
missing reference facts, which correctness measures. Score 1.0 if there are no contradictions,
|
|
10
|
+
0.5 if minor factual contradictions affect part of the answer, and 0.0 if major contradictions
|
|
11
|
+
undermine the answer. Use intermediate values for partial cases. Explain the score and list
|
|
12
|
+
each contradiction with severity minor or major. If the reference does not establish whether
|
|
13
|
+
a claim is true, do not call it a contradiction.
|
|
9
14
|
|
|
10
15
|
Respond with JSON only:
|
|
11
16
|
{
|
|
@@ -33,14 +38,25 @@ module RubricLLM
|
|
|
33
38
|
private
|
|
34
39
|
|
|
35
40
|
def normalize(result)
|
|
41
|
+
discrepancies = result["discrepancies"]
|
|
42
|
+
unless discrepancies.is_a?(Array) && discrepancies.all? { |item| valid_discrepancy?(item) }
|
|
43
|
+
raise JudgeError, "Judge response has invalid discrepancies"
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
score = Float(result["score"])
|
|
47
|
+
raise JudgeError, "Judge response score conflicts with no discrepancies" if discrepancies.empty? && score < 1.0
|
|
48
|
+
raise JudgeError, "Judge response score conflicts with discrepancies" if discrepancies.any? && score >= 1.0
|
|
49
|
+
|
|
36
50
|
{
|
|
37
|
-
score
|
|
38
|
-
details: {
|
|
39
|
-
discrepancies: result["discrepancies"],
|
|
40
|
-
reasoning: result["reasoning"]
|
|
41
|
-
}
|
|
51
|
+
score:,
|
|
52
|
+
details: { discrepancies:, reasoning: reasoning_for(result) }
|
|
42
53
|
}
|
|
43
54
|
end
|
|
55
|
+
|
|
56
|
+
def valid_discrepancy?(item)
|
|
57
|
+
item.is_a?(Hash) && %w[claim reference].all? { |key| item[key].is_a?(String) && !item[key].strip.empty? } &&
|
|
58
|
+
%w[minor major].include?(item["severity"])
|
|
59
|
+
end
|
|
44
60
|
end
|
|
45
61
|
end
|
|
46
62
|
end
|
|
@@ -6,6 +6,8 @@ module RubricLLM
|
|
|
6
6
|
SYSTEM_PROMPT = <<~PROMPT
|
|
7
7
|
You are an evaluation judge. Assess whether the answer is faithful to the provided context.
|
|
8
8
|
A faithful answer only contains information that is supported by the context.
|
|
9
|
+
List every factual claim in the answer. Mark a claim supported only if the context supports it.
|
|
10
|
+
The score is the fraction of supported claims. If there are no factual claims, do not invent claims.
|
|
9
11
|
|
|
10
12
|
Respond with JSON only:
|
|
11
13
|
{
|
|
@@ -36,11 +38,12 @@ module RubricLLM
|
|
|
36
38
|
private
|
|
37
39
|
|
|
38
40
|
def normalize(result)
|
|
41
|
+
claims = checked_items(result, "claims", label: "claims", value_key: "supported", text_key: "claim")
|
|
39
42
|
{
|
|
40
|
-
score:
|
|
43
|
+
score: fraction(claims, "supported"),
|
|
41
44
|
details: {
|
|
42
|
-
claims
|
|
43
|
-
reasoning: result
|
|
45
|
+
claims:,
|
|
46
|
+
reasoning: reasoning_for(result)
|
|
44
47
|
}
|
|
45
48
|
}
|
|
46
49
|
end
|
|
@@ -5,7 +5,10 @@ module RubricLLM
|
|
|
5
5
|
class Relevance < Base
|
|
6
6
|
SYSTEM_PROMPT = <<~PROMPT
|
|
7
7
|
You are an evaluation judge. Assess whether the answer is relevant to the question.
|
|
8
|
-
A relevant answer directly addresses what was asked.
|
|
8
|
+
A relevant answer directly addresses what was asked, regardless of its factual accuracy.
|
|
9
|
+
Score 1.0 if it directly addresses all parts of the question, 0.5 if it addresses only
|
|
10
|
+
part or is mostly tangential, and 0.0 if it does not address the question. Use intermediate
|
|
11
|
+
values for partial cases and explain the score. Do not score correctness here.
|
|
9
12
|
|
|
10
13
|
Respond with JSON only:
|
|
11
14
|
{
|
|
@@ -32,7 +35,7 @@ module RubricLLM
|
|
|
32
35
|
def normalize(result)
|
|
33
36
|
{
|
|
34
37
|
score: Float(result["score"]),
|
|
35
|
-
details: { reasoning: result
|
|
38
|
+
details: { reasoning: reasoning_for(result) }
|
|
36
39
|
}
|
|
37
40
|
end
|
|
38
41
|
end
|
data/lib/rubric_llm/version.rb
CHANGED