Using the API

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

Following the default installation instructions, the Semantic Guardrails service exposes its API on port 8001.

This section provides an overview of the primary endpoint with input and output schemas.

The complete API documentation is available through the integrated OpenAPI specification at the /swagger endpoint.

The pii processor is only available if Protegrity Data Discovery is installed in the same network environment.

For more information about APIs, refer to Protegrity REST APIs.

Tutorial

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

Available Models

As of v1.1.0, Semantic Guardrails product can:

Semantically analyze user messages in your application domains for customer-support, financial and healthcare.
Scan ai messages for PII using Protegrity Data Discovery if installed in the same network environment.

Quick Start

The following is a simple Python request example:

import requests

data = {
 "messages": [
 {
 "from": "user",
 "to": "ai",
 "content": "Hello, what's your name?",
 "processors": ["customer-support"],
 },
 {
 "from": "ai",
 "to": "user",
 "content": "My name is AI!",
 "processors": ["pii"],
 },
 ]
}

response = requests.post(
 "http://localhost:8001/pty/semantic-guardrail/v1.1/conversations/messages/scan",
 json=data,
)

print(response.status_code)
print(response.json())

Implementation

The recommended integration pattern evaluates a conversation each time it is updated with new messages. This applies to messages from either users or AI systems. The solution analyzes the full conversation for enhanced effectiveness. Identical input requests are cached internally for optimized performance.

Working with Semantic Guardrails on

Using the API

Tutorial

Available Models

Quick Start

Implementation