rag-of-all-trades/openapi.yaml at main · WikiTeq/rag-of-all-trades · 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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
openapi: 3.1.0
info:
  title: Rag Of All Trades
  description: RAG Service
  version: 0.1.0
paths:
  /health:
    get:
      summary: Health Check
      description: Combined health check for FastAPI, vector store, and Celery.
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /:
    get:
      summary: Read Root
      operationId: read_root__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/v1/query:
    post:
      tags:
      - Applications APIs
      summary: Query Endpoint
      description: Retrieve top-k chunks from vector store without LLM answer.
      operationId: query_endpoint_api_v1_query__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api__v1__chunk_retrieval__schema__QueryRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api__v1__chunk_retrieval__schema__QueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/rephrase:
    post:
      tags:
      - Applications APIs
      summary: Query Endpoint
      description: Rephrase Node for by default 5 chunks using LLM.
      operationId: query_endpoint_api_v1_rephrase__post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api__v1__rephrase_retrieval__schema__QueryRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api__v1__rephrase_retrieval__schema__QueryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    api__v1__chunk_retrieval__schema__QueryRequest:
      properties:
        query:
          type: string
          title: Query
        top_k:
          type: integer
          title: Top K
          default: 20
        metadata_filters:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Metadata Filters
      type: object
      required:
      - query
      title: QueryRequest
    api__v1__chunk_retrieval__schema__QueryResponse:
      properties:
        references:
          items:
            $ref: '#/components/schemas/api__v1__rephrase_retrieval__schema__SourceReference'
          type: array
          title: References
        raw:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Raw
      type: object
      required:
      - references
      title: QueryResponse
    api__v1__rephrase_retrieval__schema__QueryRequest:
      properties:
        query:
          type: string
          title: Query
      type: object
      required:
      - query
      title: QueryRequest
    api__v1__rephrase_retrieval__schema__QueryResponse:
      properties:
        answer:
          type: string
          title: Answer
        references:
          items:
            $ref: '#/components/schemas/api__v1__rephrase_retrieval__schema__SourceReference'
          type: array
          title: References
      type: object
      required:
      - answer
      - references
      title: QueryResponse
    api__v1__rephrase_retrieval__schema__SourceReference:
      properties:
        source_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Name
        source_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Type
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        score:
          anyOf:
          - type: number
          - type: 'null'
          title: Score
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
        extras:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Extras
      type: object
      title: SourceReference