objectstack/packages/spec/json-schema/ai/NLQRequest.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
109
110
{
  "$ref": "#/definitions/NLQRequest",
  "definitions": {
    "NLQRequest": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string",
          "description": "Natural language query"
        },
        "context": {
          "type": "object",
          "properties": {
            "userId": {
              "type": "string"
            },
            "userRole": {
              "type": "string"
            },
            "currentObject": {
              "type": "string",
              "description": "Current object being viewed"
            },
            "currentRecordId": {
              "type": "string",
              "description": "Current record ID"
            },
            "conversationHistory": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "query": {
                    "type": "string"
                  },
                  "timestamp": {
                    "type": "string"
                  },
                  "intent": {
                    "type": "string",
                    "enum": [
                      "select",
                      "aggregate",
                      "filter",
                      "sort",
                      "compare",
                      "trend",
                      "insight",
                      "create",
                      "update",
                      "delete"
                    ]
                  }
                },
                "required": [
                  "query",
                  "timestamp"
                ],
                "additionalProperties": false
              }
            },
            "defaultLimit": {
              "type": "integer",
              "default": 100
            },
            "timezone": {
              "type": "string",
              "default": "UTC"
            },
            "locale": {
              "type": "string",
              "default": "en-US"
            }
          },
          "additionalProperties": false
        },
        "includeAlternatives": {
          "type": "boolean",
          "default": false,
          "description": "Include alternative interpretations"
        },
        "maxAlternatives": {
          "type": "integer",
          "default": 3
        },
        "minConfidence": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "default": 0.5,
          "description": "Minimum confidence threshold"
        },
        "executeQuery": {
          "type": "boolean",
          "default": false,
          "description": "Execute query and return results"
        },
        "maxResults": {
          "type": "integer",
          "description": "Maximum results to return"
        }
      },
      "required": [
        "query"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}