List guardrail validators and actions

curl --request GET \
  --url https://backend.trusys.ai/api/external/guardrails/validators \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://backend.trusys.ai/api/external/guardrails/validators', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.trusys.ai/api/external/guardrails/validators",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.trusys.ai/api/external/guardrails/validators"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://backend.trusys.ai/api/external/guardrails/validators")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "validators": [
      {
        "id": "pii",
        "name": "PII",
        "input": true,
        "output": true,
        "description": "Detects personally identifiable information"
      }
    ],
    "actions": [
      {
        "id": "mask",
        "name": "Mask",
        "description": "Trusys masks the unsafe portion."
      }
    ]
  }
}

{
  "message": "Error while verifying api key"
}

List guardrail validators and actions

Returns the static catalog of guardrail validator types and enforcement actions.

Use validators[].id as type and actions[].id as on_fail when building entries in PUT /applications/{applicationId}/guardrails. Each catalog validator includes an input / output flag indicating where it may be used.

For content-safety, validators[].config.categories lists the available safety categories (id, name, description). When configuring an application via PUT, set config.categories to an array of selected category id strings (for example ["violent-crimes", "hate"]). At least one category is required.

For pii, validators[].config.entities lists the available PII entity types (id, name, description, group). When configuring via PUT, set config.entities to an array of selected entity id strings (for example ["EMAIL_ADDRESS", "PHONE_NUMBER"]). At least one entity is required.

GET

guardrails

validators

List guardrail validators and actions

curl --request GET \
  --url https://backend.trusys.ai/api/external/guardrails/validators \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://backend.trusys.ai/api/external/guardrails/validators', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.trusys.ai/api/external/guardrails/validators",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.trusys.ai/api/external/guardrails/validators"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://backend.trusys.ai/api/external/guardrails/validators")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "validators": [
      {
        "id": "pii",
        "name": "PII",
        "input": true,
        "output": true,
        "description": "Detects personally identifiable information"
      }
    ],
    "actions": [
      {
        "id": "mask",
        "name": "Mask",
        "description": "Trusys masks the unsafe portion."
      }
    ]
  }
}

{
  "message": "Error while verifying api key"
}

Authorizations

x-api-key

string

header

required

Your Trusys API key. Create and manage keys in the Trusys UI under Settings → API Keys.

Include the key on every request:

x-api-key: <your-api-key>

Response

Validator and action catalog.

success

boolean

data

object

Show child attributes