Using the API

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

The GenAI Security - Semantic Guardrail 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 /docs endpoint.

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

Endpoint

/pty/semantic-guardrail/v1.0/conversation/messages/scan

Method

POST

Parameters

The API endpoint accepts the following fields:

Tutorial

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

Quick Start

This tutorial assumes that Protegrity Data Discovery is installed in the same network environment. If it is not installed, messages can still be sent from: user to the semantic processor.

The following is a simple Python request example:

import requests

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

response = requests.post(
 "http://localhost:8001/pty/semantic-guardrail/v1.0/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.