@takeshape/schema 12.1.1 → 12.1.5

package/dist/schemas/project-schema/experimental-2025-07.json

@@ -0,0 +1,1297 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://schema.takeshape.io/project-schema/experimental-2025-07#",
+  "definitions": {
+    "agent": {
+      "title": "Agent JSON",
+      "description": "An Agent is a configuration for an AI service such as a chat bot or a search engine.",
+      "type": "object",
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "systemPrompt": {
+          "type": "string"
+        },
+        "api": {
+          "$ref": "#/definitions/agentApi"
+        },
+        "memory": {
+          "$ref": "#/definitions/agentMemory"
+        },
+        "start": {
+          "$ref": "#/definitions/agentStart"
+        },
+        "states": {
+          "$ref": "#/definitions/agentStateMap"
+        },
+        "guards": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentGuard"
+          }
+        },
+        "historyStrategies": {
+          "$ref": "#/definitions/historyStrategyMap"
+        }
+      },
+      "required": ["start", "states", "api"],
+      "additionalProperties": false
+    },
+    "historyStrategyMap": {
+      "title": "History Strategy Map",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/historyStrategy"
+        }
+      },
+      "additionalProperties": false
+    },
+    "historyStrategy": {
+      "title": "History Strategy",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "variables": {
+          "title": "Variables",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentVariable"
+          }
+        },
+        "filter": {
+          "$ref": "#/definitions/historyStrategyFilter"
+        },
+        "transform": {
+          "$ref": "#/definitions/historyStrategyTransform"
+        }
+      },
+      "required": ["name", "transform"],
+      "additionalProperties": false
+    },
+    "historyStrategyFilter": {
+      "title": "History Strategy Filter",
+      "type": "object",
+      "properties": {
+        "toolCalls": {
+          "enum": ["retain", "clear"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "historyStrategyTransform": {
+      "title": "History Strategy Transform",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/historyStrategyTransformNone"
+        },
+        {
+          "$ref": "#/definitions/historyStrategyTransformReplace"
+        },
+        {
+          "$ref": "#/definitions/historyStrategyTransformSummarize"
+        }
+      ]
+    },
+    "historyStrategyTransformNone": {
+      "title": "History Strategy Transform None",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["none"]
+        }
+      },
+      "required": ["type"],
+      "additionalProperties": false
+    },
+    "historyStrategyTransformReplace": {
+      "title": "History Strategy Transform Replace",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["replace"]
+        },
+        "template": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "template"],
+      "additionalProperties": false
+    },
+    "historyStrategyTransformSummarize": {
+      "title": "History Strategy Transform Summarize",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["generate"]
+        },
+        "service": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "systemPrompt": {
+          "type": "string"
+        },
+        "tools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentToolConfig"
+          }
+        },
+        "options": {
+          "$ref": "#/definitions/agentGenerateOptions"
+        }
+      },
+      "required": ["type", "service", "model", "systemPrompt"],
+      "additionalProperties": false
+    },
+    "tool": {
+      "title": "Tool JSON",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "ref": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "args": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/toolArg"
+          }
+        },
+        "selectionSet": {
+          "type": "string"
+        }
+      },
+      "required": ["name", "ref"],
+      "additionalProperties": false
+    },
+    "toolArg": {
+      "title": "Tool Arg",
+      "type": "object",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentToolConfigArgAgent"
+        }
+      ]
+    },
+    "agentApi": {
+      "title": "Agent API",
+      "type": "object",
+      "properties": {
+        "inputs": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentApiInput"
+          }
+        }
+      },
+      "required": ["inputs"],
+      "additionalProperties": false
+    },
+    "agentMemory": {
+      "title": "Agent Memory",
+      "type": "object",
+      "properties": {
+        "sessionMemory": {
+          "$ref": "#/definitions/agentSessionMemory"
+        }
+      },
+      "required": ["sessionMemory"],
+      "additionalProperties": false
+    },
+    "agentSessionMemory": {
+      "title": "Agent Session Memory",
+      "type": "object",
+      "properties": {
+        "shape": {
+          "type": "string"
+        }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
+    "agentVariable": {
+      "title": "Agent Variable",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "steps": {
+          "description": "These are evaluated in order until a value is found.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentVariableStep"
+          }
+        }
+      },
+      "required": ["name", "steps"],
+      "additionalProperties": false
+    },
+    "agentVariableStep": {
+      "title": "Agent Variable Step",
+      "type": "object",
+      "properties": {
+        "condition": {
+          "type": "string"
+        },
+        "expression": {
+          "type": "string"
+        }
+      },
+      "required": ["expression"],
+      "additionalProperties": false
+    },
+    "agentStart": {
+      "title": "Agent Start",
+      "description": "Configuration for the start of an agent's execution",
+      "type": "object",
+      "properties": {
+        "transitions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentTransitionSuspend"
+          }
+        }
+      },
+      "required": ["transitions"],
+      "additionalProperties": false
+    },
+    "agentStateMap": {
+      "title": "Agent States",
+      "description": "States that are traversed during the execution of an agent.",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/agentState"
+        }
+      },
+      "additionalProperties": false
+    },
+    "agentState": {
+      "title": "Agent State",
+      "description": "One step of an agent's execution.",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-zA-Z][0-9A-Za-z_]*$"
+        },
+        "variables": {
+          "title": "Variables",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentVariable"
+          }
+        },
+        "execution": {
+          "$ref": "#/definitions/agentExecution"
+        },
+        "transitions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentTransition"
+          }
+        }
+      },
+      "required": ["name", "execution"],
+      "additionalProperties": false
+    },
+    "agentExecution": {
+      "title": "Agent Execution",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentExecutionGraphql"
+        },
+        {
+          "$ref": "#/definitions/agentExecutionGenerate"
+        },
+        {
+          "$ref": "#/definitions/agentExecutionChat"
+        }
+      ]
+    },
+    "agentApiInput": {
+      "title": "Agent API Input",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentApiMutationInput"
+        }
+      ]
+    },
+    "agentApiMutationInput": {
+      "title": "Agent API Mutation Input",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["mutation"]
+        },
+        "name": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "args": {
+          "type": "string"
+        },
+        "interactionTimeout": {
+          "title": "Interaction Timeout (milliseconds)",
+          "type": "integer"
+        }
+      },
+      "required": ["type", "name", "args"],
+      "additionalProperties": false
+    },
+    "agentExecutionGraphql": {
+      "title": "Agent Execution GraphQL",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["graphql"]
+        },
+        "query": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "query"],
+      "additionalProperties": false
+    },
+    "agentStateSessionMemoryAssignment": {
+      "title": "Agent State Session Memory Assignment",
+      "type": "object",
+      "properties": {
+        "memoryPath": {
+          "type": "string"
+        },
+        "expression": {
+          "type": "string"
+        }
+      },
+      "required": ["expression"],
+      "additionalProperties": false
+    },
+    "agentAiStateInputArg": {
+      "title": "Agent AI State Input Argument",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["arg"]
+        }
+      },
+      "required": ["type"],
+      "additionalProperties": false
+    },
+    "agentAiStateInputTemplate": {
+      "title": "Agent AI State Input Template",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["template"]
+        },
+        "inputTemplate": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "inputTemplate"],
+      "additionalProperties": false
+    },
+    "agentAiStateInput": {
+      "title": "Agent AI State Input",
+      "type": "object",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentAiStateInputArg"
+        },
+        {
+          "$ref": "#/definitions/agentAiStateInputTemplate"
+        }
+      ]
+    },
+    "agentGenerateOptions": {
+      "title": "AgentGenerateOptions",
+      "type": "object",
+      "properties": {
+        "history": {
+          "title": "history",
+          "type": "boolean"
+        },
+        "maxTokens": {
+          "type": "integer",
+          "title": "Maximum Tokens",
+          "description": "Maximum number of tokens to generate. Defaults to 1024"
+        },
+        "temperature": {
+          "type": "number",
+          "title": "Temperature",
+          "description": "This is a number between 0 (almost no randomness) and 1 (very random). It is recommended to set either `temperature` or `topP`, but not both. Defaults to 0",
+          "minimum": 0,
+          "maximum": 1
+        },
+        "topP": {
+          "type": "number",
+          "title": "Top P",
+          "description": "Nucleus sampling. This is a number between 0 and 1. E.g. 0.1 would mean that only tokens with the top 10% probability mass are considered. It is recommended to set either `temperature` or `topP`, but not both.",
+          "minimum": 0,
+          "maximum": 1
+        },
+        "topK": {
+          "type": "number",
+          "title": "Top K",
+          "description": "Only sample from the top K options for each subsequent token. Used to remove \"long tail\" low probability responses. Recommended for advanced use cases only. You usually only need to use temperature."
+        },
+        "presencePenalty": {
+          "type": "number",
+          "title": "Presence penalty setting",
+          "description": "It affects the likelihood of the model to repeat information that is already in the prompt. The presence penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.",
+          "minimum": -1,
+          "maximum": 1
+        },
+        "frequencyPenalty": {
+          "type": "number",
+          "title": "Frequency penalty setting",
+          "description": "It affects the likelihood of the model  to repeatedly use the same words or phrases. The frequency penalty is a number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition). 0 means no penalty.",
+          "minimum": -1,
+          "maximum": 1
+        },
+        "stopSequences": {
+          "title": "Stop sequences",
+          "description": "If set, the model will stop generating text when one of the stop sequences is generated.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "seed": {
+          "type": "integer",
+          "title": "Seed",
+          "description": " The seed (integer) to use for random sampling. If set and supported by the model, calls will generate deterministic results."
+        },
+        "maxRetries": {
+          "type": "integer",
+          "description": "Maximum number of retries. Set to 0 to disable retries. Defaults to 2"
+        },
+        "toolChoice": {
+          "type": "string",
+          "description": "The tool choice strategy. Default: 'auto'",
+          "anyOf": [
+            {
+              "enum": ["auto", "none", "required"]
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "maxToolRoundtrips": {
+          "type": "integer",
+          "title": "Max Tool Roundtrips",
+          "description": "Maximal number of automatic roundtrips for tool calls."
+        },
+        "structuredOutputs": {
+          "type": "boolean",
+          "title": "Structured Outputs",
+          "description": "If true, structured outputs will be enabled on the model for non-text requests."
+        },
+        "enableOpenAIFormat": {
+          "type": "boolean",
+          "title": "Enable OpenAI Schema Format",
+          "description": "Enable OpenAI schema format. Must be enabled if `structuredOutputs` is enabled."
+        },
+        "removePropertyKeyPatterns": {
+          "$ref": "#/definitions/removePropertyKeyPatterns"
+        },
+        "stripMarkdown": {
+          "type": "boolean",
+          "title": "Strip Markdown",
+          "description": "Remove Markdown formatting from the LLM response"
+        }
+      },
+      "additionalProperties": false
+    },
+    "agentGuard": {
+      "title": "Agent Guard",
+      "type": "object",
+      "properties": {
+        "guardId": {
+          "title": "Guard ID",
+          "type": "string"
+        }
+      },
+      "required": ["guardId"],
+      "additionalProperties": false
+    },
+    "agentToolConfig": {
+      "title": "AgentToolConfig",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "ref": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "args": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentToolConfigArg"
+          }
+        },
+        "selectionSet": {
+          "type": "string"
+        }
+      },
+      "required": ["name", "ref"],
+      "additionalProperties": false
+    },
+    "agentToolConfigArg": {
+      "title": "Agent Tool Config Arg",
+      "type": "object",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentToolConfigArgAgent"
+        },
+        {
+          "$ref": "#/definitions/agentToolConfigArgVariable"
+        }
+      ]
+    },
+    "agentToolConfigArgAgent": {
+      "title": "Agent-Controlled",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["agent"]
+        },
+        "argName": {
+          "title": "Tool Argument Name",
+          "type": "string",
+          "description": "The argument name that will be exposed by the tool for the LLM to use."
+        }
+      },
+      "required": ["type", "argName"],
+      "additionalProperties": false
+    },
+    "agentToolConfigArgVariable": {
+      "title": "Variable Value",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["variable"]
+        },
+        "argName": {
+          "title": "Tool Argument Name",
+          "type": "string",
+          "description": "Name of argument to pass value to. This prevents the LLM from setting the argument."
+        },
+        "variableName": {
+          "title": "State Variable Name",
+          "type": "string",
+          "description": "Name of variable to pull value from."
+        }
+      },
+      "required": ["type", "argName", "variableName"],
+      "additionalProperties": false
+    },
+    "agentExecutionGenerate": {
+      "title": "Agent Execution Generate",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["generate"]
+        },
+        "service": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "systemPrompt": {
+          "type": "string"
+        },
+        "input": {
+          "$ref": "#/definitions/agentAiStateInput"
+        },
+        "outputShape": {
+          "type": "string"
+        },
+        "tools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentToolConfig"
+          }
+        },
+        "options": {
+          "$ref": "#/definitions/agentGenerateOptions"
+        }
+      },
+      "required": ["type", "service", "model", "input"],
+      "additionalProperties": false
+    },
+    "agentExecutionChat": {
+      "title": "Agent Execution Chat",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["chat"]
+        },
+        "service": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "systemPrompt": {
+          "type": "string"
+        },
+        "input": {
+          "$ref": "#/definitions/agentAiStateInput"
+        },
+        "artifact": {
+          "type": "string"
+        },
+        "tools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentToolConfig"
+          }
+        },
+        "options": {
+          "$ref": "#/definitions/agentGenerateOptions"
+        }
+      },
+      "required": ["type", "service", "model", "input"],
+      "additionalProperties": false
+    },
+    "agentTransition": {
+      "title": "Agent Transition",
+      "description": "These steps are evaluated in order until a destination is found.",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentTransitionImmediate"
+        },
+        {
+          "$ref": "#/definitions/agentTransitionSuspend"
+        }
+      ]
+    },
+    "agentTransitionSuspend": {
+      "title": "Agent Transition Suspend",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["suspend"]
+        },
+        "destination": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "input": {
+          "type": "string"
+        },
+        "condition": {
+          "type": "string"
+        },
+        "limit": {
+          "type": "integer"
+        },
+        "sessionMemory": {
+          "title": "Agent State Session Memory",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentStateSessionMemoryAssignment"
+          }
+        },
+        "historyStrategy": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["type", "destination", "input"]
+    },
+    "agentTransitionImmediate": {
+      "title": "Agent Transition Immediate",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["immediate"]
+        },
+        "destination": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "condition": {
+          "type": "string"
+        },
+        "limit": {
+          "type": "integer"
+        },
+        "sessionMemory": {
+          "title": "Agent State Session Memory",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentStateSessionMemoryAssignment"
+          }
+        },
+        "historyStrategy": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["type", "destination"]
+    },
+    "agentMap": {
+      "title": "Agent Map",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/agent"
+        }
+      },
+      "additionalProperties": false
+    },
+    "toolMap": {
+      "title": "Tool Map",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/tool"
+        }
+      },
+      "additionalProperties": false
+    },
+    "mcpConfig": {
+      "title": "MCP Server Configuration",
+      "type": "object",
+      "properties": {
+        "tools": {
+          "$ref": "#/definitions/toolMap",
+          "description": "A Tool is a configuration for an AI tool which can query or mutate data."
+        }
+      },
+      "additionalProperties": false
+    },
+    "aiExperimental": {
+      "title": "AI Experimental",
+      "type": "object",
+      "properties": {
+        "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."
+        },
+        "mcp": {
+          "$ref": "#/definitions/mcpConfig",
+          "description": "MCP server configuration"
+        }
+      },
+      "additionalProperties": false
+    },
+    "aiRunAgentResolver": {
+      "title": "AISendAgentMessageResolver",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:sendAgentMessage"]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "inputName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": ["name", "agentName", "inputName"],
+      "additionalProperties": false
+    },
+    "aiGetAgentMessageResolver": {
+      "title": "AIGetAgentMessageResolver",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:getAgentMessage"]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": ["name", "agentName"],
+      "additionalProperties": false
+    },
+    "aiAbortAgentMessageResolver": {
+      "title": "AIAbortAgentMessageResolver",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:abortAgentMessage"]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": ["name", "agentName"],
+      "additionalProperties": false
+    },
+    "aiSendAgentFeedbackResolver": {
+      "title": "AISendAgentFeedbackResolver",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:sendAgentFeedback"]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": ["name", "agentName"],
+      "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."
+        },
+        "enabled": {
+          "type": "boolean",
+          "title": "Enabled",
+          "description": "Guards will not run unless enabled.",
+          "default": true
+        },
+        "guardrailIdentifier": {
+          "type": "string",
+          "title": "Guardrail Identifier",
+          "description": "The remote id of the Guardrail."
+        },
+        "guardrailVersion": {
+          "type": "string",
+          "title": "Guardrail Version",
+          "description": "The remote version of the Guardrail."
+        },
+        "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": {
+              "title": "Topic",
+              "description": "A topic to block.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "definition": {
+                    "type": "string"
+                  },
+                  "examples": {
+                    "description": "Examples of the topic that can hint the LLM.",
+                    "type": "array",
+                    "items": {
+                      "title": "Example",
+                      "type": "string"
+                    },
+                    "minItems": 1
+                  },
+                  "type": {
+                    "type": "string",
+                    "enum": ["DENY"]
+                  }
+                },
+                "required": ["name", "definition", "type"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            }
+          },
+          "required": ["topicsConfig"],
+          "additionalProperties": false
+        },
+        "contentPolicyConfig": {
+          "type": "object",
+          "title": "Content Policy",
+          "description": "Types of content to filter and strength configuration.",
+          "properties": {
+            "filtersConfig": {
+              "title": "Filter",
+              "description": "Types of content to filter.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": ["HATE", "INSULTS", "MICONDUCT", "PROMPT_ATTACK", "SEXUAL", "VIOLENCE"]
+                  },
+                  "inputStrength": {
+                    "title": "Input Strength",
+                    "type": "string",
+                    "enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
+                  },
+                  "outputStrength": {
+                    "title": "Output Strength",
+                    "type": "string",
+                    "enum": ["NONE", "LOW", "MEDIUM", "HIGH"]
+                  },
+                  "inputModalities": {
+                    "title": "Input Modalities",
+                    "description": "Whether to filter images or text",
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/definitions/guardrailModality"
+                    },
+                    "minItems": 1
+                  },
+                  "outputModalities": {
+                    "title": "Output Modalities",
+                    "description": "Whether to filter images or text",
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/definitions/guardrailModality"
+                    },
+                    "minItems": 1
+                  }
+                },
+                "required": ["type", "inputStrength", "outputStrength"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            }
+          },
+          "required": ["filtersConfig"],
+          "additionalProperties": false
+        },
+        "wordPolicyConfig": {
+          "type": "object",
+          "title": "Word Policy",
+          "description": "Specific words to identify and block.",
+          "properties": {
+            "wordsConfig": {
+              "title": "Word List",
+              "description": "Specific words to block.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "text": {
+                    "type": "string"
+                  }
+                },
+                "required": ["text"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            },
+            "managedWordListsConfig": {
+              "title": "Managed Word List",
+              "description": "This is solely used for blocking profanity.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": ["PROFANITY"]
+                  }
+                },
+                "required": ["type"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            }
+          },
+          "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": {
+              "title": "PII Entity",
+              "description": "PII entity to infer from the text.",
+              "type": "array",
+              "items": {
+                "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"
+                  }
+                },
+                "required": ["type", "action"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            },
+            "regexesConfig": {
+              "title": "Regular Expression",
+              "description": "A regular expression to match sensitive information.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "pattern": {
+                    "type": "string"
+                  },
+                  "action": {
+                    "$ref": "#/definitions/guardrailSensitiveInformationAction"
+                  }
+                },
+                "required": ["name", "pattern", "action"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            }
+          },
+          "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": {
+              "title": "Filter",
+              "description": "Filter to evaluate grounding text.",
+              "type": "array",
+              "items": {
+                "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 greater than 0.0 and less than 1.0.",
+                    "type": "number",
+                    "multipleOf": 0.01,
+                    "exclusiveMinimum": 0,
+                    "exclusiveMaximum": 1
+                  }
+                },
+                "required": ["type", "threshold"],
+                "additionalProperties": false
+              },
+              "minItems": 1
+            }
+          },
+          "required": ["filtersConfig"],
+          "additionalProperties": false
+        }
+      },
+      "required": ["name"],
+      "additionalProperties": false
+    },
+    "guardMap": {
+      "title": "GuardMap",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/guard"
+        }
+      },
+      "additionalProperties": false
+    },
+    "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",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:inspectAgent"]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": ["name", "agentName"],
+      "additionalProperties": false
+    },
+    "aiCreateAgentSessionResolver": {
+      "title": "AICreateAgentSessionResolver",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:createAgentSession"]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": ["name", "agentName"],
+      "additionalProperties": false
+    },
+    "removePropertyKeyPatterns": {
+      "type": "array",
+      "items": {
+        "title": "Minimatch Pattern",
+        "type": "string"
+      },
+      "title": "Remove Property Key Patterns",
+      "description": "Remove properties from the schema sent to the model with keys matching these minimatch glob patterns."
+    }
+  }
+}