objectstack/packages/spec/json-schema/ai/RAGQueryResponse.json at 8ae3d928f9c95dd320e89d8629a52085fc3d2d73 · objectstack-ai/objectstack · 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
{
  "$ref": "#/definitions/RAGQueryResponse",
  "definitions": {
    "RAGQueryResponse": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "content": {
                "type": "string"
              },
              "score": {
                "type": "number"
              },
              "metadata": {
                "type": "object",
                "properties": {
                  "source": {
                    "type": "string",
                    "description": "Document source (file path, URL, etc.)"
                  },
                  "sourceType": {
                    "type": "string",
                    "enum": [
                      "file",
                      "url",
                      "api",
                      "database",
                      "custom"
                    ]
                  },
                  "title": {
                    "type": "string"
                  },
                  "author": {
                    "type": "string"
                  },
                  "createdAt": {
                    "type": "string",
                    "description": "ISO timestamp"
                  },
                  "updatedAt": {
                    "type": "string",
                    "description": "ISO timestamp"
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "category": {
                    "type": "string"
                  },
                  "language": {
                    "type": "string",
                    "description": "Document language (ISO 639-1 code)"
                  },
                  "custom": {
                    "type": "object",
                    "additionalProperties": {},
                    "description": "Custom metadata fields"
                  }
                },
                "required": [
                  "source"
                ],
                "additionalProperties": false
              },
              "chunkId": {
                "type": "string"
              }
            },
            "required": [
              "content",
              "score"
            ],
            "additionalProperties": false
          }
        },
        "context": {
          "type": "string",
          "description": "Assembled context for LLM"
        },
        "tokensUsed": {
          "type": "integer"
        },
        "retrievalTime": {
          "type": "number",
          "description": "Retrieval time in milliseconds"
        }
      },
      "required": [
        "query",
        "results",
        "context"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}