Skip to content

Commit 0d35d2e

Browse files
authored
Merge pull request #90 from Portkey-AI/fix/guardrails
fix: create endpoint keys for guardrails
2 parents 103b8eb + 8522861 commit 0d35d2e

File tree

1 file changed

+65
-22
lines changed

1 file changed

+65
-22
lines changed

openapi.yaml

Lines changed: 65 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28935,28 +28935,71 @@ components:
2893528935
type: object
2893628936
description: Actions to take when guardrail checks fail or pass
2893728937
properties:
28938-
onFail:
28939-
type: string
28940-
enum: ["block", "log", "warn", "continue"]
28941-
description: Action to take when guardrail check fails
28942-
default: "block"
28943-
onPass:
28944-
type: string
28945-
enum: ["continue", "log"]
28946-
description: Action to take when guardrail check passes
28947-
default: "continue"
28948-
message:
28949-
type: string
28950-
description: Custom message to return on failure
28951-
logLevel:
28952-
type: string
28953-
enum: ["debug", "info", "warn", "error"]
28954-
description: Log level for the action
28955-
default: "info"
28956-
metadata:
28938+
deny:
28939+
type: boolean
28940+
description: Whether to deny the request when guardrail check fails
28941+
default: false
28942+
async:
28943+
type: boolean
28944+
description: Whether the guardrail check should be performed asynchronously
28945+
default: false
28946+
on_success:
2895728947
type: object
28958-
description: Additional metadata for the action
28959-
additionalProperties: true
28948+
description: Actions to take when guardrail check passes
28949+
properties:
28950+
feedback:
28951+
type: object
28952+
description: Feedback configuration for successful checks
28953+
properties:
28954+
value:
28955+
type: number
28956+
description: Feedback value for successful checks
28957+
default: 5
28958+
weight:
28959+
type: number
28960+
description: Weight of the feedback
28961+
default: 1
28962+
metadata:
28963+
type: string
28964+
description: Additional metadata for the feedback
28965+
default: ""
28966+
required:
28967+
- value
28968+
- weight
28969+
- metadata
28970+
required:
28971+
- feedback
28972+
on_fail:
28973+
type: object
28974+
description: Actions to take when guardrail check fails
28975+
properties:
28976+
feedback:
28977+
type: object
28978+
description: Feedback configuration for failed checks
28979+
properties:
28980+
value:
28981+
type: number
28982+
description: Feedback value for failed checks
28983+
default: -5
28984+
weight:
28985+
type: number
28986+
description: Weight of the feedback
28987+
default: 1
28988+
metadata:
28989+
type: string
28990+
description: Additional metadata for the feedback
28991+
default: ""
28992+
required:
28993+
- value
28994+
- weight
28995+
- metadata
28996+
required:
28997+
- feedback
28998+
required:
28999+
- deny
29000+
- async
29001+
- on_success
29002+
- on_fail
2896029003

2896129004
GuardrailCheck:
2896229005
type: object
@@ -29056,7 +29099,7 @@ components:
2905629099
name:
2905729100
type: string
2905829101
description: Custom name for this specific check instance
29059-
enabled:
29102+
is_enabled:
2906029103
type: boolean
2906129104
description: Whether this check is enabled
2906229105
default: true

0 commit comments

Comments
 (0)