Skip to content

README.md

Latest commit

 

History

History
271 lines (178 loc) · 19.2 KB

README.md

File metadata and controls

271 lines (178 loc) · 19.2 KB
Raw

GuardrailRules

Overview

Available Operations

list

Returns guardrail rules with cursor pagination, search, status, project, sort, and referenced-guardrail filters.

Example Usage

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)

Parameters

Parameter Type Required Description
limit Optional[int] ➖ N/A
starting_after Optional[str] ➖ N/A
ending_before Optional[str] ➖ N/A
project_id Optional[str] ➖ N/A
search Optional[str] ➖ N/A
sort_by Optional[str] ➖ N/A
enabled Optional[bool] ➖ N/A
guardrail_id List[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListGuardrailRulesResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

create

Creates a guardrail rule with metadata and optional evaluator, plugin, and matching configuration. Rules default to disabled when enabled is omitted.

Example Usage

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)

Parameters

Parameter Type Required Description Example
display_name str ✔️ N/A Content policy
description Optional[str] ➖ N/A
project_id Optional[str] ➖ Optional project scope. Omit for a workspace-wide rule.
enabled Optional[bool] ➖ Whether the rule is active. Defaults to false when omitted.
expression Optional[models.GuardrailRuleExpression] ➖ N/A
guardrails List[models.GuardrailRuleGuardrail] ➖ N/A
plugins List[models.GuardrailRulePlugin] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateGuardrailRuleResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

list_used_guardrails

Returns the distinct guardrail identifiers used by guardrail rules in the requested scope.

Example Usage

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)

Parameters

Parameter Type Required Description
project_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListGuardrailRuleUsedGuardrailsResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

retrieve

Retrieves a guardrail rule by its unique identifier.

Example Usage

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)

Parameters

Parameter Type Required Description
guardrail_rule_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetGuardrailRuleResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

delete

Permanently deletes a guardrail rule.

Example Usage

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)

Parameters

Parameter Type Required Description
guardrail_rule_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DeleteGuardrailRuleResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

update

Partially updates guardrail-rule metadata or configuration. Project scope is immutable.

Example Usage

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)

Parameters

Parameter Type Required Description
guardrail_rule_id str ✔️ N/A
display_name Optional[str] ➖ N/A
description Optional[str] ➖ N/A
enabled Optional[bool] ➖ N/A
expression Optional[models.GuardrailRuleExpression] ➖ N/A
guardrails List[models.GuardrailRuleGuardrail] ➖ N/A
plugins List[models.GuardrailRulePlugin] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UpdateGuardrailRuleResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*