ops-copilot/docs/openapi.yaml at main · zero-0002/ops-copilot · 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
openapi: 3.1.0
info:
  title: THY Ops Copilot API
  version: 0.5.0
paths:
  /healthz:
    get:
      summary: Healthz
      operationId: healthz_healthz_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /ask_unified:
    post:
      summary: Ask Unified
      operationId: ask_unified_ask_unified_post
      parameters:
      - name: x-session-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Session-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AskUnifiedRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AskUnifiedResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AskUnifiedRequest:
      properties:
        question:
          type: string
          title: Question
          example: Son 7 günde ortalama gecikme ve fazla bagaj politikası nedir?
        preview_rows:
          type: integer
          title: Preview Rows
          default: 100
        return_rows:
          type: boolean
          title: Return Rows
          default: true
        return_chart:
          type: boolean
          title: Return Chart
          default: true
        top_k:
          type: integer
          title: Top K
          default: 8
        threshold:
          type: number
          title: Threshold
          default: 0.85
      type: object
      required:
      - question
      title: AskUnifiedRequest
    AskUnifiedResponse:
      properties:
        used_cache:
          type: boolean
          title: Used Cache
        use_web:
          type: boolean
          title: Use Web
        want_sql:
          type: boolean
          title: Want Sql
        final_answer:
          anyOf:
          - type: string
          - type: 'null'
          title: Final Answer
          default: ''
        analysis_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Analysis Text
        headline_metrics:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Headline Metrics
        vega_lite_spec:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Vega Lite Spec
        sql:
          anyOf:
          - type: string
          - type: 'null'
          title: Sql
        rows:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Rows
        columns:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Columns
        citations:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Citations
        execution_ms:
          type: integer
          title: Execution Ms
        source:
          type: string
          title: Source
      type: object
      required:
      - used_cache
      - use_web
      - want_sql
      - execution_ms
      - source
      title: AskUnifiedResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError