-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
4144 lines (4010 loc) · 141 KB
/
api.yaml
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: "3.0.1"
info:
title: "Kronos Orchestrator"
description: |
Kronos Orhcestrator serverless Backend API.
GitLab Project: [Orchestrator Serverless](https://code.aws.mpac.ca/kronos/orchestrator-serverless).
See the frontend also, [Orchestrator UI](https://code.aws.mpac.ca/kronos/orchestrator-ui)
To easily test the API, use the Test feature on AWS API Gateway directly.
**Note**: 'Testing' the API uses real calls, not mocks.
version: "1.0"
contact:
name: MPAC IT Support
url: "https://itsupport.aws.mpac.ca/"
servers:
- description: AWS API Gatway URL.
url: "https://7sxz67kmnd.execute-api.ca-central-1.amazonaws.com/{basePath}"
variables:
basePath:
default: "dev"
tags:
- name: Playground
description: Calls to functions related to using Orchestrator's LLM testing page.
externalDocs:
description: "Documentation: Playground"
url: 'https://mpacit.atlassian.net/wiki/spaces/SI/pages/784662806'
- name: Data Sources
description: Calls to functions related to managing and querying data sources.
externalDocs:
description: "Documentation: Data Sources"
url: 'https://mpacit.atlassian.net/wiki/spaces/SI/pages/786399540'
- name: Endpoints
description: Calls to functions related managing or using endpoints.
externalDocs:
description: "Documentation: Endpoints"
url: 'https://mpacit.atlassian.net/wiki/spaces/SI/pages/786333946'
- name: Workflows
description: Calls to functions related to managing, creating, or using workflows.
externalDocs:
description: "Documentation: Workflows"
url: 'https://mpacit.atlassian.net/wiki/spaces/SI/pages/786333956'
- name: Options
description: |
**Note:** All default OPTION method specifications, as exported from AWS API Gateway.
For more information on options see [Add Confluence doc here. Explain setup in template.yaml, and CreateResposne proxy integration.]
externalDocs:
description: |
Documentation: AWS API Gateway
url: 'https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.html'
paths:
# PLAYGROUND
# ----------
/playground/invoke-static:
post:
summary: Invokes LLM responses in static mode
description: |
This backend function specifically handles static invocations within Playground.
**Static mode:** Returns the model's response only once it is fully complete.
tags:
- Playground
operationId: playgroundInvokeStatic
requestBody:
description: |
User inputs, and any previous inputs / ouputs in the conversation session are sent to procduce a new response output.
The model's configuration parameters are also sent during invocation.
For more information about these parameters, [click here](https://mpacit.atlassian.net/wiki/spaces/SI/pages/784662806/).
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeRequest'
responses:
"200":
description: Successfully invoked model using static mode.
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeResponse'
'500':
description: Internal server error. Invocation failed.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-InvokeStaticModelFunction-oUIKMsxVQERt/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/playground/invoke-streaming:
post:
summary: Invokes LLM responses in streaming mode
description: |
This backend function specifically handles streaming invocations within Playground.
**Streaming mode:** returns the models response incrementally as it is generated.
tags:
- Playground
operationId: playgroundInvokeStreaming
requestBody:
description: |
User inputs, and any previous inputs / ouputs in the conversation session are sent to procduce a new response output.
The model's configuration parameters are also sent during invocation.
For more information about these parameters, [click here](https://mpacit.atlassian.net/wiki/spaces/SI/pages/784662806/).
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeRequest'
responses:
"200":
description: |
**VERIFY THIS** The model's response will be streaming back to the UI by updating incrementally updating the below object.
content:
application/json:
schema:
$ref: '#/components/schemas/InvokeResponse'
'500':
description: Internal server error. Invocation failed.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-InvokeStreamingModelFuncti-r95F0yyIZkSR/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
# DATA SOURCES
# ------------
/context-source:
get:
summary: Retreive a single data source
description: |
Specify the ID of the target data source, and retrieve its database record.
Does not include infromation on contents contained in the data source.
tags:
- Data Sources
operationId: getDataSource
parameters:
- name: id
description: Unique ID value of Data Source.
in: query
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Successfully retreived data source.
content:
application/json:
schema:
$ref: '#/components/schemas/DataSource'
"400":
description: Invalid request. Data Source ID required.
"404":
description: Invalid request. Data source ID not found.
"500":
description: Internal server error. Data Source not retreived.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-GetContextSourceFunction-NAouQQzKSdJW/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
delete:
summary: Delete a data source
description: |
Specify a target data source. The data source's contents will be deleted from Weaviate, and all other information about it will be removed from the PostgreSQL database.
tags:
- Data Sources
operationId: deleteDataSource
parameters:
- name: id
description: Unique ID value of Data Source.
in: query
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Successfully deleted Data Source.
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessMessage'
"404":
description: Invalid request. Data Source ID not found.
"500":
description: Internal server error.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-DeleteContextSourceFunctio-gLsqpEpALVou/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-sources:
get:
summary: Retreive all data sources
description: |
Retrieve information on all data source connections.
Does not contain infromation on contents contained within the data sources.
tags:
- Data Sources
operationId: getDataSources
responses:
"200":
description: Successfully retreived all data sources.
content:
application/json:
schema:
$ref: '#/components/schemas/DataSources'
"500":
description: Internal server error. Data sources not retreived.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-GetAllContextSourcesFuncti-TfXjxZcgY54t/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/create:
post:
summary: Create a new data source
description: |
Create a new [Data Source](https://mpacit.atlassian.net/wiki/spaces/SI/pages/786399540). A new Weaviate schema will be created to save all context added later to the data source. An entry in the PostgreSQL database will also be created to reference the data source.
tags:
- Data Sources
operationId: createContextSource
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the Data Source.
example: ExampleDataSource
type:
type: string
description: The type of Data Source (Only option is KRONOS currently).
example: "KRONOS"
responses:
"200":
description: Successfully created Data Source.
content:
application/json:
schema:
$ref: '#/components/schemas/DataSource'
"409":
description: Invalid request. Data Source name already exists.
"500":
description: Internal server error. Data Source not created.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-CreateContextSourceFunctio-X7mcWPwm8lKt/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/query:
get:
summary: Retireve context relevant to input text
description: |
Connects to Weaviate database to obtain X amount of context chunks from a specific Data Source.
Context chunks are used within Orhcestrator to provide relevant context directly to the LLM alongside user input.
tags:
- Data Sources
operationId: queryWeaviate
parameters:
- name: id
description: Unique ID value of Data Source.
in: query
required: true
schema:
type: string
format: uuid
- name: query
description: Any text string.
example: "What is MPAC's IT Policy?"
in: query
required: true
schema:
type: string
- name: count
description: Number of context results to return
in: query
required: true
schema:
type: integer
responses:
"200":
description: Successful query. Context chunks returned.
content:
application/json:
schema:
type: array
items:
type: string
description: List of returned context chunk text.
example: ["Text from chunk1","Text from chunk 2"]
"400":
description: Invalid request. Data Source ID or query count not provided.
"500":
description: Error while querying Weaviate database.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-QueryContextSourceFunction-sh5Bcwcn8DJh/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/uploadFiles:
post:
summary: Upload files to a Data Source
description: |
This function ... SQS
tags:
- Data Sources
operationId: dataSourceUploadFiles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataSourceUploadFiles'
responses:
"200":
description: Successfully uploaded files.
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
"500":
description: Internal server error. Files not uploaded.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-SaveUploadFilesToS3Functio-KHyY0NBQN2Xi/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/webScraping:
post:
summary: Send SQS message to trigger web scraping
description: |
Specify a list of URLs to be scraped and the taget Data Source's ID and name. The Data Source name also acts `class_name`, which specifies a class where scraped contents will be stored within Weaviate.
This function does not handle scraping directly, but sends an SQS message with the provided data to process the scraping asynchronously.
tags:
- Data Sources
operationId: postWebScraping
requestBody:
description: Required data for backend processing.
content:
application/json:
schema:
$ref: '#/components/schemas/ScrapeRequest'
responses:
"200":
description: Successfully sent SQS messages to trigger web scraping
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
"500":
description: Internal server error. SQS messages not sent, web scraping not queued.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-SaveWebContentsNotificatio-u7Wd1Xyf22Jc/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/getUploadDataStatus:
post:
summary: Retrieve upload status of added context
description: Retrieve the upload statuses for context that has been added to a data source. This indicates whether it has been succesfully loaded into the Weaviate database yet or not.
tags:
- Data Sources
operationId: getUploadDataStatus
requestBody:
description: |
**Note:** In the below example, each element is an individual example of what the request body array may contain. See the schema for clarification.
content:
application/json:
schema:
$ref: '#/components/schemas/DataSourceUploadStatusRequest'
responses:
"200":
description: Successfully retreived status(es).
content:
application/json:
schema:
$ref: '#/components/schemas/DataSourceUploadStatus'
"500":
description: Internal server error. Status(es) not retreived.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-GetUploadDataStatusFunctio-ZffTxyYJhBiz/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/getUploadDataInfo:
post:
summary: Retrieve Data Source metadata
description: |
Retrieves information about what is contained in a data source.
This includes metadata on all of the files and scraped websites it may contain, and the total number of each.
tags:
- Data Sources
operationId: getUploadDataInfo
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dataSourceId:
type: string
format: uuid
description: Unique ID of data source
required:
- dataSourceId
responses:
"200":
description: Data Source information successfully retreived.
content:
application/json:
schema:
$ref: '#/components/schemas/DataSourceMetadata'
"400":
description: Invalid request. Data Source ID required.
"500":
description: Internal server error. Info not retireved.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-GetUploadDataInfoFunction-tXD672lalclY/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/context-source/metrics:
get:
summary: Retrieve data source metrics
description: Retreive a target data source's metrics. In the Orchestrator UI, these are used for the info display at the top of a data source page.
tags:
- Data Sources
operationId:
parameters:
- name: id
description: Unique ID value of Data Source.
in: query
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Successfully retreived data source metrics.
content:
application/json:
schema:
$ref: '#/components/schemas/DataSourceMetrics'
"404":
description: Invalid request. Data Source ID does not exist.
"500":
description: Internal server error. Data source metrics not retreived.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-GetContextSourceMetricsFun-XoxWYJrgYlWc/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/weaviate/get:
get:
summary: Retrieve context chunks from Weaviate
description: |
Retireve all context chunks from Weaviate for a specific Data Source.
**Note:** This API call is designed to populate the list of context chunks in the Data Sources view page.
tags:
- Data Sources
operationId: getContextWeaviate
parameters:
- name: id
description: The ID of target Data Source
in: query
required: true
example: 1
schema:
type: string
responses:
"200":
description: Successfully retreived context from Weaviate.
content:
application/json:
schema:
$ref: '#/components/schemas/GetWeaviate'
"500":
description: Internal server error. Context from Weaviate not retireved.
x-amazon-apigateway-integration:
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-GetWeaviateFunction-aTrik7a0N1wb/invocations"
passthroughBehavior: "when_no_match"
type: "aws_proxy"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"
Access-Control-Allow-Headers:
schema:
type: "string"
content: {}
x-amazon-apigateway-integration:
responses:
default:
statusCode: "200"
responseParameters:
method.response.header.Access-Control-Max-Age: "'600'"
method.response.header.Access-Control-Allow-Methods: "'POST, GET, PATCH,\
\ DELETE, OPTIONS'"
method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization'"
method.response.header.Access-Control-Allow-Origin: "'*'"
responseTemplates:
application/json: "{}\n"
requestTemplates:
application/json: "{\n \"statusCode\" : 200\n}\n"
passthroughBehavior: "when_no_match"
type: "mock"
/weaviate/batch-delete:
delete:
summary: Delete all context from a single source.
description: |
Delete all context chunks within Weaviate and the context source information in PostreSQL.
Specify which Data Source ID to target, and the filename / URL of the existing context source you wish to delete.
tags:
- Data Sources
operationId: batchDeleteWeaviate
parameters:
- name: id
description: Unique ID of context source.
in: query
required: true
schema:
type: string
- name: data_source_name
description: Name of context source (file name or URL).
example: example_file.pdf
in: query
required: true
schema:
type: string
responses:
"200":
description: Context source deleted from both Weaviate vector database and PostgreSQL database.
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessMessage'
"404":
description: Error. Provided context source ID or index name does not exist.
"500":
description: Internal server error. Context source not deleted.
x-amazon-apigateway-integration:
type: "aws_proxy"
httpMethod: "POST"
uri: "arn:aws:apigateway:ca-central-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ca-central-1:960138600391:function:kronos-orchestrator-dev-DeleteWeaviateFunction-03KPxnXzOdAk/invocations"
passthroughBehavior: "when_no_match"
options:
tags:
- Options
responses:
"200":
description: "200 response"
headers:
Access-Control-Allow-Origin:
schema:
type: "string"
Access-Control-Allow-Methods:
schema:
type: "string"
Access-Control-Max-Age:
schema:
type: "string"