GuardrailRules SDK Reference - Orq.ai Documentation

GuardrailRules

List GuardrailRules

Returns a paginated list of guardrail rules for the current project.

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({});

  console.log(result);
}

run();

Show Parameters

{
    "limit": Optional[int],
    "starting_after": Optional[str],
    "ending_before": Optional[str],
    "project_id": Optional[str],
    "search": Optional[str],
    "sort_by": Optional[Literal["created_at", "updated_at", "display_name"]],
    "enabled": OptionalNullable[bool],
    "guardrail_id": List[str],
}

{
  limit?: number;
  startingAfter?: string;
  endingBefore?: string;
  projectId?: string;
  search?: string;
  sortBy?: string;
  enabled?: boolean;
  guardrailId?: string[];
}

Show Response

{
    "data": {
        "id": str,
        "created_at": date,
        "created_by_id": str,
        "description": Optional[str],
        "display_name": str,
        "enabled": bool,
        "expression": {  # optional
            "cel": str,
            "config": Dict[str, Any],
        },
        "guardrails": {  # optional
            "execute_on": Literal["input", "output", "both"],
            "id": str,
            "is_guardrail": Optional[bool],
            "sample_rate": Optional[float],
        },
        "plugins": {  # optional
            "of_pii_redaction": {
                "entities": List[str],
                "id": str,
                "language": Optional[str],
                "on_failure": Optional[str],
                "threshold": Optional[float],
            },
        },
        "project_id": str,
        "timeout": int,
        "updated_at": date,
        "updated_by_id": str,
    },
    "has_more": bool,
    "object": str,
}

{
  data: {
    id: string;
    createdAt: Date;
    createdById: string;
    description?: string;
    displayName: string;
    enabled: boolean;
    expression?: {
      cel: string;
      config?: Record<string, any>;
    };
    guardrails?: {
      executeOn: string;
      id: string;
      isGuardrail?: boolean;
      sampleRate?: number;
    };
    plugins?: {
      ofPIIRedaction: {
        entities?: string[];
        id: string;
        language?: string;
        onFailure?: string;
        threshold?: number;
      };
    };
    projectId: string;
    timeout: number;
    updatedAt: Date;
    updatedById: string;
  };
  hasMore: boolean;
  object: string;
}

Create a GuardrailRule

Creates a new guardrail rule with expression, guardrails configuration, and timeout settings.

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

{
    "display_name": str,  # required
    "description": Optional[str],
    "enabled": Optional[bool],
    "expression": {  # optional
        "cel": str,  # required
    },
    "guardrails": {  # optional
        "execute_on": Literal["input", "output", "both"],  # required
        "id": str,  # required
        "is_guardrail": Optional[bool],
        "sample_rate": Optional[float],
    },
    "project_id": Optional[str],
    "timeout": Optional[int],
}

{
  description?: string;
  displayName: string;  // required
  enabled?: boolean;
  expression?: {
    cel: string;  // required
  };
  guardrails?: {
    executeOn: string;  // required
    id: string;  // required
    isGuardrail?: boolean;
    sampleRate?: number;
  };
  projectId?: string;
  timeout?: number;
}

Show Response

{
    "id": str,
    "created_at": date,
    "created_by_id": str,
    "description": Optional[str],
    "display_name": str,
    "enabled": bool,
    "expression": {  # optional
        "cel": str,
        "config": Dict[str, Any],
    },
    "guardrails": {  # optional
        "execute_on": Literal["input", "output", "both"],
        "id": str,
        "is_guardrail": Optional[bool],
        "sample_rate": Optional[float],
    },
    "plugins": {  # optional
        "of_pii_redaction": {
            "entities": List[str],
            "id": str,
            "language": Optional[str],
            "on_failure": Optional[str],
            "threshold": Optional[float],
        },
    },
    "project_id": str,
    "timeout": int,
    "updated_at": date,
    "updated_by_id": str,
}

{
  id: string;
  createdAt: Date;
  createdById: string;
  description?: string;
  displayName: string;
  enabled: boolean;
  expression?: {
    cel: string;
    config?: Record<string, any>;
  };
  guardrails?: {
    executeOn: string;
    id: string;
    isGuardrail?: boolean;
    sampleRate?: number;
  };
  plugins?: {
    ofPIIRedaction: {
      entities?: string[];
      id: string;
      language?: string;
      onFailure?: string;
      threshold?: number;
    };
  };
  projectId: string;
  timeout: number;
  updatedAt: Date;
  updatedById: string;
}

List Used Guardrails

Returns the distinct guardrail ids referenced across all guardrail rules in 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 Response

{
    "guardrail_ids": List[str],
    "object": str,
}

{
  guardrailIds: string[];
  object: string;
}

Delete a GuardrailRule

Deletes an existing guardrail rule by ID.

from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.guardrail_rules.delete(guardrail_rule_id="<id>")

    # Use the SDK ...

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  await orq.guardrailRules.delete({
    guardrailRuleId: "<id>",
  });

}

run();

Show Parameters

{
    "guardrail_rule_id": str,  # required
}

{
  guardrailRuleId: string;  // required
}

Retrieve a GuardrailRule

Retrieves the details of an existing guardrail rule by ID.

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

{
    "guardrail_rule_id": str,  # required
}

{
  guardrailRuleId: string;  // required
}

Show Response

{
    "id": str,
    "created_at": date,
    "created_by_id": str,
    "description": Optional[str],
    "display_name": str,
    "enabled": bool,
    "expression": {  # optional
        "cel": str,
        "config": Dict[str, Any],
    },
    "guardrails": {  # optional
        "execute_on": Literal["input", "output", "both"],
        "id": str,
        "is_guardrail": Optional[bool],
        "sample_rate": Optional[float],
    },
    "plugins": {  # optional
        "of_pii_redaction": {
            "entities": List[str],
            "id": str,
            "language": Optional[str],
            "on_failure": Optional[str],
            "threshold": Optional[float],
        },
    },
    "project_id": str,
    "timeout": int,
    "updated_at": date,
    "updated_by_id": str,
}

{
  id: string;
  createdAt: Date;
  createdById: string;
  description?: string;
  displayName: string;
  enabled: boolean;
  expression?: {
    cel: string;
    config?: Record<string, any>;
  };
  guardrails?: {
    executeOn: string;
    id: string;
    isGuardrail?: boolean;
    sampleRate?: number;
  };
  plugins?: {
    ofPIIRedaction: {
      entities?: string[];
      id: string;
      language?: string;
      onFailure?: string;
      threshold?: number;
    };
  };
  projectId: string;
  timeout: number;
  updatedAt: Date;
  updatedById: string;
}

Update a GuardrailRule

Partially updates an existing guardrail rule. Only provided fields are updated.

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>",
    requestBody: {},
  });

  console.log(result);
}

run();

Show Parameters

{
    "guardrail_rule_id": str,  # required
    "description": Optional[str],
    "display_name": Optional[str],
    "enabled": Optional[bool],
    "expression": {  # optional
        "cel": str,  # required
    },
    "guardrails": {  # optional
        "execute_on": Literal["input", "output", "both"],  # required
        "id": str,  # required
        "is_guardrail": Optional[bool],
        "sample_rate": Optional[float],
    },
    "timeout": Optional[int],
}

{
  guardrailRuleId: string;  // required
  requestBody: {  // required
    description?: string;
    displayName?: string;
    enabled?: boolean;
    expression?: {
      cel: string;  // required
    };
    guardrails?: {
      executeOn: string;  // required
      id: string;  // required
      isGuardrail?: boolean;
      sampleRate?: number;
    };
    timeout?: number;
  };
}

Show Response

{
    "id": str,
    "created_at": date,
    "created_by_id": str,
    "description": Optional[str],
    "display_name": str,
    "enabled": bool,
    "expression": {  # optional
        "cel": str,
        "config": Dict[str, Any],
    },
    "guardrails": {  # optional
        "execute_on": Literal["input", "output", "both"],
        "id": str,
        "is_guardrail": Optional[bool],
        "sample_rate": Optional[float],
    },
    "plugins": {  # optional
        "of_pii_redaction": {
            "entities": List[str],
            "id": str,
            "language": Optional[str],
            "on_failure": Optional[str],
            "threshold": Optional[float],
        },
    },
    "project_id": str,
    "timeout": int,
    "updated_at": date,
    "updated_by_id": str,
}

{
  id: string;
  createdAt: Date;
  createdById: string;
  description?: string;
  displayName: string;
  enabled: boolean;
  expression?: {
    cel: string;
    config?: Record<string, any>;
  };
  guardrails?: {
    executeOn: string;
    id: string;
    isGuardrail?: boolean;
    sampleRate?: number;
  };
  plugins?: {
    ofPIIRedaction: {
      entities?: string[];
      id: string;
      language?: string;
      onFailure?: string;
      threshold?: number;
    };
  };
  projectId: string;
  timeout: number;
  updatedAt: Date;
  updatedById: string;
}

​GuardrailRules

​List GuardrailRules

​Create a GuardrailRule

​List Used Guardrails

​Delete a GuardrailRule

​Retrieve a GuardrailRule

​Update a GuardrailRule

GuardrailRules

List GuardrailRules

Create a GuardrailRule

List Used Guardrails

Delete a GuardrailRule

Retrieve a GuardrailRule

Update a GuardrailRule