Skip to content

Commit 4f3f1ee

Browse files
committed
Fixed alias
1 parent 9920598 commit 4f3f1ee

File tree

6 files changed

+86
-48
lines changed

6 files changed

+86
-48
lines changed

deepeval/dataset/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class APIDataset(BaseModel):
99
overwrite: bool
1010
goldens: Optional[List[Golden]] = Field(default=[])
1111
conversational_goldens: Optional[List[ConversationalGolden]] = Field(
12-
default=[], alias="conversationalGoldens"
12+
default=[], serialization_alias="conversationalGoldens"
1313
)
1414

1515

deepeval/dataset/golden.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,28 @@
44

55
class Golden(BaseModel):
66
input: str
7-
actual_output: Optional[str] = Field(None, alias="actualOutput")
8-
expected_output: Optional[str] = Field(None, alias="expectedOutput")
7+
actual_output: Optional[str] = Field(
8+
None, serialization_alias="actualOutput"
9+
)
10+
expected_output: Optional[str] = Field(
11+
None, serialization_alias="expectedOutput"
12+
)
913
context: Optional[List[str]] = Field(None)
1014
retrieval_context: Optional[List[str]] = Field(
11-
None, alias="retrievalContext"
15+
None, serialization_alias="retrievalContext"
1216
)
1317
additional_metadata: Optional[Dict] = Field(
14-
None, alias="additionalMetadata"
18+
None, serialization_alias="additionalMetadata"
1519
)
1620
comments: Optional[str] = Field(None)
17-
source_file: Optional[str] = Field(None, alias="sourceFile")
21+
source_file: Optional[str] = Field(None, serialization_alias="sourceFile")
1822

1923

2024
class ConversationalGolden(BaseModel):
2125
additional_metadata: Optional[Dict] = Field(
22-
None, alias="additionalMetadata"
26+
None, serialization_alias="additionalMetadata"
2327
)
2428
comments: Optional[str] = Field(None)
25-
messages: List[Golden] = Field(default_factory=lambda: [], alias="goldens")
29+
messages: List[Golden] = Field(
30+
default_factory=lambda: [], serialization_alias="goldens"
31+
)

deepeval/event/api.py

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,28 @@ class Config:
2222

2323

2424
class APIEvent(BaseModel):
25-
name: str = Field(..., alias="name")
25+
name: str = Field(..., serialization_alias="name")
2626
input: str
2727
response: str
2828
retrieval_context: Optional[List[str]] = Field(
29-
None, alias="retrievalContext"
29+
None, serialization_alias="retrievalContext"
30+
)
31+
completion_time: Optional[float] = Field(
32+
None, serialization_alias="completionTime"
33+
)
34+
token_usage: Optional[float] = Field(None, serialization_alias="tokenUsage")
35+
token_cost: Optional[float] = Field(None, serialization_alias="tokenCost")
36+
distinct_id: Optional[str] = Field(None, serialization_alias="distinctId")
37+
conversation_id: Optional[str] = Field(
38+
None, serialization_alias="conversationId"
3039
)
31-
completion_time: Optional[float] = Field(None, alias="completionTime")
32-
token_usage: Optional[float] = Field(None, alias="tokenUsage")
33-
token_cost: Optional[float] = Field(None, alias="tokenCost")
34-
distinct_id: Optional[str] = Field(None, alias="distinctId")
35-
conversation_id: Optional[str] = Field(None, alias="conversationId")
3640
custom_properties: Optional[Dict[str, CustomProperty]] = Field(
37-
None, alias="customProperties"
41+
None, serialization_alias="customProperties"
42+
)
43+
trace_stack: Optional[Dict] = Field(None, serialization_alias="traceStack")
44+
trace_provider: Optional[str] = Field(
45+
None, serialization_alias="traceProvider"
3846
)
39-
trace_stack: Optional[Dict] = Field(None, alias="traceStack")
40-
trace_provider: Optional[str] = Field(None, alias="traceProvider")
4147
hyperparameters: Optional[Dict] = Field(None)
4248

4349
class Config:

deepeval/test_run/api.py

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,45 @@ class MetricMetadata(BaseModel):
88
success: bool
99
score: Optional[float] = None
1010
reason: Optional[str] = None
11-
strict_mode: Optional[bool] = Field(False, alias="strictMode")
12-
evaluation_model: Optional[str] = Field(None, alias="evaluationModel")
11+
strict_mode: Optional[bool] = Field(False, serialization_alias="strictMode")
12+
evaluation_model: Optional[str] = Field(
13+
None, serialization_alias="evaluationModel"
14+
)
1315
error: Optional[str] = None
14-
evaluation_cost: Union[float, None] = Field(None, alias="evaluationCost")
16+
evaluation_cost: Union[float, None] = Field(
17+
None, serialization_alias="evaluationCost"
18+
)
1519

1620

1721
class LLMApiTestCase(BaseModel):
1822
name: str
1923
input: str
20-
actual_output: str = Field(..., alias="actualOutput")
21-
expected_output: Optional[str] = Field(None, alias="expectedOutput")
24+
actual_output: str = Field(..., serialization_alias="actualOutput")
25+
expected_output: Optional[str] = Field(
26+
None, serialization_alias="expectedOutput"
27+
)
2228
context: Optional[list] = Field(None)
23-
retrieval_context: Optional[list] = Field(None, alias="retrievalContext")
29+
retrieval_context: Optional[list] = Field(
30+
None, serialization_alias="retrievalContext"
31+
)
2432
# make optional, not all test cases in a conversation will be evaluated
2533
success: Union[bool, None] = Field(None)
2634
# make optional, not all test cases in a conversation will be evaluated
2735
metrics_metadata: Union[List[MetricMetadata], None] = Field(
28-
None, alias="metricsMetadata"
36+
None, serialization_alias="metricsMetadata"
2937
)
3038
# make optional, not all test cases in a conversation will be evaluated
31-
run_duration: Union[float, None] = Field(None, alias="runDuration")
39+
run_duration: Union[float, None] = Field(
40+
None, serialization_alias="runDuration"
41+
)
3242
# make optional, not all test cases in a conversation will be evaluated
33-
evaluation_cost: Union[float, None] = Field(None, alias="evaluationCost")
43+
evaluation_cost: Union[float, None] = Field(
44+
None, serialization_alias="evaluationCost"
45+
)
3446
order: Union[int, None] = Field(None)
3547
# These should map 1 to 1 from golden
3648
additional_metadata: Optional[Dict] = Field(
37-
None, alias="additionalMetadata"
49+
None, serialization_alias="additionalMetadata"
3850
)
3951
comments: Optional[str] = Field(None)
4052
traceStack: Optional[dict] = Field(None)
@@ -68,12 +80,14 @@ class ConversationalApiTestCase(BaseModel):
6880
success: bool
6981
# metrics_metadata can be None when we're not evaluating using conversational metrics
7082
metrics_metadata: Union[List[MetricMetadata], None] = Field(
71-
None, alias="metricsMetadata"
83+
None, serialization_alias="metricsMetadata"
84+
)
85+
run_duration: float = Field(0.0, serialization_alias="runDuration")
86+
evaluation_cost: Union[float, None] = Field(
87+
None, serialization_alias="evaluationCost"
7288
)
73-
run_duration: float = Field(0.0, alias="runDuration")
74-
evaluation_cost: Union[float, None] = Field(None, alias="evaluationCost")
7589
messages: List[LLMApiTestCase] = Field(
76-
default_factory=lambda: [], alias="testCases"
90+
default_factory=lambda: [], serialization_alias="testCases"
7791
)
7892
order: Union[int, None] = Field(None)
7993

deepeval/test_run/test_run.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class TestRun(BaseModel):
9191
)
9292
deployment: Optional[bool] = Field(True)
9393
deployment_configs: Optional[DeploymentConfigs] = Field(
94-
None, alias="deploymentConfigs"
94+
None, serialization_alias="deploymentConfigs"
9595
)
9696
test_cases: List[LLMApiTestCase] = Field(
9797
alias="testCases", default_factory=lambda: []
@@ -100,15 +100,19 @@ class TestRun(BaseModel):
100100
alias="conversationalTestCases", default_factory=lambda: []
101101
)
102102
metrics_scores: List[MetricScores] = Field(
103-
default_factory=lambda: [], alias="metricsScores"
103+
default_factory=lambda: [], serialization_alias="metricsScores"
104104
)
105105
hyperparameters: Optional[Dict[Any, Any]] = Field(None)
106-
test_passed: Optional[int] = Field(None, alias="testPassed")
107-
test_failed: Optional[int] = Field(None, alias="testFailed")
108-
run_duration: float = Field(0.0, alias="runDuration")
109-
evaluation_cost: Union[float, None] = Field(None, alias="evaluationCost")
110-
dataset_alias: Optional[str] = Field(None, alias="datasetAlias")
111-
dataset_id: Optional[str] = Field(None, alias="datasetId")
106+
test_passed: Optional[int] = Field(None, serialization_alias="testPassed")
107+
test_failed: Optional[int] = Field(None, serialization_alias="testFailed")
108+
run_duration: float = Field(0.0, serialization_alias="runDuration")
109+
evaluation_cost: Union[float, None] = Field(
110+
None, serialization_alias="evaluationCost"
111+
)
112+
dataset_alias: Optional[str] = Field(
113+
None, serialization_alias="datasetAlias"
114+
)
115+
dataset_id: Optional[str] = Field(None, serialization_alias="datasetId")
112116

113117
def add_test_case(
114118
self, api_test_case: Union[LLMApiTestCase, ConversationalApiTestCase]

deepeval/tracing/tracer.py

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,29 +55,37 @@ class TraceStatus(Enum):
5555

5656
class LlmMetadata(BaseModel):
5757
model: Optional[str] = None
58-
token_count: Optional[Dict[str, int]] = Field(None, alias="tokenCount")
58+
token_count: Optional[Dict[str, int]] = Field(
59+
None, serialization_alias="tokenCount"
60+
)
5961
output_messages: Optional[List[Dict[str, str]]] = Field(
60-
None, alias="outputMessages"
62+
None, serialization_alias="outputMessages"
63+
)
64+
prompt_template: Optional[Any] = Field(
65+
None, serialization_alias="promptTemplate"
6166
)
62-
prompt_template: Optional[Any] = Field(None, alias="promptTemplate")
6367
prompt_template_variables: Optional[Any] = Field(
64-
None, alias="promptTemplateVariables"
68+
None, serialization_alias="promptTemplateVariables"
6569
)
6670

6771

6872
class EmbeddingMetadata(BaseModel):
6973
model: Optional[str] = None
70-
vector_length: Optional[int] = Field(None, alias="vectorLength")
74+
vector_length: Optional[int] = Field(
75+
None, serialization_alias="vectorLength"
76+
)
7177

7278

7379
class RetrieverMetadata(BaseModel):
74-
top_k: Optional[int] = Field(None, alias="topK")
75-
average_chunk_size: Optional[int] = Field(None, alias="averageChunkSize")
80+
top_k: Optional[int] = Field(None, serialization_alias="topK")
81+
average_chunk_size: Optional[int] = Field(
82+
None, serialization_alias="averageChunkSize"
83+
)
7684

7785

7886
class RerankingMetadata(BaseModel):
7987
model: Optional[str] = None
80-
top_k: Optional[int] = Field(None, alias="topK")
88+
top_k: Optional[int] = Field(None, serialization_alias="topK")
8189

8290

8391
@dataclass

0 commit comments

Comments
 (0)