@takeshape/schema 11.17.3 → 11.17.6

package/es/schemas/project-schema/experimental.json

@@ -0,0 +1,601 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://schema.takeshape.io/project-schema/experimental#",
+  "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"
+        },
+        "states": {
+          "$ref": "#/definitions/agentStateMap"
+        }
+      },
+      "required": ["states"],
+      "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",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentVariableStepGraphqlArg"
+        },
+        {
+          "$ref": "#/definitions/agentVariableStepStateOutput"
+        },
+        {
+          "$ref": "#/definitions/agentVariableStepPreviousStateOutput"
+        }
+      ]
+    },
+    "agentVariableStepGraphqlArg": {
+      "title": "Agent Variable Step GraphQL Arg",
+      "description": "An Agent Variable that defines a GraphQL argument and makes its value available to templates.",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["graphqlArg"]
+        },
+        "argName": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "argName"],
+      "additionalProperties": false
+    },
+    "agentVariableStepPreviousStateOutput": {
+      "title": "Agent Variable Step Previous State Output",
+      "description": "An Agent Variable that provides the output of the previous state's execution.",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["previousStateOutput"]
+        },
+        "path": {
+          "type": "string"
+        }
+      },
+      "required": ["type"],
+      "additionalProperties": false
+    },
+    "agentVariableStepStateOutput": {
+      "title": "Agent Variable Step State Output",
+      "description": "An Agent Variable that provides the output of any previous state's execution.",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["stateOutput"]
+        },
+        "stateId": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "path": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "stateId"],
+      "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"
+        },
+        "variables": {
+          "title": "Variables",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentVariable"
+          }
+        },
+        "execution": {
+          "$ref": "#/definitions/agentExecution"
+        },
+        "transition": {
+          "title": "Agent State Transition",
+          "description": "These are evaluated in order until a destination is found.",
+          "type": "array",
+          "items": {
+            "default": {
+              "valueCheck": {
+                "type": "none"
+              }
+            },
+            "$ref": "#/definitions/agentTransition"
+          }
+        }
+      },
+      "required": ["name", "execution"],
+      "additionalProperties": false
+    },
+    "agentExecution": {
+      "title": "Agent Execution",
+      "discriminator": {
+        "propertyName": "type"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentExecutionNoop"
+        },
+        {
+          "$ref": "#/definitions/agentExecutionInput"
+        },
+        {
+          "$ref": "#/definitions/agentExecutionGraphql"
+        },
+        {
+          "$ref": "#/definitions/agentExecutionGenerateText"
+        },
+        {
+          "$ref": "#/definitions/agentExecutionChat"
+        }
+      ]
+    },
+    "agentExecutionNoop": {
+      "title": "Agent Execution No Operation",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["noop"]
+        }
+      },
+      "required": ["type"],
+      "additionalProperties": false
+    },
+    "agentExecutionInputArgument": {
+      "title": "Agent Execution Input Argument",
+      "type": "object",
+      "properties": {
+        "argName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "argType": {
+          "enum": ["boolean", "integer", "number", "string"]
+        },
+        "required": {
+          "type": "boolean"
+        }
+      },
+      "required": ["argName", "argType"],
+      "additionalProperties": false
+    },
+    "agentExecutionInput": {
+      "title": "Agent Execution Input",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["input"]
+        },
+        "name": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "inputType": {
+          "enum": ["query", "mutation"]
+        },
+        "arguments": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentExecutionInputArgument"
+          }
+        }
+      },
+      "required": ["type", "name", "inputType"],
+      "additionalProperties": false
+    },
+    "agentExecutionGraphql": {
+      "title": "Agent Execution GraphQL",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["graphql"]
+        },
+        "query": {
+          "type": "string"
+        },
+        "path": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "query"],
+      "additionalProperties": false
+    },
+    "agentAiStateInputArg": {
+      "title": "Agent AI State Input Argument",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["arg"]
+        },
+        "inputArgName": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "inputArgName"]
+    },
+    "agentAiStateInputTemplate": {
+      "title": "Agent AI State Input Template",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["template"]
+        },
+        "inputTemplate": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "inputTemplate"]
+    },
+    "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."
+        },
+        "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",
+          "description": "Maximal number of automatic roundtrips for tool calls."
+        }
+      },
+      "additionalProperties": false
+    },
+    "agentSimilarityGuardrail": {
+      "title": "AgentSimilarityGuardrail",
+      "type": "object",
+      "properties": {
+        "name": {
+          "enum": ["similarity"]
+        },
+        "shape": {
+          "type": "string"
+        },
+        "defaultResponse": {
+          "type": "string"
+        },
+        "threshold": {
+          "type": "number"
+        }
+      },
+      "required": ["name", "shape", "defaultResponse"],
+      "additionalProperties": false
+    },
+    "agentGuardrail": {
+      "title": "AgentGuardrail",
+      "discriminator": {
+        "propertyName": "name"
+      },
+      "oneOf": [
+        {
+          "$ref": "#/definitions/agentSimilarityGuardrail"
+        }
+      ]
+    },
+    "agentToolConfig": {
+      "title": "AgentToolConfig",
+      "type": "object",
+      "properties": {
+        "ref": {
+          "type": "string"
+        },
+        "selectionSet": {
+          "type": "string"
+        }
+      },
+      "required": ["ref"],
+      "additionalProperties": false
+    },
+    "agentExecutionGenerateText": {
+      "title": "Agent Execution Generate Text",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["generateText"]
+        },
+        "service": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "systemPrompt": {
+          "type": "string"
+        },
+        "input": {
+          "$ref": "#/definitions/agentAiStateInput"
+        },
+        "jsonSchema": {
+          "type": "string"
+        },
+        "tools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentToolConfig"
+          }
+        },
+        "guardrails": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentGuardrail"
+          }
+        },
+        "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"
+        },
+        "tools": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentToolConfig"
+          }
+        },
+        "sessionArg": {
+          "type": "string"
+        },
+        "guardrails": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/agentGuardrail"
+          }
+        },
+        "options": {
+          "$ref": "#/definitions/agentGenerateOptions"
+        }
+      },
+      "required": ["type", "service", "model", "input", "sessionArg"],
+      "additionalProperties": false
+    },
+    "agentValueCheckNone": {
+      "title": "Agent Value Check None",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["none"]
+        }
+      },
+      "required": ["type"]
+    },
+    "agentValueCheckBoolean": {
+      "title": "Agent Value Check Boolean",
+      "type": "object",
+      "properties": {
+        "type": {
+          "enum": ["boolean"]
+        },
+        "path": {
+          "type": "string"
+        },
+        "negated": {
+          "type": "boolean"
+        }
+      },
+      "required": ["type", "path"]
+    },
+    "agentTransition": {
+      "title": "Agent Transition",
+      "type": "object",
+      "properties": {
+        "valueCheck": {
+          "discriminator": {
+            "propertyName": "type"
+          },
+          "oneOf": [
+            {
+              "$ref": "#/definitions/agentValueCheckNone"
+            },
+            {
+              "$ref": "#/definitions/agentValueCheckBoolean"
+            }
+          ]
+        },
+        "limit": {
+          "type": "integer"
+        },
+        "destination": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["valueCheck", "destination"]
+    },
+    "agentMap": {
+      "title": "Agent Map",
+      "type": "object",
+      "patternProperties": {
+        "^[0-9A-Za-z_]+$": {
+          "$ref": "#/definitions/agent"
+        }
+      },
+      "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."
+        }
+      },
+      "additionalProperties": false
+    },
+    "aiRunAgentResolver": {
+      "title": "AIRunAgentResolver",
+      "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:runAgent"
+          ]
+        },
+        "agentName": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        },
+        "inputStateId": {
+          "type": "string",
+          "pattern": "^[0-9A-Za-z_]+$"
+        }
+      },
+      "required": [
+        "name",
+        "agentName",
+        "inputStateId"
+      ],
+      "additionalProperties": false
+    }
+  }
+}