Quickstart

Make your first evaluation request in under 5 minutes.

Install the SDK

PythonTypeScript
pip install veldrixai
npm install @veldrixai/sdk

Your first request

PythonTypeScript
import veldrixai

client = veldrixai.Client(api_key="vx_live_...")

result = client.evaluate(
    prompt="Summarize the patient's medical history.",
    response="The patient, John Smith (DOB 1985-03-12), has hypertension.",
    pillars=["compliance", "safety"],
)

print(result.trust_score)       # 0.34
print(result.action)            # "mask"
print(result.violations[0])     # PII detected: name, date-of-birth
import { VeldrixClient } from "@veldrixai/sdk";

const client = new VeldrixClient({ apiKey: "vx_live_..." });

const result = await client.evaluate({
  prompt: "Summarize the patient's medical history.",
  response: "The patient, John Smith (DOB 1985-03-12), has hypertension.",
  pillars: ["compliance", "safety"],
});

console.log(result.trustScore);      // 0.34
console.log(result.action);          // "mask"
console.log(result.violations[0]);   // PII detected: name, date-of-birth

Reading results

FieldTypeDescription
trust_scorefloat 0–1Aggregate trust score. Higher = safer.
actionstringEnforcement action taken (allow, block, mask, etc.)
violationslistList of detected policy violations with details.
pillar_scoresdictPer-pillar breakdown scores.
latency_msintTotal evaluation latency in milliseconds.
Was this page helpful?