tinet-agent-cli 0.1.0.dev36__py3-none-any.whl

taco/assets/schemas/chatflow.json

@@ -0,0 +1,1048 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tinet.local/schemas/taco/chatflow.json",
+  "title": "TACO Chatflow DSL",
+  "description": "声明式 Chatflow YAML 的本地校验 schema；与 workflow 共用节点能力（含 llm / template-transform），终点为 answer（平台 mode=advanced-chat）。",
+  "x-taco": {
+    "example": "chatflow-basic",
+    "commands": [
+      "chatflow validate",
+      "workflow validate"
+    ],
+    "risks": [
+      "workflow validate 仅执行本地校验和编译，不会发送 HTTP 请求。",
+      "DSL 只能引用 secrets 名称，不能写入真实密钥值。",
+      "当前 Dify 普通 HTTP executor 无法安全替换动态 JSON body；json data 仅允许静态 JSON，动态客户输入请改用 query 或 x-www-form-urlencoded。",
+      "知识检索节点首期仅支持 multiple 多路召回。",
+      "branch / parallel 的 then/else/branches 内暂不支持再嵌套控制流。",
+      "iterate.steps 内首期仅允许业务节点（http / code / knowledge-retrieval），不可嵌套控制流。",
+      "Chatflow 终点使用 answer 字符串模板，不再使用 outputs 映射。",
+      "llm 首期仅支持 basic prompt（无 vision/memory/RAG context）；template-transform 须显式声明 variables。"
+    ]
+  },
+  "type": "object",
+  "required": [
+    "kind",
+    "name",
+    "inputs",
+    "answer"
+  ],
+  "properties": {
+    "kind": {
+      "const": "chatflow"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "inputs": {
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
+        "maxLength": 30
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/input"
+      }
+    },
+    "nodes": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/step"
+      }
+    },
+    "publish": {
+      "type": "object",
+      "required": [
+        "asTool"
+      ],
+      "properties": {
+        "asTool": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "steps": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/step"
+      }
+    },
+    "answer": {
+      "type": "string",
+      "minLength": 1,
+      "description": "最终回复模板，可引用 inputs 与前序节点输出，例如 {{ result.body }}"
+    }
+  },
+  "$defs": {
+    "input": {
+      "type": "object",
+      "required": [
+        "type",
+        "required"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "string",
+            "number",
+            "select"
+          ]
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "description": {
+          "type": "string"
+        },
+        "options": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "max_length": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "select"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "options"
+            ],
+            "properties": {
+              "options": {
+                "minItems": 1
+              }
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "scalar": {
+      "type": [
+        "string",
+        "number",
+        "boolean"
+      ]
+    },
+    "lineScalar": {
+      "oneOf": [
+        {
+          "type": "string",
+          "not": {
+            "pattern": "[\\r\\n\\u000B\\u000C\\u001C\\u001D\\u001E\\u0085\\u2028\\u2029]"
+          }
+        },
+        {
+          "type": [
+            "number",
+            "boolean"
+          ]
+        }
+      ]
+    },
+    "headerScalar": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/lineScalar"
+        },
+        {
+          "if": {
+            "type": "string"
+          },
+          "then": {
+            "not": {
+              "pattern": "\\{\\{[ \\t]{0,16}[A-Za-z][A-Za-z0-9_]{0,49}\\.[A-Za-z_][A-Za-z0-9_]{0,29}[ \\t]{0,16}\\}\\}"
+            }
+          }
+        }
+      ]
+    },
+    "headerName": {
+      "type": "string",
+      "pattern": "^[!#$%&'*+.^_`|~0-9A-Za-z-]+$"
+    },
+    "stringMap": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/scalar"
+      }
+    },
+    "headerMap": {
+      "type": "object",
+      "propertyNames": {
+        "$ref": "#/$defs/headerName"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/headerScalar"
+      }
+    },
+    "queryMap": {
+      "type": "object",
+      "propertyNames": {
+        "minLength": 1,
+        "pattern": "^(?!\\s)(?!.*\\s$)[^:\\r\\n\\u000B\\u000C\\u001C\\u001D\\u001E\\u0085\\u2028\\u2029]+$"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/lineScalar"
+      }
+    },
+    "authorization": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "no-auth",
+            "api-key"
+          ]
+        },
+        "config": {
+          "$ref": "#/$defs/authorizationConfig"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "no-auth"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "not": {
+              "required": [
+                "config"
+              ]
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "api-key"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "config"
+            ]
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "authorizationConfig": {
+      "type": "object",
+      "required": [
+        "type",
+        "api_key"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "basic",
+            "bearer",
+            "custom"
+          ]
+        },
+        "api_key": {
+          "type": "string",
+          "pattern": "^\\{\\{[ \\t]{0,16}secrets\\.[A-Za-z_][A-Za-z0-9_]{0,29}[ \\t]{0,16}\\}\\}$"
+        },
+        "header": {
+          "$ref": "#/$defs/headerName"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "custom"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "header"
+            ],
+            "properties": {
+              "header": {
+                "minLength": 1
+              }
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "jsonValue": {
+      "oneOf": [
+        {
+          "type": [
+            "string",
+            "number",
+            "boolean",
+            "null"
+          ]
+        },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/jsonValue"
+          }
+        },
+        {
+          "$ref": "#/$defs/jsonObject"
+        }
+      ]
+    },
+    "jsonObject": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/$defs/jsonValue"
+      }
+    },
+    "body": {
+      "type": "object",
+      "description": "JSON body 仅允许静态 JSON；动态值请改用 query 或 x-www-form-urlencoded。",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "none",
+            "x-www-form-urlencoded",
+            "raw-text",
+            "json"
+          ]
+        },
+        "data": {}
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "none"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "not": {
+              "required": [
+                "data"
+              ]
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "json"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "data"
+            ],
+            "properties": {
+              "data": {
+                "oneOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "$ref": "#/$defs/jsonObject"
+                  }
+                ]
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "raw-text"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "data"
+            ],
+            "properties": {
+              "data": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "type": {
+                "const": "x-www-form-urlencoded"
+              }
+            },
+            "required": [
+              "type"
+            ]
+          },
+          "then": {
+            "required": [
+              "data"
+            ],
+            "properties": {
+              "data": {
+                "$ref": "#/$defs/stringMap"
+              }
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "timeout": {
+      "type": "object",
+      "properties": {
+        "connect": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "read": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "write": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "retry": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean"
+        },
+        "retry_enabled": {
+          "type": "boolean"
+        },
+        "max_retries": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 10
+        },
+        "interval": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retry_interval": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "httpNode": {
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "method",
+        "url"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "type": {
+          "const": "http"
+        },
+        "method": {
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH",
+            "DELETE",
+            "HEAD",
+            "get",
+            "post",
+            "put",
+            "patch",
+            "delete",
+            "head"
+          ]
+        },
+        "url": {
+          "type": "string",
+          "minLength": 1
+        },
+        "query": {
+          "$ref": "#/$defs/queryMap"
+        },
+        "headers": {
+          "$ref": "#/$defs/headerMap"
+        },
+        "body": {
+          "$ref": "#/$defs/body"
+        },
+        "authorization": {
+          "$ref": "#/$defs/authorization"
+        },
+        "timeout": {
+          "$ref": "#/$defs/timeout"
+        },
+        "retry": {
+          "$ref": "#/$defs/retry"
+        }
+      },
+      "additionalProperties": false
+    },
+    "codeNode": {
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "language",
+        "code",
+        "outputs"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "type": {
+          "const": "code"
+        },
+        "language": {
+          "enum": [
+            "python3",
+            "javascript"
+          ]
+        },
+        "code": {
+          "type": "string",
+          "minLength": 1
+        },
+        "variables": {
+          "type": "object",
+          "propertyNames": {
+            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
+            "maxLength": 30
+          },
+          "additionalProperties": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "outputs": {
+          "type": "object",
+          "minProperties": 1,
+          "propertyNames": {
+            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
+            "maxLength": 30
+          },
+          "additionalProperties": {
+            "type": "object",
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "enum": [
+                  "string",
+                  "number",
+                  "object",
+                  "array[string]",
+                  "array[number]",
+                  "array[object]"
+                ]
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "knowledgeRetrievalNode": {
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "query",
+        "dataset_ids"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "type": {
+          "const": "knowledge-retrieval"
+        },
+        "query": {
+          "type": "string",
+          "minLength": 1
+        },
+        "dataset_ids": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "retrieval_mode": {
+          "const": "multiple"
+        },
+        "top_k": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 10
+        },
+        "score_threshold": {
+          "type": [
+            "number",
+            "null"
+          ],
+          "minimum": 0,
+          "maximum": 1
+        },
+        "reranking_enable": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "branchStep": {
+      "type": "object",
+      "required": [
+        "id",
+        "branch"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "branch": {
+          "type": "object",
+          "required": [
+            "when",
+            "then",
+            "else"
+          ],
+          "properties": {
+            "when": {
+              "type": "object",
+              "required": [
+                "left",
+                "op"
+              ],
+              "properties": {
+                "left": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "op": {
+                  "enum": [
+                    "is",
+                    "is not",
+                    "contains",
+                    "not contains",
+                    "empty",
+                    "not empty",
+                    "=",
+                    "≠",
+                    ">",
+                    "<",
+                    "≥",
+                    "≤"
+                  ]
+                },
+                "right": {
+                  "type": [
+                    "string",
+                    "number",
+                    "boolean",
+                    "null"
+                  ]
+                }
+              },
+              "additionalProperties": false
+            },
+            "then": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "oneOf": [
+                  {
+                    "$ref": "#/$defs/httpNode"
+                  },
+                  {
+                    "$ref": "#/$defs/codeNode"
+                  },
+                  {
+                    "$ref": "#/$defs/knowledgeRetrievalNode"
+                  },
+                  {
+                    "$ref": "#/$defs/llmNode"
+                  },
+                  {
+                    "$ref": "#/$defs/templateTransformNode"
+                  }
+                ]
+              }
+            },
+            "else": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "oneOf": [
+                  {
+                    "$ref": "#/$defs/httpNode"
+                  },
+                  {
+                    "$ref": "#/$defs/codeNode"
+                  },
+                  {
+                    "$ref": "#/$defs/knowledgeRetrievalNode"
+                  },
+                  {
+                    "$ref": "#/$defs/llmNode"
+                  },
+                  {
+                    "$ref": "#/$defs/templateTransformNode"
+                  }
+                ]
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "parallelStep": {
+      "type": "object",
+      "required": [
+        "id",
+        "parallel"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "parallel": {
+          "type": "object",
+          "required": [
+            "branches"
+          ],
+          "properties": {
+            "branches": {
+              "type": "array",
+              "minItems": 2,
+              "items": {
+                "type": "array",
+                "minItems": 1,
+                "items": {
+                  "oneOf": [
+                    {
+                      "$ref": "#/$defs/httpNode"
+                    },
+                    {
+                      "$ref": "#/$defs/codeNode"
+                    },
+                    {
+                      "$ref": "#/$defs/knowledgeRetrievalNode"
+                    },
+                    {
+                      "$ref": "#/$defs/llmNode"
+                    },
+                    {
+                      "$ref": "#/$defs/templateTransformNode"
+                    }
+                  ]
+                }
+              }
+            },
+            "join": {
+              "type": "string",
+              "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+              "maxLength": 50
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "iterateStep": {
+      "type": "object",
+      "required": [
+        "id",
+        "iterate"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "iterate": {
+          "type": "object",
+          "required": [
+            "over",
+            "output",
+            "steps"
+          ],
+          "properties": {
+            "over": {
+              "type": "string",
+              "minLength": 1,
+              "description": "迭代数组来源，必须是单个模板引用，例如 {{ prep.chunks }}"
+            },
+            "output": {
+              "type": "string",
+              "minLength": 1,
+              "description": "每轮收集的输出，必须是 iterate.steps 内节点的单个模板引用"
+            },
+            "steps": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "oneOf": [
+                  {
+                    "$ref": "#/$defs/httpNode"
+                  },
+                  {
+                    "$ref": "#/$defs/codeNode"
+                  },
+                  {
+                    "$ref": "#/$defs/knowledgeRetrievalNode"
+                  },
+                  {
+                    "$ref": "#/$defs/llmNode"
+                  },
+                  {
+                    "$ref": "#/$defs/templateTransformNode"
+                  }
+                ]
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "step": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/httpNode"
+        },
+        {
+          "$ref": "#/$defs/codeNode"
+        },
+        {
+          "$ref": "#/$defs/knowledgeRetrievalNode"
+        },
+        {
+          "$ref": "#/$defs/branchStep"
+        },
+        {
+          "$ref": "#/$defs/parallelStep"
+        },
+        {
+          "$ref": "#/$defs/iterateStep"
+        },
+        {
+          "$ref": "#/$defs/llmNode"
+        },
+        {
+          "$ref": "#/$defs/templateTransformNode"
+        }
+      ]
+    },
+    "llmNode": {
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "provider",
+        "model"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "type": {
+          "const": "llm"
+        },
+        "provider": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200
+        },
+        "model": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 200
+        },
+        "mode": {
+          "enum": [
+            "chat",
+            "completion"
+          ]
+        },
+        "completion_params": {
+          "type": "object",
+          "additionalProperties": true
+        },
+        "prompt": {
+          "type": "string",
+          "minLength": 1
+        },
+        "prompt_template": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "required": [
+              "role",
+              "text"
+            ],
+            "properties": {
+              "role": {
+                "enum": [
+                  "system",
+                  "user",
+                  "assistant"
+                ]
+              },
+              "text": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": false,
+      "anyOf": [
+        {
+          "required": [
+            "prompt"
+          ]
+        },
+        {
+          "required": [
+            "prompt_template"
+          ]
+        }
+      ]
+    },
+    "templateTransformNode": {
+      "type": "object",
+      "required": [
+        "id",
+        "type",
+        "template",
+        "variables"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[A-Za-z][A-Za-z0-9_]*$",
+          "maxLength": 50
+        },
+        "type": {
+          "const": "template-transform"
+        },
+        "template": {
+          "type": "string",
+          "minLength": 1
+        },
+        "variables": {
+          "type": "object",
+          "minProperties": 1,
+          "propertyNames": {
+            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
+            "maxLength": 30
+          },
+          "additionalProperties": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}