feat: Update Trend Micro Vision One AI Guard official endpoint

Author: trend-anurag-das

docs/user-guides/community/trend-micro.md

@@ -20,8 +20,13 @@ Trend Micro Vision One [AI Application Security's](https://docs.trendmicro.com/e
 rails:
   config:
     trend_micro:
-      v1_url: "https://api.xdr.trendmicro.com/beta/aiSecurity/guard" # Replace this with your AI Guard URL
+      v1_url: "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails"  # Trend Micro AI Guard Endpoint
       api_key_env_var: "V1_API_KEY"
+      application_name: "my-ai-app"  # Required: Application identifier (max 64 chars, alphanumeric, hyphens, underscores)
+      # Optional:
+      detailed_response: true  # Set to true for detailed AI Guard results
+      # For other regions, use: https://api.{region}.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # where region is: eu, jp, au, in, sg, or mea
   input:
     flows:
       - trend ai guard input
@@ -37,8 +42,13 @@ colang_version: "2.x"
 rails:
   config:
     trend_micro:
-      v1_url: "https://api.xdr.trendmicro.com/beta/aiSecurity/guard" # Replace this with your AI Guard URL
+      v1_url: "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails"  # Trend Micro AI Guard Endpoint
       api_key_env_var: "V1_API_KEY"
+      application_name: "my-ai-app"  # Required: Application identifier (max 64 chars, alphanumeric, hyphens, underscores)
+      # Optional:
+      detailed_response: true  # Set to true for detailed AI results
+      # For other regions, use: https://api.{region}.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # where region is: eu, jp, au, in, sg, or mea
 ```
 ```
 # rails.co

examples/configs/trend_micro/config.yml

@@ -13,7 +13,26 @@ instructions:
 rails:
   config:
     trend_micro:
+      v1_url: "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails"
+
+      # Trend Micro Vision One API key environment variable
       api_key_env_var: "V1_API_KEY"
+
+      # Application name
+      # Must be alphanumeric with hyphens/underscores, max 64 characters
+      application_name: "nemo-guardrails-demo"
+
+      # Optional: Set to true for detailed AI Guard results with confidence scores
+      detailed_response: false
+
+      # For other regions, update v1_url to:
+      # EU: https://api.eu.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # JP: https://api.jp.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # AU: https://api.au.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # IN: https://api.in.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # SG: https://api.sg.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+      # MEA: https://api.mea.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails
+
   input:
     flows:
       - trend ai guard input

examples/configs/trend_micro_v2/config.yaml

@@ -5,8 +5,17 @@ enable_rails_exceptions: True
 rails:
   config:
     trend_micro:
+      v1_url: "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails"
+
+      # Trend Micro Vision One API key environment variable
       api_key_env_var: "V1_API_KEY"
 
+      # Application name
+      application_name: "nemo-guardrails-demo-v2"
+
+      # Optional: Set to true for detailed AI Guard results
+      detailed_response: false
+
 models:
   - type: main
     engine: openai

nemoguardrails/library/trend_micro/actions.py

@@ -33,10 +33,10 @@ class Guard(BaseModel):
     Represents a guard entity with a single string attribute.
 
     Attributes:
-        guard (str): The input text for guard analysis.
+        prompt (str): The input text for AI guard analysis.
     """
 
-    guard: str
+    prompt: str
 
 
 class GuardResult(BaseModel):
@@ -93,7 +93,7 @@ def trend_ai_guard_mapping(result: GuardResult) -> bool:
 @action(is_system_action=True, output_mapping=trend_ai_guard_mapping)
 async def trend_ai_guard(config: RailsConfig, text: Optional[str] = None):
     """
-    Custom action to invoke the Trend Ai Guard
+    Custom action to invoke the Trend Micro AI Guard API.
     """
 
     trend_config = get_config(config)
@@ -109,16 +109,28 @@ async def trend_ai_guard(config: RailsConfig, text: Optional[str] = None):
             reason="Trend Micro Vision One API Key not found",
         )
 
+    app_name = trend_config.application_name
+
     async with httpx.AsyncClient() as client:
-        data = Guard(guard=text).model_dump()
+        data = Guard(prompt=text).model_dump()
+
+        # Build headers with required TMV1-Application-Name
+        headers = {
+            "Authorization": f"Bearer {v1_api_key}",
+            "Content-Type": "application/json",
+            "TMV1-Application-Name": app_name,
+        }
+
+        # Add Prefer header for detail level control
+        if trend_config.detailed_response:
+            headers["Prefer"] = "return=representation"
+        else:
+            headers["Prefer"] = "return=minimal"
 
         response = await client.post(
             v1_url,
             content=to_json(data),
-            headers={
-                "Authorization": f"Bearer {v1_api_key}",
-                "Content-Type": "application/json",
-            },
+            headers=headers,
         )
 
         try:

nemoguardrails/rails/llm/config.py

@@ -848,15 +848,26 @@ class TrendMicroRailConfig(BaseModel):
     """Configuration data for the Trend Micro AI Guard API"""
 
     v1_url: Optional[str] = Field(
-        default="https://api.xdr.trendmicro.com/beta/aiSecurity/guard",
-        description="The endpoint for the Trend Micro AI Guard API",
+        default="https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails",
+        description="The endpoint for the Trend Micro AI Guard API. For other regions, use: https://api.{region}.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails where region is eu, jp, au, in, sg, or mea.",
     )
 
     api_key_env_var: Optional[str] = Field(
         default=None,
         description="Environment variable containing API key for Trend Micro AI Guard",
     )
 
+    application_name: str = Field(
+        default="nemo-guardrails",
+        description="Application name for TMV1-Application-Name header (REQUIRED). Must contain only letters, numbers, hyphens, and underscores, with a maximum length of 64 characters.",
+        max_length=64,
+    )
+
+    detailed_response: Optional[bool] = Field(
+        default=False,
+        description="If True, returns detailed AI Guard results with confidence scores (Prefer: return=representation). If False, returns minimal response with only action and reasons (Prefer: return=minimal).",
+    )
+
     def get_api_key(self) -> Optional[str]:
         """Helper to return an API key (if it exists) from a Trend Micro configuration.
         The `api_key_env_var` field, a string stored in this environment variable.

tests/test_trend_ai_guard.py

@@ -25,8 +25,9 @@
         rails:
           config:
             trend_micro:
-              v1_url: "https://api.xdr.trendmicro.com/beta/aiSecurity/guard"
+              v1_url: "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails"
               api_key_env_var: "V1_API_KEY"
+              application_name: "test-app"
           input:
             flows:
               - trend ai guard input
@@ -38,8 +39,9 @@
         rails:
           config:
             trend_micro:
-              v1_url: "https://api.xdr.trendmicro.com/beta/aiSecurity/guard"
+              v1_url: "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails"
               api_key_env_var: "V1_API_KEY"
+              application_name: "test-app"
           output:
             flows:
               - trend ai guard output