Skip to content

Commit 31c25b5

Browse files
guardrails docs updated v2
1 parent 9251c15 commit 31c25b5

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

product/ai-gateway/cache-simple-and-semantic.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Portkey cache serves requests upto **20x times faster** and **cheaper**.
1818

1919
To enable Portkey cache, just add the `cache` params to your [config object](/api-reference/config-object#cache-object-details).
2020

21+
<Note>
22+
Caching will not work if the `x-portkey-debug: "false"` header is included in the request
23+
</Note>
24+
2125
## Simple Cache
2226

2327

product/guardrails.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,9 @@ Each section contains an array of guardrail execution results, structured as fol
388388
<ResponseField name="log" type="string|null">
389389
Additional logging information (if available)
390390
</ResponseField>
391+
<ResponseField name="error" type="string|object">
392+
Error message or object if the guardrail encountered an error
393+
</ResponseField>
391394
</Expandable>
392395
</ResponseField>
393396
<ResponseField name="feedback" type="object">
@@ -419,9 +422,6 @@ Each section contains an array of guardrail execution results, structured as fol
419422
<ResponseField name="async" type="boolean">
420423
Whether the guardrail was run asynchronously
421424
</ResponseField>
422-
<ResponseField name="error" type="string|object">
423-
Error message or object if the guardrail encountered an error
424-
</ResponseField>
425425
<ResponseField name="type" type="string">
426426
Always "guardrail" for guardrail hooks
427427
</ResponseField>
@@ -497,7 +497,7 @@ Here's a simplified example of what the `hook_results` might look like in a resp
497497
},
498498
{
499499
"verdict": true,
500-
"id": "character_check_guardrail",
500+
"id": "character_check_guardrai",
501501
"transformed": false,
502502
"checks": [
503503
{
@@ -594,7 +594,7 @@ Here's a simplified example of what the `hook_results` might look like in a resp
594594
}
595595
}
596596
```
597-
This example corresponds to a confgi like:
597+
This example corresponds to a `config` like:
598598
```json
599599
{
600600
"input_guardrails": [

0 commit comments

Comments
 (0)