Guardrails Client

The Guardrails client provides methods for managing guardrails in the Opik platform.

class opik.rest_api.guardrails.client.GuardrailsClient(*, client_wrapper: SyncClientWrapper)

Bases: object

create_guardrails(*, guardrails: Sequence[GuardrailWrite], request_options: RequestOptions | None = None) → None

Batch guardrails for traces

Parameters:

• guardrails (Sequence[GuardrailWrite])

• request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi from Opik import GuardrailWrite client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.guardrails.create_guardrails(guardrails=[GuardrailWrite(entity_id=’entity_id’, secondary_id=’secondary_id’, name=”TOPIC”, result=”passed”, config={‘key’: ‘value’ }, details={‘key’: ‘value’ }, )], )

Usage Example

import opik

client = opik.Opik()

# Validate content with guardrails
result = client.rest_client.guardrails.validate(
    checks=[
        {
            "name": "pii_check",
            "enabled": True
        },
        {
            "name": "toxicity_check",
            "enabled": True
        }
    ],
    input="This is the text to validate"
)