Semantic Guardrails on

Prerequisites

Mon, 01 Jan 0001 00:00:00 +0000

Ensure that the following requirements are met before installing Semantic Guardrails with PPC.

The jumpbox is registered and prepared.
For more information about registering a jumpbox, refer to Configuring Authentication for Protegrity AI Team Edition.
PPC is installed and accessible.
For PII detection, Data Discovery service is installed.
Access to relevant images is available.

Installing Semantic Guardrails

Mon, 01 Jan 0001 00:00:00 +0000

This section describes the steps to install Semantic Guardrails.

1. Installing Data Discovery

For PII detection, it is recommended to install Data Discovery services before installing Semantic Guardrails.

For more information about installing Data Discovery service, refer to Installing Data Discovery.

To verify the Data Discovery service status, run the following command.

kubectl get pods -n data-discovery

2. Preparing and Installing

To install Semantic Guardrails, you must have access to the v1.1.1 helmchart.

Testing the Semantic Guardrails deployment

Mon, 01 Jan 0001 00:00:00 +0000

Perform the following steps to test the Semantic Guardrails deployment.

1. Testing Semantic Guardrails API

To test the Semantic Guardrails API endpoint, run the following command.

Note: The endpoints require authentication. For more information on creating a user with correct permissions and getting the JWT token, refer to PPC documentation.

GATEWAY_URL=$(kubectl get gateway pty-main -n api-gateway -o jsonpath='{.status.addresses[0].value}')
USERNAME="semantic_guardrails_user"
PASSWORD="Admin123!"
 
YOUR_JWT_TOKEN=$(curl -sk -X POST "${GATEWAY_URL}/api/v1/auth/login/token" \
 -H 'Content-Type: application/x-www-form-urlencoded' \
 -d "loginname=${USERNAME}&password=${PASSWORD}" \
 -D - -o /dev/null | grep -i 'pty_access_jwt_token' | awk '{print $2}' | tr -d '\r\n')

The sample response appears as follows.

Configuring Semantic Guardrails

Mon, 01 Jan 0001 00:00:00 +0000

This service provides AI conversation scanning and semantic analysis capabilities for Semantic Guardrails.

API Endpoints

This section provides an overview of the primary endpoints.

Name	Endpoint
Main API	`/pty/semantic-guardrail/v1.1/conversations/messages/`
Models API	`/pty/semantic-guardrail/v1.1/domain-models/`

Configuration Variables

The semantic-guardrail service can be configured by setting variables in the helm chart values.yaml, or overriding them with -f my.values.yaml.

Service variables

Key	Sub-Key	Description
`semanticGuardrailsAppConfig`	`environment.LOG_LEVEL`	Sets the application log level, default is `INFO`

Other variables

Semantic Guardrails Service Configuration

Uninstalling Semantic Guardrails

Mon, 01 Jan 0001 00:00:00 +0000

Perform the following steps to uninstall Semantic Guardrails.

Uninstalling Semantic-Guardrails

To uninstall semantic-guardrails, run the following command.

helm uninstall semantic-guardrails -n pty-semantic-guardrails

Uninstalling Data Discovery

If Data Discovery is not needed, then uninstall the Data Discovery service.

To uninstall data discovery, run the following command.

helm uninstall data-discovery -n data-discovery