> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# 기본 제공 Scorer 사용하기
> AI 애플리케이션 평가를 위해 Weave의 사전 정의된 Scorer를 사용합니다
W\&B Weave는 AI 애플리케이션 평가를 위한 여러 사전 정의된 Scorer를 제공합니다. 예를 들어 [환각 탐지](#hallucinationfreescorer), [요약 품질](#summarizationscorer) 등이 있습니다. 이를 활용하면 평가를 빠르게 정의하고 애플리케이션의 출력에 점수를 매기는 데 도움이 됩니다. 이 페이지에서는 각 기본 제공 Scorer와 측정 항목, 그리고 평가에서 사용하는 방법을 설명합니다.
로컬 Scorer는 Weave Python SDK에서만 사용할 수 있습니다. Weave TypeScript SDK에서는 아직 지원되지 않습니다.
TypeScript에서 Weave Scorer를 사용하려면 [함수 기반 Scorer](/ko/weave/guides/evaluation/scorers#function-based-scorers)를 참조하세요.
## 설치
Weave의 사전 정의된 Scorer를 사용하려면 추가 의존성을 몇 가지 설치하세요:
```bash theme={null}
pip install weave[scorers]
```
**LLM 평가기**
LLM을 사용하는 사전 정의된 Scorer는 litellm과 자동으로 통합됩니다. LLM 클라이언트를 전달할 필요가 없습니다. 대신 `model_id`를 설정하세요. [지원되는 모델](https://docs.litellm.ai/docs/providers)을 확인하세요.
## `HallucinationFreeScorer`
이 Scorer는 입력 데이터를 바탕으로 AI 시스템의 출력에 할루시네이션이 있는지 확인합니다.
```python lines theme={null}
from weave.scorers import HallucinationFreeScorer
scorer = HallucinationFreeScorer()
```
**사용자 지정**
* Scorer의 `system_prompt` 및 `user_prompt` 필드를 사용자 지정하여 "hallucination"의 의미를 원하는 방식에 맞게 정의하세요.
**참고**
* `score` 메서드는 `context`라는 이름의 입력 컬럼을 필요로 합니다. 데이터셋에서 다른 이름을 사용하는 경우, [`column_map` 속성을 사용](#use-column-mapping)하여 `context`를 데이터셋 컬럼에 매핑하세요.
다음 예시에서는 평가 컨텍스트에서 `HallucinationFreeScorer`를 사용합니다:
```python lines theme={null}
import asyncio
import weave
from weave.scorers import HallucinationFreeScorer
# 필요한 경우 column 매핑으로 Scorer를 초기화합니다.
hallucination_scorer = HallucinationFreeScorer(
model_id="openai/gpt-4o", # litellm이 지원하는 다른 모델도 사용 가능합니다
column_map={"context": "input", "output": "other_col"}
)
# 데이터셋 생성
dataset = [
{"input": "John likes various types of cheese."},
{"input": "Pepe likes various types of cheese."},
]
@weave.op
def model(input: str) -> str:
return "The person's favorite cheese is cheddar."
# 평가 실행
evaluation = weave.Evaluation(
dataset=dataset,
scorers=[hallucination_scorer],
)
result = asyncio.run(evaluation.evaluate(model))
print(result)
# 출력 예시:
# {'HallucinationFreeScorer': {'has_hallucination': {'true_count': 2, 'true_fraction': 1.0}}, 'model_latency': {'mean': ...}}
```
***
## `SummarizationScorer`
LLM으로 요약문을 원문과 비교해 요약 품질을 평가합니다.
```python lines theme={null}
from weave.scorers import SummarizationScorer
scorer = SummarizationScorer(
model_id="openai/gpt-4o" # 또는 litellm에서 지원하는 다른 모델
)
```
**작동 방식**
이 Scorer는 두 가지 방식으로 요약을 평가합니다.
1. **엔터티 밀도:** 요약에 언급된 고유 엔터티(예: 이름, 장소, 사물) 수를 요약의 전체 단어 수와 비교해 요약의 "정보 밀도"를 추정합니다. 엔터티 추출에는 LLM을 사용합니다. 이는 [Chain of Density 논문](https://arxiv.org/abs/2309.04269)에서 엔터티 밀도를 활용하는 방식과 유사합니다.
2. **품질 등급:** LLM 평가자가 요약을 `poor`, `ok`, `excellent` 중 하나로 평가합니다. 그런 다음 이 등급을 점수(poor는 0.0, ok는 0.5, excellent는 1.0)로 매핑해 집계 성능 평가에 사용합니다.
**맞춤 설정**
* `summarization_evaluation_system_prompt`와 `summarization_evaluation_prompt`를 조정해 평가 프로세스를 맞춤 설정하세요.
**참고**
* 이 Scorer는 내부적으로 litellm을 사용합니다.
* `score` 방법은 원본 텍스트(요약 대상 텍스트)가 `input` 컬럼에 있어야 합니다. 데이터셋에서 다른 이름을 사용하는 경우 [`column_map` 속성을 사용하세요](#use-column-mapping).
다음 예시에서는 평가 컨텍스트에서 `SummarizationScorer`를 사용합니다.
```python lines theme={null}
import asyncio
import weave
from weave.scorers import SummarizationScorer
class SummarizationModel(weave.Model):
@weave.op()
async def predict(self, input: str) -> str:
return "This is a summary of the input text."
# Scorer 초기화
summarization_scorer = SummarizationScorer(
model_id="openai/gpt-4o" # 또는 litellm에서 지원하는 다른 모델
)
# 데이터셋 생성
dataset = [
{"input": "The quick brown fox jumps over the lazy dog."},
{"input": "Artificial Intelligence is revolutionizing various industries."}
]
# 평가 실행
evaluation = weave.Evaluation(dataset=dataset, scorers=[summarization_scorer])
results = asyncio.run(evaluation.evaluate(SummarizationModel()))
print(results)
# 출력 예시:
# {'SummarizationScorer': {'is_entity_dense': {'true_count': 0, 'true_fraction': 0.0}, 'summarization_eval_score': {'mean': 0.0}, 'entity_density': {'mean': 0.0}}, 'model_latency': {'mean': ...}}
```
***
## `OpenAIModerationScorer`
`OpenAIModerationScorer`는 OpenAI의 Moderation API를 사용해 AI 시스템의 출력에 혐오 표현이나 음란물 등 허용되지 않는 콘텐츠가 포함되어 있는지 확인합니다.
```python lines theme={null}
from weave.scorers import OpenAIModerationScorer
scorer = OpenAIModerationScorer()
```
**작동 방식**
* AI의 `출력`을 OpenAI Moderation 엔드포인트로 전송하고, 콘텐츠가 플래그 대상으로 표시되었는지를 나타내는 구조화된 응답을 반환합니다.
다음 예시에서는 평가 컨텍스트에서 `OpenAIModerationScorer`를 사용합니다:
```python lines theme={null}
import asyncio
import weave
from weave.scorers import OpenAIModerationScorer
class MyModel(weave.Model):
@weave.op
async def predict(self, input: str) -> str:
return input
# Scorer 초기화
moderation_scorer = OpenAIModerationScorer()
# 데이터셋 생성
dataset = [
{"input": "I love puppies and kittens!"},
{"input": "I hate everyone and want to hurt them."}
]
# 평가 실행
evaluation = weave.Evaluation(dataset=dataset, scorers=[moderation_scorer])
results = asyncio.run(evaluation.evaluate(MyModel()))
print(results)
# 예시 출력:
# {'OpenAIModerationScorer': {'flagged': {'true_count': 1, 'true_fraction': 0.5}, 'categories': {'violence': {'true_count': 1, 'true_fraction': 1.0}}}, 'model_latency': {'mean': ...}}
```
***
## `EmbeddingSimilarityScorer`
`EmbeddingSimilarityScorer`는 AI 시스템의 `출력`과 데이터셋의 대상 텍스트 임베딩 간 코사인 유사도를 계산합니다. AI의 `출력`이 레퍼런스 텍스트와 얼마나 유사한지 측정할 때 사용하세요.
```python lines theme={null}
from weave.scorers import EmbeddingSimilarityScorer
similarity_scorer = EmbeddingSimilarityScorer(
model_id="openai/text-embedding-3-small", # litellm이 지원하는 다른 모델도 사용 가능
threshold=0.4 # 코사인 유사도 임계값
)
```
**파라미터**
* `threshold` (float): 두 텍스트를 유사하다고 판단하는 데 필요한 최소 코사인 유사도 점수입니다(-1\~1 사이, 기본값은 `0.5`).
다음 예시에서는 평가 컨텍스트에서 `EmbeddingSimilarityScorer`를 사용합니다:
```python lines theme={null}
import asyncio
import weave
from weave.scorers import EmbeddingSimilarityScorer
# Scorer 초기화
similarity_scorer = EmbeddingSimilarityScorer(
model_id="openai/text-embedding-3-small", # 또는 litellm에서 지원하는 다른 모델
threshold=0.7
)
# 데이터셋 생성
dataset = [
{
"input": "He's name is John",
"target": "John likes various types of cheese.",
},
{
"input": "He's name is Pepe.",
"target": "Pepe likes various types of cheese.",
},
]
# 모델 정의
@weave.op
def model(input: str) -> str:
return "John likes various types of cheese."
# 평가 실행
evaluation = weave.Evaluation(
dataset=dataset,
scorers=[similarity_scorer],
)
result = asyncio.run(evaluation.evaluate(model))
print(result)
# 출력 예시:
# {'EmbeddingSimilarityScorer': {'is_similar': {'true_count': 1, 'true_fraction': 0.5}, 'similarity_score': {'mean': 0.844851403}}, 'model_latency': {'mean': ...}}
```
***
## `ValidJSONScorer`
`ValidJSONScorer`는 AI 시스템의 출력이 유효한 JSON인지 확인합니다. 출력이 JSON 형식일 것으로 예상되며 그 유효성을 확인해야 할 때 유용한 Scorer입니다.
```python lines theme={null}
from weave.scorers import ValidJSONScorer
json_scorer = ValidJSONScorer()
```
다음 예시에서는 평가 맥락에서 `ValidJSONScorer`를 사용합니다:
```python lines theme={null}
import asyncio
import weave
from weave.scorers import ValidJSONScorer
class JSONModel(weave.Model):
@weave.op()
async def predict(self, input: str) -> str:
# 이것은 플레이스홀더입니다.
# 실제 시나리오에서는 JSON을 생성합니다.
return '{"key": "value"}'
model = JSONModel()
json_scorer = ValidJSONScorer()
dataset = [
{"input": "Generate a JSON object with a key and value"},
{"input": "Create an invalid JSON"}
]
evaluation = weave.Evaluation(dataset=dataset, scorers=[json_scorer])
results = asyncio.run(evaluation.evaluate(model))
print(results)
# 예시 출력:
# {'ValidJSONScorer': {'json_valid': {'true_count': 2, 'true_fraction': 1.0}}, 'model_latency': {'mean': ...}}
```
***
## `ValidXMLScorer`
`ValidXMLScorer`는 AI 시스템의 출력이 유효한 XML인지 확인합니다. XML 형식의 출력이 예상될 때 사용하세요.
```python lines theme={null}
from weave.scorers import ValidXMLScorer
xml_scorer = ValidXMLScorer()
```
다음 예시에서는 평가 맥락에서 `ValidXMLScorer`를 사용합니다:
```python lines theme={null}
import asyncio
import weave
from weave.scorers import ValidXMLScorer
class XMLModel(weave.Model):
@weave.op()
async def predict(self, input: str) -> str:
# 이것은 플레이스홀더입니다. 실제 시나리오에서는 XML을 생성합니다.
return 'value'
model = XMLModel()
xml_scorer = ValidXMLScorer()
dataset = [
{"input": "Generate a valid XML with a root element"},
{"input": "Create an invalid XML"}
]
evaluation = weave.Evaluation(dataset=dataset, scorers=[xml_scorer])
results = asyncio.run(evaluation.evaluate(model))
print(results)
# 출력 예시:
# {'ValidXMLScorer': {'xml_valid': {'true_count': 2, 'true_fraction': 1.0}}, 'model_latency': {'mean': ...}}
```
***
## `PydanticScorer`
`PydanticScorer`는 AI 시스템의 출력이 지정된 스키마 또는 데이터 구조를 따르도록, 그 출력이 Pydantic 모델에 맞는지 검증합니다.
```python lines theme={null}
from weave.scorers import PydanticScorer
from pydantic import BaseModel
class FinancialReport(BaseModel):
revenue: int
year: str
pydantic_scorer = PydanticScorer(model=FinancialReport)
```
***
## RAGAS - `ContextEntityRecallScorer`
`ContextEntityRecallScorer`는 AI 시스템의 출력과 제공된 컨텍스트에서 모두 entity를 추출한 뒤 재현율 점수를 계산해 컨텍스트 재현율을 추정합니다. Retrieval Augmented Generation Assessment([RAGAS](https://github.com/explodinggradients/ragas)) 평가 라이브러리를 기반으로 합니다.
```python lines theme={null}
from weave.scorers import ContextEntityRecallScorer
entity_recall_scorer = ContextEntityRecallScorer(
model_id="openai/gpt-4o"
)
```
**작동 방식**
* LLM을 사용해 출력과 컨텍스트에서 고유한 entity를 추출하고 재현율을 계산합니다.
* **재현율**은 컨텍스트의 중요한 entity 중 출력에 포함된 비율을 나타냅니다.
* 재현율 점수가 포함된 딕셔너리를 반환합니다.
**참고**
* 데이터셋에 `context` 컬럼이 있어야 합니다. 컬럼 이름이 다르면 [`column_map` 속성을 사용하세요](#use-column-mapping).
***
## RAGAS - `ContextRelevancyScorer`
`ContextRelevancyScorer`는 제공된 컨텍스트가 AI 시스템의 출력과 얼마나 관련성이 있는지 평가합니다. RAGAS 평가 라이브러리를 기반으로 합니다.
```python lines theme={null}
from weave.scorers import ContextRelevancyScorer
relevancy_scorer = ContextRelevancyScorer(
model_id="openai/gpt-4o", # 또는 litellm에서 지원하는 다른 모델
relevancy_prompt="""
Given the following question and context, rate the relevancy of the context to the question on a scale from 0 to 1.
Question: {question}
Context: {context}
Relevancy Score (0-1):
"""
)
```
**작동 방식**
* LLM을 사용해 컨텍스트가 출력과 얼마나 관련성이 있는지 0\~1 척도로 평가합니다.
* `relevancy_score`가 포함된 딕셔너리를 반환합니다.
**참고 사항**
* 데이터셋에 `context` 컬럼이 있어야 합니다. 컬럼 이름이 다른 경우 [ `column_map` 속성을 사용하세요](#use-column-mapping).
* 관련성을 평가하는 방식을 정의하려면 `relevancy_prompt`를 사용자 지정하세요.
다음 예시에서는 평가 맥락에서 `ContextEntityRecallScorer`와 `ContextRelevancyScorer`를 함께 사용합니다:
```python lines theme={null}
import asyncio
from textwrap import dedent
import weave
from weave.scorers import ContextEntityRecallScorer, ContextRelevancyScorer
class RAGModel(weave.Model):
@weave.op()
async def predict(self, question: str) -> str:
"Retrieve relevant context"
return "Paris is the capital of France."
# 프롬프트 정의
relevancy_prompt: str = dedent("""
Given the following question and context, rate the relevancy of the context to the question on a scale from 0 to 1.
Question: {question}
Context: {context}
Relevancy Score (0-1):
""")
# Scorer 초기화
entity_recall_scorer = ContextEntityRecallScorer()
relevancy_scorer = ContextRelevancyScorer(relevancy_prompt=relevancy_prompt)
# 데이터셋 생성
dataset = [
{
"question": "What is the capital of France?",
"context": "Paris is the capital city of France."
},
{
"question": "Who wrote Romeo and Juliet?",
"context": "William Shakespeare wrote many famous plays."
}
]
# 평가 실행
evaluation = weave.Evaluation(
dataset=dataset,
scorers=[entity_recall_scorer, relevancy_scorer]
)
results = asyncio.run(evaluation.evaluate(RAGModel()))
print(results)
# 출력 예시:
# {'ContextEntityRecallScorer': {'recall': {'mean': ...}},
# 'ContextRelevancyScorer': {'relevancy_score': {'mean': ...}},
# 'model_latency': {'mean': ...}}
```
**참고:** 기본 제공 Scorer는 `openai/gpt-4o` 및 `openai/text-embedding-3-small`과 같은 OpenAI 모델에 맞게 조정되어 있습니다. 다른 공급자를 사용하려면 `model_id` 필드를 업데이트하세요. 예를 들어 Anthropic 모델을 사용하려면 다음과 같습니다:
```python lines theme={null}
from weave.scorers import SummarizationScorer
# Anthropic의 Claude 모델로 전환
summarization_scorer = SummarizationScorer(
model_id="anthropic/claude-3-5-sonnet-20240620"
)
```