Guardrail Rules
List Guardrail Rules
Returns guardrail rules with cursor pagination, search, status, project, sort, and referenced-guardrail filters.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.guardrail_rules.list(limit=10)
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.guardrailRules.list({
limit: 10,
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"limit": Optional[int],
"starting_after": Optional[str],
"ending_before": Optional[str],
"project_id": Optional[str],
"search": Optional[str],
"sort_by": Optional[str],
"enabled": Optional[bool],
"guardrail_id": List[str], # optional
}
{
limit?: number;
startingAfter?: string;
endingBefore?: string;
projectId?: string;
search?: string;
sortBy?: string;
enabled?: boolean;
guardrailId?: string[];
}
Show Response
Show Response
{
"object": str,
"data": [{
"id": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"project_id": str,
"display_name": str,
"description": str,
"enabled": bool,
"expression": { # optional
"config": Dict[str, Any], # optional
"cel": Optional[str],
},
"guardrails": [{
"id": str,
"execute_on": str,
"sample_rate": Optional[float],
"is_guardrail": Optional[bool],
}],
"plugins": [{
"id": Optional[str],
"language": Optional[str],
"entities": List[str], # optional
"on_failure": Optional[str],
"threshold": Optional[float],
}],
}],
"has_more": bool,
}
{
object: string;
data: {
id: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
projectId: string;
displayName: string;
description: string;
enabled: boolean;
expression?: {
config?: Record<string, unknown>;
cel?: string;
};
guardrails: {
id: string;
executeOn: string;
sampleRate?: number;
isGuardrail?: boolean;
}[];
plugins: {
id?: string;
language?: string;
entities?: string[];
onFailure?: string;
threshold?: number;
}[];
}[];
hasMore: boolean;
}
Create a Guardrail Rule
Creates a guardrail rule with metadata and optional evaluator, plugin, and matching configuration. Rules default to disabled whenenabled is omitted.
from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.guardrail_rules.create(display_name="Rosemarie_Wisoky")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.guardrailRules.create({
displayName: "Rosemarie_Wisoky",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"display_name": str, # required
"description": Optional[str],
"project_id": Optional[str],
"enabled": Optional[bool],
"expression": { # optional
"config": Dict[str, Any], # optional
"cel": Optional[str],
},
"guardrails": [{ # optional
"id": str, # required
"execute_on": str, # required
"sample_rate": Optional[float],
"is_guardrail": Optional[bool],
}],
"plugins": [{ # optional
"id": Optional[str],
"language": Optional[str],
"entities": List[str], # optional
"on_failure": Optional[str],
"threshold": Optional[float],
}],
}
{
displayName: string; // required
description?: string;
projectId?: string;
enabled?: boolean;
expression?: {
config?: Record<string, unknown>;
cel?: string;
};
guardrails?: {
id: string; // required
executeOn: string; // required
sampleRate?: number;
isGuardrail?: boolean;
}[];
plugins?: {
id?: string;
language?: string;
entities?: string[];
onFailure?: string;
threshold?: number;
}[];
}
Show Response
Show Response
{
"guardrail_rule": {
"id": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"project_id": str,
"display_name": str,
"description": str,
"enabled": bool,
"expression": { # optional
"config": Dict[str, Any], # optional
"cel": Optional[str],
},
"guardrails": [{
"id": str,
"execute_on": str,
"sample_rate": Optional[float],
"is_guardrail": Optional[bool],
}],
"plugins": [{
"id": Optional[str],
"language": Optional[str],
"entities": List[str], # optional
"on_failure": Optional[str],
"threshold": Optional[float],
}],
},
}
{
guardrailRule: {
id: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
projectId: string;
displayName: string;
description: string;
enabled: boolean;
expression?: {
config?: Record<string, unknown>;
cel?: string;
};
guardrails: {
id: string;
executeOn: string;
sampleRate?: number;
isGuardrail?: boolean;
}[];
plugins: {
id?: string;
language?: string;
entities?: string[];
onFailure?: string;
threshold?: number;
}[];
};
}
List Used Guardrails
Returns the distinct guardrail identifiers used by guardrail rules in the requested scope.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.guardrail_rules.list_used_guardrails()
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.guardrailRules.listUsedGuardrails();
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"project_id": Optional[str],
}
{
projectId?: string;
}
Show Response
Show Response
{
"object": str,
"guardrail_ids": List[str],
}
{
object: string;
guardrailIds: string[];
}
Retrieve a Guardrail Rule
Retrieves a guardrail rule by its unique identifier.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.guardrail_rules.retrieve(guardrail_rule_id="<id>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.guardrailRules.retrieve({
guardrailRuleId: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"guardrail_rule_id": str, # required
}
{
guardrailRuleId: string; // required
}
Show Response
Show Response
{
"guardrail_rule": {
"id": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"project_id": str,
"display_name": str,
"description": str,
"enabled": bool,
"expression": { # optional
"config": Dict[str, Any], # optional
"cel": Optional[str],
},
"guardrails": [{
"id": str,
"execute_on": str,
"sample_rate": Optional[float],
"is_guardrail": Optional[bool],
}],
"plugins": [{
"id": Optional[str],
"language": Optional[str],
"entities": List[str], # optional
"on_failure": Optional[str],
"threshold": Optional[float],
}],
},
}
{
guardrailRule: {
id: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
projectId: string;
displayName: string;
description: string;
enabled: boolean;
expression?: {
config?: Record<string, unknown>;
cel?: string;
};
guardrails: {
id: string;
executeOn: string;
sampleRate?: number;
isGuardrail?: boolean;
}[];
plugins: {
id?: string;
language?: string;
entities?: string[];
onFailure?: string;
threshold?: number;
}[];
};
}
Delete a Guardrail Rule
Permanently deletes a guardrail rule.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.guardrail_rules.delete(guardrail_rule_id="<id>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.guardrailRules.delete({
guardrailRuleId: "<id>",
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"guardrail_rule_id": str, # required
}
{
guardrailRuleId: string; // required
}
Update a Guardrail Rule
Partially updates guardrail-rule metadata or configuration. Project scope is immutable.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.guardrail_rules.update(guardrail_rule_id="<id>")
# Handle response
print(res)
import { Orq } from "@orq-ai/node";
const orq = new Orq({
apiKey: process.env["ORQ_API_KEY"] ?? "",
});
async function run() {
const result = await orq.guardrailRules.update({
guardrailRuleId: "<id>",
updateGuardrailRuleRequest: {},
});
console.log(result);
}
run();
Show Parameters
Show Parameters
{
"guardrail_rule_id": str, # required
"display_name": Optional[str],
"description": Optional[str],
"enabled": Optional[bool],
"expression": { # optional
"config": Dict[str, Any], # optional
"cel": Optional[str],
},
"guardrails": [{ # optional
"id": str, # required
"execute_on": str, # required
"sample_rate": Optional[float],
"is_guardrail": Optional[bool],
}],
"plugins": [{ # optional
"id": Optional[str],
"language": Optional[str],
"entities": List[str], # optional
"on_failure": Optional[str],
"threshold": Optional[float],
}],
}
{
guardrailRuleId: string; // required
updateGuardrailRuleRequest: { // required
displayName?: string;
description?: string;
enabled?: boolean;
expression?: {
config?: Record<string, unknown>;
cel?: string;
};
guardrails?: {
id: string; // required
executeOn: string; // required
sampleRate?: number;
isGuardrail?: boolean;
}[];
plugins?: {
id?: string;
language?: string;
entities?: string[];
onFailure?: string;
threshold?: number;
}[];
};
}
Show Response
Show Response
{
"guardrail_rule": {
"id": str,
"created_at": str,
"updated_at": str,
"created_by_id": str,
"updated_by_id": str,
"project_id": str,
"display_name": str,
"description": str,
"enabled": bool,
"expression": { # optional
"config": Dict[str, Any], # optional
"cel": Optional[str],
},
"guardrails": [{
"id": str,
"execute_on": str,
"sample_rate": Optional[float],
"is_guardrail": Optional[bool],
}],
"plugins": [{
"id": Optional[str],
"language": Optional[str],
"entities": List[str], # optional
"on_failure": Optional[str],
"threshold": Optional[float],
}],
},
}
{
guardrailRule: {
id: string;
createdAt: Date;
updatedAt: Date;
createdById: string;
updatedById: string;
projectId: string;
displayName: string;
description: string;
enabled: boolean;
expression?: {
config?: Record<string, unknown>;
cel?: string;
};
guardrails: {
id: string;
executeOn: string;
sampleRate?: number;
isGuardrail?: boolean;
}[];
plugins: {
id?: string;
language?: string;
entities?: string[];
onFailure?: string;
threshold?: number;
}[];
};
}