Core - Create guardrail rule
curl --request POST \
--url 'https://my.orq.ai/v2/guardrail-rules' \
--header "Authorization: Bearer $ORQ_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"display_name": "Protect customer data",
"description": "Blocks sensitive customer data from model output.",
"enabled": true,
"guardrails": [{
"id": "orq_pii_detection",
"execute_on": "output",
"sample_rate": 1,
"is_guardrail": true
}]
}'
import { Orq } from '@orq-ai/node';
const client = new Orq({ apiKey: process.env.ORQ_API_KEY });
const rule = await client.guardrailRules.create({
displayName: 'Protect customer data',
description: 'Blocks sensitive customer data from model output.',
enabled: true,
guardrails: [{
id: 'orq_pii_detection',
executeOn: 'output',
sampleRate: 1,
isGuardrail: true,
}],
});
console.log(rule._id);
import os
from orq_ai_sdk import Orq
client = Orq(api_key=os.environ["ORQ_API_KEY"])
rule = client.guardrail_rules.create(
display_name="Protect customer data",
description="Blocks sensitive customer data from model output.",
enabled=True,
guardrails=[{
"id": "orq_pii_detection",
"execute_on": "output",
"sample_rate": 1,
"is_guardrail": True,
}],
)
print(rule._id)
{
"guardrail_rule": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"project_id": "<string>",
"display_name": "<string>",
"description": "<string>",
"enabled": true,
"guardrails": [
{
"id": "<string>",
"execute_on": "<string>",
"sample_rate": 123,
"is_guardrail": true,
"options": {}
}
],
"plugins": [
{
"id": "<string>",
"language": "<string>",
"entities": [
"<string>"
],
"on_failure": "<string>",
"threshold": 123,
"regions": [
"<string>"
],
"entity_thresholds": {}
}
],
"expression": {
"config": {},
"cel": "<string>"
}
}
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Guardrail Rules
Create a guardrail rule
Creates a guardrail rule with metadata and optional evaluator, plugin, and matching configuration. Rules default to disabled when enabled is omitted.
POST
/
v2
/
guardrail-rules
Core - Create guardrail rule
curl --request POST \
--url 'https://my.orq.ai/v2/guardrail-rules' \
--header "Authorization: Bearer $ORQ_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"display_name": "Protect customer data",
"description": "Blocks sensitive customer data from model output.",
"enabled": true,
"guardrails": [{
"id": "orq_pii_detection",
"execute_on": "output",
"sample_rate": 1,
"is_guardrail": true
}]
}'
import { Orq } from '@orq-ai/node';
const client = new Orq({ apiKey: process.env.ORQ_API_KEY });
const rule = await client.guardrailRules.create({
displayName: 'Protect customer data',
description: 'Blocks sensitive customer data from model output.',
enabled: true,
guardrails: [{
id: 'orq_pii_detection',
executeOn: 'output',
sampleRate: 1,
isGuardrail: true,
}],
});
console.log(rule._id);
import os
from orq_ai_sdk import Orq
client = Orq(api_key=os.environ["ORQ_API_KEY"])
rule = client.guardrail_rules.create(
display_name="Protect customer data",
description="Blocks sensitive customer data from model output.",
enabled=True,
guardrails=[{
"id": "orq_pii_detection",
"execute_on": "output",
"sample_rate": 1,
"is_guardrail": True,
}],
)
print(rule._id)
{
"guardrail_rule": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"project_id": "<string>",
"display_name": "<string>",
"description": "<string>",
"enabled": true,
"guardrails": [
{
"id": "<string>",
"execute_on": "<string>",
"sample_rate": 123,
"is_guardrail": true,
"options": {}
}
],
"plugins": [
{
"id": "<string>",
"language": "<string>",
"entities": [
"<string>"
],
"on_failure": "<string>",
"threshold": 123,
"regions": [
"<string>"
],
"entity_thresholds": {}
}
],
"expression": {
"config": {},
"cel": "<string>"
}
}
}{
"message": "<string>",
"code": 123,
"details": [
"<unknown>"
]
}Related guide: Guardrail rules guide. See the Guardrail rules guide for a walkthrough with examples.
Authorizations
Body
application/json
Was this page helpful?