rag-engine/rag-engine.schema.json at main · render-examples/rag-engine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://render.com/schemas/rag-engine-v1.json",
  "title": "RAG Engine",
  "type": "object",
  "additionalProperties": false,
  "required": ["version", "project", "default_adapter", "adapters", "content", "embedding", "mcp"],
  "properties": {
    "version": { "const": 1 },
    "project": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "resource_prefix"],
      "properties": {
        "name": { "type": "string", "minLength": 1 },
        "resource_prefix": { "type": "string", "pattern": "^[a-z][a-z0-9-]*$" }
      }
    },
    "default_adapter": { "type": "string", "minLength": 1 },
    "adapters": {
      "type": "object",
      "minProperties": 1,
      "additionalProperties": { "$ref": "#/$defs/adapter" }
    },
    "content": {
      "type": "object",
      "additionalProperties": false,
      "required": ["full_text_language", "chunking"],
      "properties": {
        "full_text_language": { "type": "string", "enum": ["simple", "english"] },
        "chunking": { "$ref": "#/$defs/chunking" }
      }
    },
    "embedding": { "$ref": "#/$defs/embedding" },
    "mcp": {
      "type": "object",
      "additionalProperties": false,
      "required": ["namespace", "token_env", "filters"],
      "properties": {
        "namespace": { "type": "string", "pattern": "^[a-z][a-z0-9_-]*$" },
        "token_env": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" },
        "filters": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "enum": ["source_id", "kind", "occurred_since", "occurred_until", "entity"]
          }
        }
      }
    }
  },
  "$defs": {
    "adapter": {
      "type": "object",
      "additionalProperties": false,
      "required": ["kind", "enabled", "batch_size", "sequential"],
      "properties": {
        "kind": { "type": "string", "minLength": 1 },
        "enabled": { "type": "boolean" },
        "batch_size": { "type": "integer", "minimum": 1, "maximum": 1000 },
        "sequential": { "type": "boolean" },
        "required_env": {
          "type": "array",
          "uniqueItems": true,
          "items": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" }
        },
        "config": { "type": "object" }
      }
    },
    "chunking": {
      "type": "object",
      "additionalProperties": false,
      "required": ["strategy", "target_tokens", "overlap_tokens", "minimum_tokens"],
      "properties": {
        "strategy": { "enum": ["consecutive_units"] },
        "target_tokens": { "type": "integer", "minimum": 50, "maximum": 8000 },
        "overlap_tokens": { "type": "integer", "minimum": 0, "maximum": 2000 },
        "minimum_tokens": { "type": "integer", "minimum": 1, "maximum": 4000 }
      }
    },
    "embedding": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "profile_id", "provider", "model", "dimension", "endpoint_env",
        "api_key_env", "document_prefix", "query_prefix", "batch_size",
        "input_reserve_tokens", "normalized", "model_artifact"
      ],
      "properties": {
        "profile_id": { "type": "string", "minLength": 1 },
        "provider": { "const": "openai-compatible-private" },
        "model": { "type": "string", "minLength": 1 },
        "dimension": { "type": "integer", "minimum": 1, "maximum": 65535 },
        "endpoint_env": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" },
        "api_key_env": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" },
        "document_prefix": { "type": "string" },
        "query_prefix": { "type": "string" },
        "batch_size": { "type": "integer", "minimum": 1, "maximum": 256 },
        "input_reserve_tokens": {
          "type": "integer",
          "minimum": 0,
          "maximum": 8192
        },
        "normalized": { "type": "boolean" },
        "model_artifact": {
          "type": "object",
          "additionalProperties": false,
          "required": ["repository", "filename", "revision", "sha256", "pooling", "context_tokens"],
          "properties": {
            "repository": { "type": "string", "minLength": 1 },
            "filename": { "type": "string", "minLength": 1 },
            "revision": { "type": "string", "minLength": 7 },
            "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
            "pooling": { "type": "string", "minLength": 1 },
            "context_tokens": { "type": "integer", "minimum": 128 }
          }
        }
      }
    }
  }
}