knowledge/pkg/docs/swagger.yaml at main · gptscript-ai/knowledge · 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
definitions:
  gin.H:
    additionalProperties: {}
    type: object
  types.Dataset:
    properties:
      id:
        description: Dataset ID - must be a valid RFC 1123 hostname
        example: asst-12345
        format: hostname_rfc1123
        type: string
    required:
    - id
    type: object
  types.IngestResponse:
    properties:
      documents:
        items:
          type: string
        type: array
    type: object
  vectorstore.Document:
    properties:
      content:
        type: string
      metadata:
        additionalProperties: {}
        type: object
      similarity_score:
        type: number
    type: object
info:
  contact:
    name: Acorn Labs Inc.
  description: This is the Knowledge API server for GPTStudio.
  title: Knowledge API
  version: "1"
paths:
  /datasets:
    get:
      description: List all datasets
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/types.Dataset'
            type: array
      summary: List all datasets
      tags:
      - datasets
  /datasets/{id}:
    delete:
      description: Delete a dataset by ID
      parameters:
      - description: Dataset ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/gin.H'
      summary: Delete a dataset
      tags:
      - datasets
    get:
      description: Get a dataset by ID
      parameters:
      - description: Dataset ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/types.Dataset'
      summary: Get a dataset
      tags:
      - datasets
  /datasets/{id}/documents/{doc_id}:
    delete:
      consumes:
      - application/json
      description: Remove a document from a dataset by ID
      parameters:
      - description: Dataset ID
        in: path
        name: id
        required: true
        type: string
      - description: Document ID
        in: path
        name: doc_id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/gin.H'
      summary: Remove a document from a dataset
      tags:
      - datasets
  /datasets/{id}/files/{file_id}:
    delete:
      consumes:
      - application/json
      description: Remove a file from a dataset by ID
      parameters:
      - description: Dataset ID
        in: path
        name: id
        required: true
        type: string
      - description: File ID
        in: path
        name: file_id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/gin.H'
      summary: Remove a file from a dataset
      tags:
      - datasets
  /datasets/{id}/ingest:
    post:
      consumes:
      - application/json
      description: Ingest content into a dataset by ID
      parameters:
      - description: Dataset ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/types.IngestResponse'
      summary: Ingest content into a dataset
      tags:
      - datasets
  /datasets/{id}/retrieve:
    post:
      consumes:
      - application/json
      description: Retrieve content from a dataset by ID
      parameters:
      - description: Dataset ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/vectorstore.Document'
            type: array
      summary: Retrieve content from a dataset
      tags:
      - datasets
  /datasets/create:
    post:
      consumes:
      - application/json
      description: Create a new dataset
      parameters:
      - description: Dataset object
        in: body
        name: dataset
        required: true
        schema:
          $ref: '#/definitions/types.Dataset'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/types.Dataset'
      summary: Create a new dataset
      tags:
      - datasets
swagger: "2.0"