Skip to main content

Official Python SDK for the ViriSIM AI Governance, Observability, Runtime Control, and Compliance API.

Project description

ViriSIM Python SDK

License Python

Official Python SDK for integrating the ViriSIM AI Governance, Observability, Runtime Control, and Compliance API into Python applications and AI agents.

Audit AI inputs and outputs for PII, regulatory violations, bias, hallucinations, safety risks, and policy violations before they reach users.


Features

  • AI Compliance Auditing
  • PII Detection
  • Regulatory Compliance Checks
  • Bias Detection
  • Hallucination Detection
  • Safety Risk Detection
  • Policy Enforcement
  • Real-Time Risk Scoring
  • Compliance Logging
  • Callback Support
  • Cryptographic Audit Evidence (SHA-256, ECDSA, RFC 3161)
  • Hash-Chained Session Integrity
  • Pre-Generation Guardrails
  • Safe Input/Output Redaction
  • Fine-Tuning Data Generation
  • DPO Documentation
  • Coverage of 330+ Global Regulations, Standards & Frameworks
  • Support for 83 Jurisdictions
  • Compatible with LangChain, CrewAI, OpenAI Agents SDK, AutoGen, and custom Python applications

Installation

pip install virisim

Quick Start

The example below shows a typical integration. Optional fields such as your_company_signature and your_company_signing_key_id can be provided for advanced integrations.

from virisim import VirisimClient

client = VirisimClient(api_key="sk-viri-YOUR-API-KEY")

result = client.audit(
    user_id="YOUR_USER_ID",
    company_name="RothsMind Corp",
    use_case="finance",
    your_company_user_id="user_123",
    your_company_user_session_id="session_456",
    model_version="gpt-5",
    agent_tool="LangChain",
    callback_url="https://your-domain.com/webhook",
    policy="Do not provide advice that facilitates tax evasion or other illegal activity.",
    input={
        "value": "Summarize the attached financial report.",
        "format": "text",
        "country": "canada"
    },
    output={
        "value": "The report shows a 14% increase in revenue.",
        "format": "text",
        "country": "canada"
    }
)

print(result)

Framework Integrations

LangChain

from virisim import VirisimClient
from langchain.tools import tool

client = VirisimClient(api_key="sk-viri-xxx")

@tool
def audit_ai_output(input_text: str, output_text: str, policy: str = None) -> dict:
    """Audit AI output for compliance before returning to user."""
    return client.audit(
        user_id="agent_001",
        company_name="Acme Inc.",
        use_case="general",
        your_company_user_id="agent_001",
        your_company_user_session_id="session_001",
        model_version="gpt-5",
        agent_tool="LangChain",
        callback_url="https://your-domain.com/webhook",
        policy=policy,
        input={"value": input_text, "format": "text", "country": "US"},
        output={"value": output_text, "format": "text", "country": "US"}
    )
    

CrewAI

from virisim import VirisimClient
from crewai.tools import tool

client = VirisimClient(api_key="sk-viri-xxx")

@tool
def audit_ai_output(input_text: str, output_text: str, policy: str = None) -> dict:
    """Audit AI output for compliance before returning to user."""
    return client.audit(
        user_id="agent_001",
        company_name="Acme Inc.",
        use_case="general",
        your_company_user_id="agent_001",
        your_company_user_session_id="session_001",
        model_version="gpt-5",
        agent_tool="CrewAI",
        callback_url="https://your-domain.com/webhook",
        policy=policy,
        input={"value": input_text, "format": "text", "country": "US"},
        output={"value": output_text, "format": "text", "country": "US"}
    )
    

OpenAI Agents SDK

from virisim import VirisimClient
from agents import function_tool

client = VirisimClient(api_key="sk-viri-xxx")

@function_tool
def audit_ai_output(input_text: str, output_text: str, policy: str = None) -> dict:
    """Audit AI output for compliance before returning to user."""
    return client.audit(
        user_id="agent_001",
        company_name="Acme Inc.",
        use_case="general",
        your_company_user_id="agent_001",
        your_company_user_session_id="session_001",
        model_version="gpt-5",
        agent_tool="OpenAI",
        callback_url="https://your-domain.com/webhook",
        policy=policy,
        input={"value": input_text, "format": "text", "country": "US"},
        output={"value": output_text, "format": "text", "country": "US"}
    )
    

Custom Python

from virisim import VirisimClient

client = VirisimClient(api_key="sk-viri-xxx")

result = client.audit(
    user_id="agent_001",
    company_name="Acme Inc.",
    use_case="general",
    your_company_user_id="agent_001",
    your_company_user_session_id="session_001",
    model_version="gpt-5",
    agent_tool="python-sdk",
    callback_url="https://your-domain.com/webhook",
    input={"value": input_text, "format": "text", "country": "US"},
    output={"value": output_text, "format": "text", "country": "US"}
)

if result.get("verdict") == "Review needed":
    return "Response blocked for compliance review."

Requirements

  • Python 3.9+

API Payload

Payload Fields

  • user_id

  • company_name

  • use_case

  • api_key

  • timestamp

  • your_company_user_id

  • your_company_user_session_id

  • model_version

  • your_company_signature (optional)

  • your_company_signing_key_id (optional)

  • agent_tool

  • callback_url

  • policy

  • input

    • value
    • format
    • country
  • output

    • value
    • format
    • country

The SDK automatically constructs the payload, authenticates requests, and communicates securely with the ViriSIM Compliance API, allowing developers to focus on building AI applications rather than managing API requests.


Documentation

ViriSIM Documentation


Support

support@virideed.com


License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

virisim-0.1.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

virisim-0.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file virisim-0.1.0.tar.gz.

File metadata

  • Download URL: virisim-0.1.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for virisim-0.1.0.tar.gz
Algorithm Hash digest
SHA256 95928de5d8c6e01e17dda125e0697361ebefba89577d6d53ff181d5150187ee6
MD5 99c151dfed0ba3505fa836cdf74d011e
BLAKE2b-256 c3288e50ab60a7c35580d634cc2a4aae6016135e5d1a175063c5c9e0a71f2752

See more details on using hashes here.

File details

Details for the file virisim-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: virisim-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for virisim-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c14a96c1ca133469e24dc42b859e0b5485d429dcc1f6d83308d90b343801cee
MD5 0c5c95dac9b206ea9614279a77017e33
BLAKE2b-256 9f99bb24968158949ca55139a02456c86947020c65b84487dab3247847d8dedc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page