Skip to content

Commit 1d53003

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 4a3f82f commit 1d53003

12 files changed

+150
-20
lines changed

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
configured_endpoints: 55
2-
openapi_spec_hash: 57e7632444ad87c5331df5d8fd648b7d
2+
openapi_spec_hash: c894ce3fb9db92c69816f06896e30067
33
config_hash: 48c3812186c899cdef23cc8de76bd2aa

‎src/codex/types/project_detect_response.py‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,11 @@ class ProjectDetectResponse(BaseModel):
5454
Codex Project, or None otherwise.
5555
"""
5656

57-
expert_review_guardrail_explanation: Optional[str] = None
58-
"""Explanation from a similar bad query log that caused this to be guardrailed"""
57+
expert_guardrail_override_explanation: Optional[str] = None
58+
"""
59+
Explanation of why the response was either guardrailed or not guardrailed by
60+
expert review. Expert review will override the original guardrail decision.
61+
"""
5962

6063
should_guardrail: bool
6164
"""

‎src/codex/types/project_list_response.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ class ProjectConfigEvalConfigCustomEvalsEvals(BaseModel):
3030
how
3131
"""
3232

33+
display_name: str
34+
"""Human-friendly name for display.
35+
36+
For default evals, prefer standardized labels; otherwise use configured name.
37+
"""
38+
3339
eval_key: str
3440
"""
3541
Unique key for eval metric - currently maps to the TrustworthyRAG name property

‎src/codex/types/project_retrieve_response.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ class ConfigEvalConfigCustomEvalsEvals(BaseModel):
2828
how
2929
"""
3030

31+
display_name: str
32+
"""Human-friendly name for display.
33+
34+
For default evals, prefer standardized labels; otherwise use configured name.
35+
"""
36+
3137
eval_key: str
3238
"""
3339
Unique key for eval metric - currently maps to the TrustworthyRAG name property

‎src/codex/types/project_return_schema.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ class ConfigEvalConfigCustomEvalsEvals(BaseModel):
2828
how
2929
"""
3030

31+
display_name: str
32+
"""Human-friendly name for display.
33+
34+
For default evals, prefer standardized labels; otherwise use configured name.
35+
"""
36+
3137
eval_key: str
3238
"""
3339
Unique key for eval metric - currently maps to the TrustworthyRAG name property

‎src/codex/types/project_validate_response.py‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,11 @@ class ProjectValidateResponse(BaseModel):
5454
Codex Project, or None otherwise.
5555
"""
5656

57-
expert_review_guardrail_explanation: Optional[str] = None
58-
"""Explanation from a similar bad query log that caused this to be guardrailed"""
57+
expert_guardrail_override_explanation: Optional[str] = None
58+
"""
59+
Explanation of why the response was either guardrailed or not guardrailed by
60+
expert review. Expert review will override the original guardrail decision.
61+
"""
5962

6063
log_id: str
6164
"""The UUID of the query log entry created for this validation request."""

‎src/codex/types/projects/eval_list_response.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ class Eval(BaseModel):
1515
how
1616
"""
1717

18+
display_name: str
19+
"""Human-friendly name for display.
20+
21+
For default evals, prefer standardized labels; otherwise use configured name.
22+
"""
23+
1824
eval_key: str
1925
"""
2026
Unique key for eval metric - currently maps to the TrustworthyRAG name property

‎src/codex/types/projects/query_log_list_by_group_response.py‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,24 +50,32 @@
5050

5151

5252
class QueryLogsByGroupQueryLogFormattedEscalationEvalScores(BaseModel):
53+
display_name: str
54+
5355
score: float
5456

5557
status: Literal["pass", "fail"]
5658

5759

5860
class QueryLogsByGroupQueryLogFormattedEvalScores(BaseModel):
61+
display_name: str
62+
5963
score: float
6064

6165
status: Literal["pass", "fail"]
6266

6367

6468
class QueryLogsByGroupQueryLogFormattedGuardrailEvalScores(BaseModel):
69+
display_name: str
70+
6571
score: float
6672

6773
status: Literal["pass", "fail"]
6874

6975

7076
class QueryLogsByGroupQueryLogFormattedNonGuardrailEvalScores(BaseModel):
77+
display_name: str
78+
7179
score: float
7280

7381
status: Literal["pass", "fail"]
@@ -384,6 +392,9 @@ class QueryLogsByGroupQueryLog(BaseModel):
384392
escalation_evals: Optional[List[str]] = None
385393
"""Evals that should trigger escalation to SME"""
386394

395+
eval_display_names: Optional[Dict[str, str]] = None
396+
"""Mapping of eval keys to display names at time of creation"""
397+
387398
eval_issue_labels: Optional[List[str]] = None
388399
"""Labels derived from evaluation scores"""
389400

@@ -402,6 +413,18 @@ class QueryLogsByGroupQueryLog(BaseModel):
402413
Used to log tool calls in the query log.
403414
"""
404415

416+
expert_guardrail_override_explanation: Optional[str] = None
417+
"""
418+
Explanation of why the response was either guardrailed or not guardrailed by
419+
expert review. Expert review will override the original guardrail decision.
420+
"""
421+
422+
expert_override_log_id: Optional[str] = None
423+
"""
424+
ID of the query log with expert review that overrode the original guardrail
425+
decision.
426+
"""
427+
405428
expert_review_created_at: Optional[datetime] = None
406429
"""When the expert review was created"""
407430

@@ -449,9 +472,6 @@ class QueryLogsByGroupQueryLog(BaseModel):
449472
primary_eval_issue_score: Optional[float] = None
450473
"""Score of the primary eval issue"""
451474

452-
similar_query_log_guardrail_explanation: Optional[str] = None
453-
"""Explanation from a similar bad query log that caused this to be guardrailed"""
454-
455475
tools: Optional[List[QueryLogsByGroupQueryLogTool]] = None
456476
"""Tools to use for the LLM call.
457477

‎src/codex/types/projects/query_log_list_groups_response.py‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,32 @@
4747

4848

4949
class FormattedEscalationEvalScores(BaseModel):
50+
display_name: str
51+
5052
score: float
5153

5254
status: Literal["pass", "fail"]
5355

5456

5557
class FormattedEvalScores(BaseModel):
58+
display_name: str
59+
5660
score: float
5761

5862
status: Literal["pass", "fail"]
5963

6064

6165
class FormattedGuardrailEvalScores(BaseModel):
66+
display_name: str
67+
6268
score: float
6369

6470
status: Literal["pass", "fail"]
6571

6672

6773
class FormattedNonGuardrailEvalScores(BaseModel):
74+
display_name: str
75+
6876
score: float
6977

7078
status: Literal["pass", "fail"]
@@ -379,6 +387,9 @@ class QueryLogListGroupsResponse(BaseModel):
379387
escalation_evals: Optional[List[str]] = None
380388
"""Evals that should trigger escalation to SME"""
381389

390+
eval_display_names: Optional[Dict[str, str]] = None
391+
"""Mapping of eval keys to display names at time of creation"""
392+
382393
eval_issue_labels: Optional[List[str]] = None
383394
"""Labels derived from evaluation scores"""
384395

@@ -397,6 +408,18 @@ class QueryLogListGroupsResponse(BaseModel):
397408
Used to log tool calls in the query log.
398409
"""
399410

411+
expert_guardrail_override_explanation: Optional[str] = None
412+
"""
413+
Explanation of why the response was either guardrailed or not guardrailed by
414+
expert review. Expert review will override the original guardrail decision.
415+
"""
416+
417+
expert_override_log_id: Optional[str] = None
418+
"""
419+
ID of the query log with expert review that overrode the original guardrail
420+
decision.
421+
"""
422+
400423
expert_review_created_at: Optional[datetime] = None
401424
"""When the expert review was created"""
402425

@@ -444,9 +467,6 @@ class QueryLogListGroupsResponse(BaseModel):
444467
primary_eval_issue_score: Optional[float] = None
445468
"""Score of the primary eval issue"""
446469

447-
similar_query_log_guardrail_explanation: Optional[str] = None
448-
"""Explanation from a similar bad query log that caused this to be guardrailed"""
449-
450470
tools: Optional[List[Tool]] = None
451471
"""Tools to use for the LLM call.
452472

‎src/codex/types/projects/query_log_list_response.py‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,32 @@
4747

4848

4949
class FormattedEscalationEvalScores(BaseModel):
50+
display_name: str
51+
5052
score: float
5153

5254
status: Literal["pass", "fail"]
5355

5456

5557
class FormattedEvalScores(BaseModel):
58+
display_name: str
59+
5660
score: float
5761

5862
status: Literal["pass", "fail"]
5963

6064

6165
class FormattedGuardrailEvalScores(BaseModel):
66+
display_name: str
67+
6268
score: float
6369

6470
status: Literal["pass", "fail"]
6571

6672

6773
class FormattedNonGuardrailEvalScores(BaseModel):
74+
display_name: str
75+
6876
score: float
6977

7078
status: Literal["pass", "fail"]
@@ -367,6 +375,9 @@ class QueryLogListResponse(BaseModel):
367375
escalation_evals: Optional[List[str]] = None
368376
"""Evals that should trigger escalation to SME"""
369377

378+
eval_display_names: Optional[Dict[str, str]] = None
379+
"""Mapping of eval keys to display names at time of creation"""
380+
370381
eval_issue_labels: Optional[List[str]] = None
371382
"""Labels derived from evaluation scores"""
372383

@@ -385,6 +396,18 @@ class QueryLogListResponse(BaseModel):
385396
Used to log tool calls in the query log.
386397
"""
387398

399+
expert_guardrail_override_explanation: Optional[str] = None
400+
"""
401+
Explanation of why the response was either guardrailed or not guardrailed by
402+
expert review. Expert review will override the original guardrail decision.
403+
"""
404+
405+
expert_override_log_id: Optional[str] = None
406+
"""
407+
ID of the query log with expert review that overrode the original guardrail
408+
decision.
409+
"""
410+
388411
expert_review_created_at: Optional[datetime] = None
389412
"""When the expert review was created"""
390413

@@ -429,9 +452,6 @@ class QueryLogListResponse(BaseModel):
429452
primary_eval_issue_score: Optional[float] = None
430453
"""Score of the primary eval issue"""
431454

432-
similar_query_log_guardrail_explanation: Optional[str] = None
433-
"""Explanation from a similar bad query log that caused this to be guardrailed"""
434-
435455
tools: Optional[List[Tool]] = None
436456
"""Tools to use for the LLM call.
437457

0 commit comments

Comments
 (0)