@takeshape/schema 11.43.0 → 11.44.0

package/dist/esm/src/schemas/project-schema/experimental.json

@@ -21,6 +21,13 @@
         },
         "states": {
           "$ref": "#/definitions/agentStateMap"
+        },
+        "guards": {
+          "title": "AgentGuardList",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentGuard"
+          }
         }
       },
       "required": ["start", "states", "api"],
@@ -488,6 +495,17 @@
         }
       ]
     },
+    "agentGuard": {
+      "title": "AgentGuard",
+      "type": "object",
+      "properties": {
+        "guardId": {
+          "type": "string"
+        }
+      },
+      "required": ["guardId"],
+      "additionalProperties": false
+    },
     "agentToolConfig": {
       "title": "AgentToolConfig",
       "type": "object",
@@ -726,6 +744,10 @@
         "agents": {
           "$ref": "#/definitions/agentMap",
           "description": "An Agent is a configuration for an AI service such as a chat bot or a search engine."
+        },
+        "guards": {
+          "$ref": "#/definitions/guardMap",
+          "description": "A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance."
         }
       },
       "additionalProperties": false
@@ -757,6 +779,289 @@
       ],
       "additionalProperties": false
     },
+    "guard": {
+      "title": "GuardJSON",
+      "description": "A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "description": "The human-readable name of the Guard."
+        },
+        "description": {
+          "type": "string",
+          "title": "Description",
+          "description": "A description of the Guard."
+        },
+        "blockedInputMessaging": {
+          "type": "string",
+          "title": "Blocked Input Messaging",
+          "description": "A message to return when the input message is blocked by the Guard."
+        },
+        "blockedOutputsMessaging": {
+          "type": "string",
+          "title": "Blocked Outputs Messaging",
+          "description": "A message to return when the output message is blocked by the Guard."
+        },
+        "topicPolicyConfig": {
+          "type": "object",
+          "title": "Topic Policy",
+          "description": "Topics to identify and block.",
+          "properties": {
+            "topicsConfig": {
+              "type": "array",
+              "items": {
+                "title": "Topic",
+                "description": "A topic to block.",
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "definition": {
+                    "type": "string"
+                  },
+                  "examples": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "type": {
+                    "type": "string",
+                    "enum": ["DENY"]
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "contentPolicyConfig": {
+          "type": "object",
+          "title": "Content Policy",
+          "description": "Types of content to filter and strength configuration.",
+          "properties": {
+            "filtersConfig": {
+              "type": "array",
+              "items": {
+                "title": "Filter",
+                "description": "Types of content to filter.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": ["HATE", "INSULTS", "MICONDUCT", "PROMPT_ATTACK", "SEXUAL", "VIOLENCE"]
+                  },
+                  "inputStrength": {
+                    "$ref": "#/definitions/guardrailFilterStrength"
+                  },
+                  "outputStrength": {
+                    "$ref": "#/definitions/guardrailFilterStrength"
+                  },
+                  "inputModalities": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/definitions/guardrailModality"
+                    }
+                  },
+                  "outputModalities": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/definitions/guardrailModality"
+                    }
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "wordPolicyConfig": {
+          "type": "object",
+          "title": "Word Policy",
+          "description":
+            "Specific words to identify and block. The managedWordListsConfig is solely used for blocking profanity.",
+          "properties": {
+            "wordsConfig": {
+              "type": "array",
+              "items": {
+                "title": "Word List",
+                "description": "Specific words to block.",
+                "type": "object",
+                "properties": {
+                  "text": {
+                    "type": "string"
+                  }
+                },
+                "additionalProperties": false
+              }
+            },
+            "managedWordListsConfig": {
+              "type": "array",
+              "items": {
+                "title": "Managed Words",
+                "description": "Managed word list to block. This is solely used for blocking profanity.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": ["PROFANITY"]
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "sensitiveInformationPolicyConfig": {
+          "title": "Sensitive Information Policy",
+          "description":
+            "Filter out and block or obscure sensitive information. Matching text will be handled per the policy.",
+          "type": "object",
+          "properties": {
+            "piiEntitiesConfig": {
+              "type": "array",
+              "items": {
+                "title": "PII Entity",
+                "description": "PII entity to infer from the text.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "ADDRESS",
+                      "AGE",
+                      "AWS_ACCESS_KEY",
+                      "AWS_SECRET_KEY",
+                      "CA_HEALTH_NUMBER",
+                      "CA_SOCIAL_INSURANCE_NUMBER",
+                      "CREDIT_DEBIT_CARD_CVV",
+                      "CREDIT_DEBIT_CARD_EXPIRY",
+                      "CREDIT_DEBIT_CARD_NUMBER",
+                      "DRIVER_ID",
+                      "EMAIL",
+                      "INTERNATIONAL_BANK_ACCOUNT_NUMBER",
+                      "IP_ADDRESS",
+                      "LICENSE_PLATE",
+                      "MAC_ADDRESS",
+                      "NAME",
+                      "PASSWORD",
+                      "PHONE",
+                      "PIN",
+                      "SWIFT_CODE",
+                      "UK_NATIONAL_HEALTH_SERVICE_NUMBER",
+                      "UK_NATIONAL_INSURANCE_NUMBER",
+                      "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER",
+                      "URL",
+                      "USERNAME",
+                      "US_BANK_ACCOUNT_NUMBER",
+                      "US_BANK_ROUTING_NUMBER",
+                      "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER",
+                      "US_PASSPORT_NUMBER",
+                      "US_SOCIAL_SECURITY_NUMBER",
+                      "VEHICLE_IDENTIFICATION_NUMBER"
+                    ]
+                  },
+                  "action": {
+                    "$ref": "#/definitions/guardrailSensitiveInformationAction"
+                  }
+                },
+                "additionalProperties": false
+              }
+            },
+            "regexesConfig": {
+              "type": "array",
+              "items": {
+                "title": "Regular Expression",
+                "description": "A regular expression to match sensitive information.",
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "pattern": {
+                    "type": "string"
+                  },
+                  "action": {
+                    "$ref": "#/definitions/guardrailSensitiveInformationAction"
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "contextualGroundingPolicyConfig": {
+          "title": "Contextual Grounding Policy",
+          "description":
+            "Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.",
+          "type": "object",
+          "properties": {
+            "filtersConfig": {
+              "type": "array",
+              "items": {
+                "title": "Filter",
+                "description": "Filter to evaluate grounding text.",
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "title": "Type",
+                    "description": "The type of filter.",
+                    "type": "string",
+                    "enum": ["GROUNDING", "RELEVANCE"]
+                  },
+                  "threshold": {
+                    "title": "Threshold",
+                    "description": "The threshold for the filter as a floating point value between 0.0 - 1.0.",
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": ["name"],
+      "additionalProperties": false
+    },
+    "guardMap": {
+      "title": "GuardMap",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/guard"
+        }
+      },
+      "additionalProperties": false
+    },
+    "guardrailFilterStrength": {
+      "title": "Guardrail Filter Strength",
+      "type": "string",
+      "enum": ["NONE", "HIGH", "LOW", "MEDIUM"]
+    },
+    "guardrailModality": {
+      "title": "Guardrail Modality",
+      "type": "string",
+      "enum": ["TEXT", "IMAGE"]
+    },
+    "guardrailSensitiveInformationAction": {
+      "title": "Guardrail Sensitive Information Action",
+      "type": "string",
+      "enum": ["ANONYMIZE", "BLOCK"]
+    },
     "aiInspectAgentResolver": {
       "title": "AIInspectAgentResolver",
       "type": "object",

package/dist/esm/src/schemas/project-schema/latest.json

@@ -3717,4 +3717,4 @@
     "mutations",
     "workflows"
   ]
-}
+}

package/dist/esm/src/schemas/project-schema/v3.50.0.json

@@ -3717,4 +3717,4 @@
     "mutations",
     "workflows"
   ]
-}
+}

package/dist/esm/src/validate.js

@@ -487,8 +487,8 @@ function validateShapeLoaders(context, projectSchema, shape) {
             }
         }
     }
-    if (shape.cache?.triggers) {
-        const min = context.entitlements?.minScheduleTriggerInterval ?? DEFAULT_MIN_SCHEDULE_TRIGGER_INTERVAL;
+    if (shape.cache?.triggers && !context.ignoreEntitlements) {
+        const min = context.entitlements.minScheduleTriggerInterval ?? DEFAULT_MIN_SCHEDULE_TRIGGER_INTERVAL;
         for (let i = 0; i < shape.cache.triggers.length; i++) {
             const trigger = shape.cache.triggers[i];
             if (trigger.type === "schedule" && trigger.interval < min) {
@@ -786,14 +786,16 @@ function validateInterfaceImplementations(projectSchema) {
 function validateAgents(projectSchema) {
     const getNamespace = createGetNamespace(projectSchema);
     const errors = [];
+    const guards = projectSchema["ai-experimental"]?.guards;
     const agents = projectSchema["ai-experimental"]?.agents;
     if (!agents) {
         return errors;
     }
     for (const [agentName, agent] of Object.entries(agents)) {
         const stateNames = new Set();
+        const agentPath = ["ai-experimental", "agents", agentName];
         for (const [stateId, state] of Object.entries(agent.states)) {
-            const statePath = ["ai-experimental", "agents", agentName, "states", stateId];
+            const statePath = [...agentPath, "states", stateId];
             if (stateNames.has(state.name)) {
                 errors.push({
                     path: [...statePath, "name"],
@@ -819,6 +821,17 @@ function validateAgents(projectSchema) {
                 });
             }
         }
+        if (agent.guards) {
+            const invalidGuards = agent.guards.filter(({ guardId }) => !guards?.[guardId]);
+            if (invalidGuards.length) {
+                const guardPath = [...agentPath, "guards"];
+                errors.push(...invalidGuards.map(({ guardId }, index) => ({
+                    path: [...guardPath, index, "guardId"],
+                    type: "notFound",
+                    message: `Invalid guardId "${guardId}"`
+                })));
+            }
+        }
     }
     return errors;
 }
@@ -905,6 +918,22 @@ function validateStructure(schemaVersion, context, schema, ref) {
     }
     return { valid: true, schema: schema, errors: undefined };
 }
+function validateGuards(context, schema) {
+    const errors = [];
+    if (context.ignoreEntitlements) {
+        return errors;
+    }
+    const numOfGuards = schema["ai-experimental"]?.guards ? Object.keys(schema["ai-experimental"]?.guards).length : 0;
+    const entitledToGuards = context.entitlements.guards ?? 0;
+    if (numOfGuards > entitledToGuards) {
+        errors.push({
+            type: "entitlement",
+            message: `Number of guards exceeds your entitled limit of ${entitledToGuards}`,
+            path: ["ai-experimental", "guards"]
+        });
+    }
+    return errors;
+}
 function formatValidationResult(context, errors, schema) {
     const { suppressErrorPaths } = context;
     if (suppressErrorPaths) {
@@ -931,7 +960,8 @@ function validateSyntax(context, schema) {
         .concat(validateIndexedShapes(context, schema))
         .concat(validateInterfaces(schema))
         .concat(validateInterfaceImplementations(schema))
-        .concat(validateAgents(schema));
+        .concat(validateAgents(schema))
+        .concat(validateGuards(context, schema));
     return formatValidationResult(context, errors, schema);
 }
 async function validateReferences(context, schema) {

package/dist/types/src/project-schema/latest.d.ts

@@ -314,6 +314,34 @@ export type StopSequences1 = string[];
  *  The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results.
  */
 export type Seed1 = number;
+export type AgentGuardList = AgentGuard[];
+/**
+ * The human-readable name of the Guard.
+ */
+export type Name = string;
+/**
+ * A description of the Guard.
+ */
+export type Description = string;
+/**
+ * A message to return when the input message is blocked by the Guard.
+ */
+export type BlockedInputMessaging = string;
+/**
+ * A message to return when the output message is blocked by the Guard.
+ */
+export type BlockedOutputsMessaging = string;
+export type GuardrailFilterStrength = 'NONE' | 'HIGH' | 'LOW' | 'MEDIUM';
+export type GuardrailModality = 'TEXT' | 'IMAGE';
+export type GuardrailSensitiveInformationAction = 'ANONYMIZE' | 'BLOCK';
+/**
+ * The type of filter.
+ */
+export type Type = 'GROUNDING' | 'RELEVANCE';
+/**
+ * The threshold for the filter as a floating point value between 0.0 - 1.0.
+ */
+export type Threshold = number;
 /**
  * Human-readable id for use in the UI
  */
@@ -321,12 +349,12 @@ export type WorkflowName = string;
 /**
  * machine-readable slug
  */
-export type Name = string;
+export type Name1 = string;
 /**
  * Human-readable id for use in the UI
  */
 export type Title = string;
-export type Description = string;
+export type Description1 = string;
 /**
  * Hex color code
  */
@@ -1489,6 +1517,7 @@ export interface ShapeSchemaAny {
 }
 export interface AIExperimental {
     agents?: AgentMap;
+    guards?: GuardMap;
 }
 export interface AgentMap {
     [k: string]: AgentJSON;
@@ -1505,6 +1534,7 @@ export interface AgentJSON {
     api: AgentAPI;
     start: AgentStart;
     states: AgentStates;
+    guards?: AgentGuardList;
 }
 export interface AgentAPIChat {
     type: 'chat';
@@ -1686,6 +1716,115 @@ export interface AgentExecutionChat {
     guardrails?: AgentGuardrail[];
     options?: AgentGenerateOptions;
 }
+export interface AgentGuard {
+    guardId: string;
+}
+export interface GuardMap {
+    [k: string]: GuardJSON;
+}
+/**
+ * A Guard is a configuration for an AI guardrail that can check inputs and outputs and provide safety and compliance.
+ *
+ * This interface was referenced by `GuardMap`'s JSON-Schema definition
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
+ */
+export interface GuardJSON {
+    name: Name;
+    description?: Description;
+    blockedInputMessaging?: BlockedInputMessaging;
+    blockedOutputsMessaging?: BlockedOutputsMessaging;
+    topicPolicyConfig?: TopicPolicy;
+    contentPolicyConfig?: ContentPolicy;
+    wordPolicyConfig?: WordPolicy;
+    sensitiveInformationPolicyConfig?: SensitiveInformationPolicy;
+    contextualGroundingPolicyConfig?: ContextualGroundingPolicy;
+}
+/**
+ * Topics to identify and block.
+ */
+export interface TopicPolicy {
+    topicsConfig?: Topic[];
+}
+/**
+ * A topic to block.
+ */
+export interface Topic {
+    name?: string;
+    definition?: string;
+    examples?: string[];
+    type?: 'DENY';
+}
+/**
+ * Types of content to filter and strength configuration.
+ */
+export interface ContentPolicy {
+    filtersConfig?: Filter[];
+}
+/**
+ * Types of content to filter.
+ */
+export interface Filter {
+    type?: 'HATE' | 'INSULTS' | 'MICONDUCT' | 'PROMPT_ATTACK' | 'SEXUAL' | 'VIOLENCE';
+    inputStrength?: GuardrailFilterStrength;
+    outputStrength?: GuardrailFilterStrength;
+    inputModalities?: GuardrailModality[];
+    outputModalities?: GuardrailModality[];
+}
+/**
+ * Specific words to identify and block. The managedWordListsConfig is solely used for blocking profanity.
+ */
+export interface WordPolicy {
+    wordsConfig?: WordList[];
+    managedWordListsConfig?: ManagedWords[];
+}
+/**
+ * Specific words to block.
+ */
+export interface WordList {
+    text?: string;
+}
+/**
+ * Managed word list to block. This is solely used for blocking profanity.
+ */
+export interface ManagedWords {
+    type?: 'PROFANITY';
+}
+/**
+ * Filter out and block or obscure sensitive information. Matching text will be handled per the policy.
+ */
+export interface SensitiveInformationPolicy {
+    piiEntitiesConfig?: PIIEntity[];
+    regexesConfig?: RegularExpression[];
+}
+/**
+ * PII entity to infer from the text.
+ */
+export interface PIIEntity {
+    type?: 'ADDRESS' | 'AGE' | 'AWS_ACCESS_KEY' | 'AWS_SECRET_KEY' | 'CA_HEALTH_NUMBER' | 'CA_SOCIAL_INSURANCE_NUMBER' | 'CREDIT_DEBIT_CARD_CVV' | 'CREDIT_DEBIT_CARD_EXPIRY' | 'CREDIT_DEBIT_CARD_NUMBER' | 'DRIVER_ID' | 'EMAIL' | 'INTERNATIONAL_BANK_ACCOUNT_NUMBER' | 'IP_ADDRESS' | 'LICENSE_PLATE' | 'MAC_ADDRESS' | 'NAME' | 'PASSWORD' | 'PHONE' | 'PIN' | 'SWIFT_CODE' | 'UK_NATIONAL_HEALTH_SERVICE_NUMBER' | 'UK_NATIONAL_INSURANCE_NUMBER' | 'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER' | 'URL' | 'USERNAME' | 'US_BANK_ACCOUNT_NUMBER' | 'US_BANK_ROUTING_NUMBER' | 'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER' | 'US_PASSPORT_NUMBER' | 'US_SOCIAL_SECURITY_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER';
+    action?: GuardrailSensitiveInformationAction;
+}
+/**
+ * A regular expression to match sensitive information.
+ */
+export interface RegularExpression {
+    name?: string;
+    description?: string;
+    pattern?: string;
+    action?: GuardrailSensitiveInformationAction;
+}
+/**
+ * Provides evaluations based on grounding text supplied by your in-context agent variables. Off-topic conversations can then be blocked.
+ */
+export interface ContextualGroundingPolicy {
+    filtersConfig?: Filter1[];
+}
+/**
+ * Filter to evaluate grounding text.
+ */
+export interface Filter1 {
+    type?: Type;
+    threshold?: Threshold;
+}
 /**
  * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
  * via the `definition` "formMap".
@@ -1745,9 +1884,9 @@ export interface Workflow {
  * via the `definition` "workflowStep".
  */
 export interface WorkflowStep {
-    name: Name;
+    name: Name1;
     title: Title;
-    description?: Description;
+    description?: Description1;
     color: Color;
     live: Live;
     key: Key;