@relevanceai/sdk 1.38.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -33,10 +33,18 @@ export interface paths {
|
|
|
33
33
|
/** List all deployables. */
|
|
34
34
|
get: operations["ListDeployables"];
|
|
35
35
|
};
|
|
36
|
+
"/projects/create": {
|
|
37
|
+
/** Create a new Project that your user will have access to */
|
|
38
|
+
post: operations["CreateProject"];
|
|
39
|
+
};
|
|
36
40
|
"/projects/update": {
|
|
37
41
|
/** Update metadata of a Project */
|
|
38
42
|
post: operations["UpdateProject"];
|
|
39
43
|
};
|
|
44
|
+
"/projects/transfer_to_organization": {
|
|
45
|
+
/** Tie a project to an organization. This requires admin privileges over project and organization. */
|
|
46
|
+
post: operations["TransferProjectToOrganization"];
|
|
47
|
+
};
|
|
40
48
|
"/projects/list": {
|
|
41
49
|
/** List all projects and their metadata */
|
|
42
50
|
get: operations["ListProjects"];
|
|
@@ -180,6 +188,10 @@ export interface paths {
|
|
|
180
188
|
/** List centroids, optionally filtering by their ids. */
|
|
181
189
|
post: operations["ListCentroids"];
|
|
182
190
|
};
|
|
191
|
+
"/datasets/{dataset_id}/cluster/centroids/configs/list": {
|
|
192
|
+
/** List centroids configs for a dataset. */
|
|
193
|
+
get: operations["ListCentroidConfigs"];
|
|
194
|
+
};
|
|
183
195
|
"/datasets/{dataset_id}/cluster/centroids/{centroid_id}/delete": {
|
|
184
196
|
/** Delete a centroid by ID */
|
|
185
197
|
post: operations["DeleteCentroid"];
|
|
@@ -199,6 +211,34 @@ export interface paths {
|
|
|
199
211
|
"/datasets/{dataset_id}/cluster/centroids/summaries/bulk_delete": {
|
|
200
212
|
post: operations["DeleteClusterSummaries"];
|
|
201
213
|
};
|
|
214
|
+
"/organizations/create": {
|
|
215
|
+
post: operations["CreateOrganization"];
|
|
216
|
+
};
|
|
217
|
+
"/organizations/{organization_id}/update": {
|
|
218
|
+
post: operations["UpdateOrganization"];
|
|
219
|
+
};
|
|
220
|
+
"/admin/organizations/{organization_id}/update": {
|
|
221
|
+
post: operations["UpdateOrganizationAdmin"];
|
|
222
|
+
};
|
|
223
|
+
"/organizations/list": {
|
|
224
|
+
/** List all organizations and their metadata */
|
|
225
|
+
get: operations["ListOrganizations"];
|
|
226
|
+
};
|
|
227
|
+
"/organizations/{organization_id}/delete": {
|
|
228
|
+
post: operations["DeleteOrganization"];
|
|
229
|
+
};
|
|
230
|
+
"/organizations/{organization_id}/get": {
|
|
231
|
+
get: operations["GetOrganization"];
|
|
232
|
+
};
|
|
233
|
+
"/organizations/{organization_id}/usage/get": {
|
|
234
|
+
get: operations["GetOrganizationUsage"];
|
|
235
|
+
};
|
|
236
|
+
"/organizations/{organization_id}/users/list": {
|
|
237
|
+
get: operations["ListUsersInOrganization"];
|
|
238
|
+
};
|
|
239
|
+
"/organizations/{organization_id}/projects/list": {
|
|
240
|
+
get: operations["ListProjectsInOrganization"];
|
|
241
|
+
};
|
|
202
242
|
"/datasets/{dataset_id}/documents/insert": {
|
|
203
243
|
/**
|
|
204
244
|
* When inserting the document you can specify your own id for a document by using the field name **"\_id"**.
|
|
@@ -487,10 +527,35 @@ export interface paths {
|
|
|
487
527
|
"/workflows/{workflow_id}/get": {
|
|
488
528
|
post: operations["GetWorkflowStatus"];
|
|
489
529
|
};
|
|
530
|
+
"/workflows/{workflow_id}/delete": {
|
|
531
|
+
post: operations["DeleteWorkflowStatus"];
|
|
532
|
+
};
|
|
490
533
|
"/workflows/{workflow_id}/metadata": {
|
|
491
534
|
/** Update metadata for a workflow run */
|
|
492
535
|
post: operations["UpsertWorkflowMetadata"];
|
|
493
536
|
};
|
|
537
|
+
"/workflows/{workflow_id}/status": {
|
|
538
|
+
/** Update status for a workflow run */
|
|
539
|
+
post: operations["UpsertWorkflowStatus"];
|
|
540
|
+
};
|
|
541
|
+
"/datasets/{dataset_id}/field_children/{fieldchildren_id}/delete": {
|
|
542
|
+
post: operations["DeleteFieldChildren"];
|
|
543
|
+
};
|
|
544
|
+
"/datasets/{dataset_id}/field_children/list": {
|
|
545
|
+
post: operations["ListFieldChildrens"];
|
|
546
|
+
};
|
|
547
|
+
"/datasets/{dataset_id}/field_children/{fieldchildren_id}/update": {
|
|
548
|
+
post: operations["UpdateFieldChildren"];
|
|
549
|
+
};
|
|
550
|
+
"/workflows/favourites/{favouriteworkflow_id}/delete": {
|
|
551
|
+
post: operations["DeleteFavouriteWorkflow"];
|
|
552
|
+
};
|
|
553
|
+
"/workflows/favourites/list": {
|
|
554
|
+
post: operations["ListFavouriteWorkflows"];
|
|
555
|
+
};
|
|
556
|
+
"/workflows/favourites/{favouriteworkflow_id}/update": {
|
|
557
|
+
post: operations["UpdateFavouriteWorkflow"];
|
|
558
|
+
};
|
|
494
559
|
}
|
|
495
560
|
export interface components {
|
|
496
561
|
schemas: {
|
|
@@ -575,6 +640,15 @@ export interface components {
|
|
|
575
640
|
}[];
|
|
576
641
|
count: number;
|
|
577
642
|
};
|
|
643
|
+
CreateProjectInput: {
|
|
644
|
+
/** @description The name of the project */
|
|
645
|
+
name?: string;
|
|
646
|
+
/** @description The description of the project */
|
|
647
|
+
description?: string;
|
|
648
|
+
};
|
|
649
|
+
CreateProjectOutput: {
|
|
650
|
+
project_id: string;
|
|
651
|
+
};
|
|
578
652
|
UpdateProjectInput: {
|
|
579
653
|
/** @description The name of the project */
|
|
580
654
|
name?: string;
|
|
@@ -585,6 +659,11 @@ export interface components {
|
|
|
585
659
|
status: string;
|
|
586
660
|
message: string;
|
|
587
661
|
};
|
|
662
|
+
TransferProjectToOrganizationInput: {
|
|
663
|
+
/** @description The ID of the organization. */
|
|
664
|
+
organization_id: string;
|
|
665
|
+
};
|
|
666
|
+
TransferProjectToOrganizationOutput: unknown;
|
|
588
667
|
ListProjectsInput: unknown;
|
|
589
668
|
ListProjectsOutput: {
|
|
590
669
|
projects: {
|
|
@@ -628,8 +707,13 @@ export interface components {
|
|
|
628
707
|
last_name?: string;
|
|
629
708
|
role?: string;
|
|
630
709
|
company?: string;
|
|
631
|
-
|
|
710
|
+
label?: string;
|
|
711
|
+
notes?: string;
|
|
632
712
|
permissions?: components["schemas"]["permissions"];
|
|
713
|
+
organization_permissions?: {
|
|
714
|
+
[key: string]: components["schemas"]["permissions"];
|
|
715
|
+
};
|
|
716
|
+
referral_code?: string;
|
|
633
717
|
/** @description The name of the project. This will contain all your datasets. */
|
|
634
718
|
project?: string;
|
|
635
719
|
/** @description The id token for a signed in account. This attaches the sign in account to the user. */
|
|
@@ -645,6 +729,29 @@ export interface components {
|
|
|
645
729
|
page?: number;
|
|
646
730
|
/** @default 20 */
|
|
647
731
|
page_size?: number;
|
|
732
|
+
required_permissions?: {
|
|
733
|
+
items: {
|
|
734
|
+
[key: string]: {
|
|
735
|
+
resources?: {
|
|
736
|
+
datasets?: {
|
|
737
|
+
[key: string]: boolean;
|
|
738
|
+
};
|
|
739
|
+
deployables?: {
|
|
740
|
+
[key: string]: boolean;
|
|
741
|
+
};
|
|
742
|
+
users?: {
|
|
743
|
+
[key: string]: boolean;
|
|
744
|
+
};
|
|
745
|
+
workflows?: {
|
|
746
|
+
[key: string]: boolean;
|
|
747
|
+
};
|
|
748
|
+
};
|
|
749
|
+
actions?: {
|
|
750
|
+
[key: string]: boolean;
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
};
|
|
648
755
|
};
|
|
649
756
|
ListUsersOutput: {
|
|
650
757
|
results: {
|
|
@@ -654,6 +761,8 @@ export interface components {
|
|
|
654
761
|
last_name?: string;
|
|
655
762
|
role?: string;
|
|
656
763
|
company?: string;
|
|
764
|
+
label?: string;
|
|
765
|
+
notes?: string;
|
|
657
766
|
permissions: {
|
|
658
767
|
projects: {
|
|
659
768
|
[key: string]: {
|
|
@@ -680,6 +789,31 @@ export interface components {
|
|
|
680
789
|
};
|
|
681
790
|
};
|
|
682
791
|
};
|
|
792
|
+
organizations?: {
|
|
793
|
+
[key: string]: {
|
|
794
|
+
items: {
|
|
795
|
+
[key: string]: {
|
|
796
|
+
resources?: {
|
|
797
|
+
datasets?: {
|
|
798
|
+
[key: string]: boolean;
|
|
799
|
+
};
|
|
800
|
+
deployables?: {
|
|
801
|
+
[key: string]: boolean;
|
|
802
|
+
};
|
|
803
|
+
users?: {
|
|
804
|
+
[key: string]: boolean;
|
|
805
|
+
};
|
|
806
|
+
workflows?: {
|
|
807
|
+
[key: string]: boolean;
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
actions?: {
|
|
811
|
+
[key: string]: boolean;
|
|
812
|
+
};
|
|
813
|
+
};
|
|
814
|
+
};
|
|
815
|
+
};
|
|
816
|
+
};
|
|
683
817
|
};
|
|
684
818
|
type: "user" | "machine";
|
|
685
819
|
_id: string;
|
|
@@ -689,6 +823,9 @@ export interface components {
|
|
|
689
823
|
};
|
|
690
824
|
IsUserAuthorizedInput: {
|
|
691
825
|
permissions?: components["schemas"]["permissions"];
|
|
826
|
+
organization_permissions?: {
|
|
827
|
+
[key: string]: components["schemas"]["permissions"];
|
|
828
|
+
};
|
|
692
829
|
};
|
|
693
830
|
IsUserAuthorizedOutput: {
|
|
694
831
|
valid: boolean;
|
|
@@ -721,6 +858,31 @@ export interface components {
|
|
|
721
858
|
};
|
|
722
859
|
};
|
|
723
860
|
};
|
|
861
|
+
organizations?: {
|
|
862
|
+
[key: string]: {
|
|
863
|
+
items: {
|
|
864
|
+
[key: string]: {
|
|
865
|
+
resources?: {
|
|
866
|
+
datasets?: {
|
|
867
|
+
[key: string]: boolean;
|
|
868
|
+
};
|
|
869
|
+
deployables?: {
|
|
870
|
+
[key: string]: boolean;
|
|
871
|
+
};
|
|
872
|
+
users?: {
|
|
873
|
+
[key: string]: boolean;
|
|
874
|
+
};
|
|
875
|
+
workflows?: {
|
|
876
|
+
[key: string]: boolean;
|
|
877
|
+
};
|
|
878
|
+
};
|
|
879
|
+
actions?: {
|
|
880
|
+
[key: string]: boolean;
|
|
881
|
+
};
|
|
882
|
+
};
|
|
883
|
+
};
|
|
884
|
+
};
|
|
885
|
+
};
|
|
724
886
|
};
|
|
725
887
|
GetAuthHeaderInfoOutput: {
|
|
726
888
|
profile_picture_url?: string;
|
|
@@ -729,37 +891,20 @@ export interface components {
|
|
|
729
891
|
last_name?: string;
|
|
730
892
|
role?: string;
|
|
731
893
|
company?: string;
|
|
894
|
+
label?: string;
|
|
895
|
+
notes?: string;
|
|
732
896
|
user_id: string;
|
|
733
897
|
key_id: string;
|
|
734
898
|
permissions: components["schemas"]["fullUserPermissions"];
|
|
735
899
|
email?: string;
|
|
736
900
|
};
|
|
737
|
-
CreateProjectInviteInput:
|
|
901
|
+
CreateProjectInviteInput: {
|
|
902
|
+
permissions?: components["schemas"]["permissions"];
|
|
903
|
+
organization_permissions?: {
|
|
904
|
+
[key: string]: components["schemas"]["permissions"];
|
|
905
|
+
};
|
|
738
906
|
email?: string;
|
|
739
907
|
user_id?: string;
|
|
740
|
-
permissions?: {
|
|
741
|
-
items: {
|
|
742
|
-
[key: string]: {
|
|
743
|
-
resources?: {
|
|
744
|
-
datasets?: {
|
|
745
|
-
[key: string]: boolean;
|
|
746
|
-
};
|
|
747
|
-
deployables?: {
|
|
748
|
-
[key: string]: boolean;
|
|
749
|
-
};
|
|
750
|
-
users?: {
|
|
751
|
-
[key: string]: boolean;
|
|
752
|
-
};
|
|
753
|
-
workflows?: {
|
|
754
|
-
[key: string]: boolean;
|
|
755
|
-
};
|
|
756
|
-
};
|
|
757
|
-
actions?: {
|
|
758
|
-
[key: string]: boolean;
|
|
759
|
-
};
|
|
760
|
-
};
|
|
761
|
-
};
|
|
762
|
-
};
|
|
763
908
|
};
|
|
764
909
|
CreateProjectInviteOutput: {
|
|
765
910
|
invite_code: string;
|
|
@@ -809,7 +954,6 @@ export interface components {
|
|
|
809
954
|
[key: string]: unknown;
|
|
810
955
|
};
|
|
811
956
|
ResendProjectInviteInput: {
|
|
812
|
-
invite_code: string;
|
|
813
957
|
permissions?: {
|
|
814
958
|
items: {
|
|
815
959
|
[key: string]: {
|
|
@@ -833,6 +977,10 @@ export interface components {
|
|
|
833
977
|
};
|
|
834
978
|
};
|
|
835
979
|
};
|
|
980
|
+
organization_permissions?: {
|
|
981
|
+
[key: string]: components["schemas"]["permissions"];
|
|
982
|
+
};
|
|
983
|
+
invite_code: string;
|
|
836
984
|
};
|
|
837
985
|
ResendProjectInviteOutput: {
|
|
838
986
|
[key: string]: unknown;
|
|
@@ -847,6 +995,8 @@ export interface components {
|
|
|
847
995
|
last_name?: string;
|
|
848
996
|
role?: string;
|
|
849
997
|
company?: string;
|
|
998
|
+
label?: string;
|
|
999
|
+
notes?: string;
|
|
850
1000
|
permissions: {
|
|
851
1001
|
projects: {
|
|
852
1002
|
[key: string]: {
|
|
@@ -873,6 +1023,31 @@ export interface components {
|
|
|
873
1023
|
};
|
|
874
1024
|
};
|
|
875
1025
|
};
|
|
1026
|
+
organizations?: {
|
|
1027
|
+
[key: string]: {
|
|
1028
|
+
items: {
|
|
1029
|
+
[key: string]: {
|
|
1030
|
+
resources?: {
|
|
1031
|
+
datasets?: {
|
|
1032
|
+
[key: string]: boolean;
|
|
1033
|
+
};
|
|
1034
|
+
deployables?: {
|
|
1035
|
+
[key: string]: boolean;
|
|
1036
|
+
};
|
|
1037
|
+
users?: {
|
|
1038
|
+
[key: string]: boolean;
|
|
1039
|
+
};
|
|
1040
|
+
workflows?: {
|
|
1041
|
+
[key: string]: boolean;
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
actions?: {
|
|
1045
|
+
[key: string]: boolean;
|
|
1046
|
+
};
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
};
|
|
1050
|
+
};
|
|
876
1051
|
};
|
|
877
1052
|
type: "user" | "machine";
|
|
878
1053
|
_id: string;
|
|
@@ -886,7 +1061,12 @@ export interface components {
|
|
|
886
1061
|
last_name?: string;
|
|
887
1062
|
role?: string;
|
|
888
1063
|
company?: string;
|
|
1064
|
+
label?: string;
|
|
1065
|
+
notes?: string;
|
|
889
1066
|
permissions?: components["schemas"]["permissions"];
|
|
1067
|
+
organization_permissions?: {
|
|
1068
|
+
[key: string]: components["schemas"]["permissions"];
|
|
1069
|
+
};
|
|
890
1070
|
/** @description The id token for a signed in account. This attaches the sign in account to the user. */
|
|
891
1071
|
id_token?: string;
|
|
892
1072
|
};
|
|
@@ -3357,6 +3537,16 @@ export interface components {
|
|
|
3357
3537
|
};
|
|
3358
3538
|
}[];
|
|
3359
3539
|
};
|
|
3540
|
+
ListCentroidConfigsInput: unknown;
|
|
3541
|
+
ListCentroidConfigsOutput: {
|
|
3542
|
+
results: {
|
|
3543
|
+
count: number;
|
|
3544
|
+
/** @description The vector fields that these centroids are associated with. */
|
|
3545
|
+
vector_fields: string[];
|
|
3546
|
+
/** @description Alias is used to name a cluster. */
|
|
3547
|
+
alias: string;
|
|
3548
|
+
}[];
|
|
3549
|
+
};
|
|
3360
3550
|
DeleteCentroidInput: {
|
|
3361
3551
|
/** @description The vector fields that these centroids are associated with. */
|
|
3362
3552
|
vector_fields?: string[];
|
|
@@ -3604,6 +3794,107 @@ export interface components {
|
|
|
3604
3794
|
cluster_ids: unknown[];
|
|
3605
3795
|
};
|
|
3606
3796
|
DeleteClusterSummariesOutput: unknown;
|
|
3797
|
+
CreateOrganizationInput: {
|
|
3798
|
+
name?: string;
|
|
3799
|
+
};
|
|
3800
|
+
CreateOrganizationOutput: {
|
|
3801
|
+
organization_id: string;
|
|
3802
|
+
};
|
|
3803
|
+
UpdateOrganizationInput: {
|
|
3804
|
+
name?: string;
|
|
3805
|
+
};
|
|
3806
|
+
UpdateOrganizationOutput: unknown;
|
|
3807
|
+
UpdateOrganizationAdminInput: {
|
|
3808
|
+
name?: string;
|
|
3809
|
+
entitlements?: {
|
|
3810
|
+
users?: {
|
|
3811
|
+
limit?: number;
|
|
3812
|
+
};
|
|
3813
|
+
workflows_gpu?: {
|
|
3814
|
+
enabled?: boolean;
|
|
3815
|
+
};
|
|
3816
|
+
};
|
|
3817
|
+
entitlement_plan?: "Starter" | "Business" | "Enterprise";
|
|
3818
|
+
};
|
|
3819
|
+
UpdateOrganizationAdminOutput: unknown;
|
|
3820
|
+
ListOrganizationsInput: unknown;
|
|
3821
|
+
ListOrganizationsOutput: {
|
|
3822
|
+
results: {
|
|
3823
|
+
organization_id?: string;
|
|
3824
|
+
name?: string;
|
|
3825
|
+
entitlements?: {
|
|
3826
|
+
users?: {
|
|
3827
|
+
limit?: number;
|
|
3828
|
+
};
|
|
3829
|
+
workflows_gpu?: {
|
|
3830
|
+
enabled?: boolean;
|
|
3831
|
+
};
|
|
3832
|
+
};
|
|
3833
|
+
entitlement_plan?: "Starter" | "Business" | "Enterprise";
|
|
3834
|
+
}[];
|
|
3835
|
+
};
|
|
3836
|
+
DeleteOrganizationInput: unknown;
|
|
3837
|
+
DeleteOrganizationOutput: unknown;
|
|
3838
|
+
GetOrganizationInput: unknown;
|
|
3839
|
+
GetOrganizationOutput: {
|
|
3840
|
+
organization_id?: string;
|
|
3841
|
+
name?: string;
|
|
3842
|
+
entitlements?: {
|
|
3843
|
+
users?: {
|
|
3844
|
+
limit?: number;
|
|
3845
|
+
};
|
|
3846
|
+
workflows_gpu?: {
|
|
3847
|
+
enabled?: boolean;
|
|
3848
|
+
};
|
|
3849
|
+
};
|
|
3850
|
+
entitlement_plan?: "Starter" | "Business" | "Enterprise";
|
|
3851
|
+
};
|
|
3852
|
+
GetOrganizationUsageInput: unknown;
|
|
3853
|
+
GetOrganizationUsageOutput: {
|
|
3854
|
+
usage: {
|
|
3855
|
+
users?: {
|
|
3856
|
+
limit?: number;
|
|
3857
|
+
};
|
|
3858
|
+
workflows_gpu?: {
|
|
3859
|
+
enabled?: boolean;
|
|
3860
|
+
};
|
|
3861
|
+
};
|
|
3862
|
+
limit: {
|
|
3863
|
+
users?: {
|
|
3864
|
+
limit?: number;
|
|
3865
|
+
};
|
|
3866
|
+
workflows_gpu?: {
|
|
3867
|
+
enabled?: boolean;
|
|
3868
|
+
};
|
|
3869
|
+
};
|
|
3870
|
+
};
|
|
3871
|
+
ListUsersInOrganizationInput: unknown;
|
|
3872
|
+
ListUsersInOrganizationOutput: {
|
|
3873
|
+
results: {
|
|
3874
|
+
_id?: string;
|
|
3875
|
+
profile_picture_url?: string;
|
|
3876
|
+
onboarded?: boolean;
|
|
3877
|
+
first_name?: string;
|
|
3878
|
+
last_name?: string;
|
|
3879
|
+
role?: string;
|
|
3880
|
+
company?: string;
|
|
3881
|
+
label?: string;
|
|
3882
|
+
notes?: string;
|
|
3883
|
+
}[];
|
|
3884
|
+
};
|
|
3885
|
+
ListProjectsInOrganizationInput: unknown;
|
|
3886
|
+
ListProjectsInOrganizationOutput: {
|
|
3887
|
+
results: {
|
|
3888
|
+
_id?: string;
|
|
3889
|
+
project_id?: string;
|
|
3890
|
+
name?: string;
|
|
3891
|
+
description?: string;
|
|
3892
|
+
permissions?: {
|
|
3893
|
+
[key: string]: unknown;
|
|
3894
|
+
};
|
|
3895
|
+
updated_at?: string;
|
|
3896
|
+
}[];
|
|
3897
|
+
};
|
|
3607
3898
|
InsertInput: {
|
|
3608
3899
|
/** @description Each document to upsert must have an _id field matching an existing document. */
|
|
3609
3900
|
document?: {
|
|
@@ -7099,17 +7390,20 @@ export interface components {
|
|
|
7099
7390
|
};
|
|
7100
7391
|
notebook_path: string;
|
|
7101
7392
|
instance_type?: string;
|
|
7393
|
+
dataset_id?: string;
|
|
7102
7394
|
};
|
|
7103
7395
|
TriggerWorkflowOutput: {
|
|
7104
7396
|
job_id: string;
|
|
7105
7397
|
};
|
|
7106
7398
|
ListWorkflowsInput: unknown;
|
|
7107
7399
|
ListWorkflowsOutput: {
|
|
7108
|
-
results: {
|
|
7400
|
+
results: ({
|
|
7109
7401
|
job_status: "InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped";
|
|
7110
7402
|
job_message: string;
|
|
7111
7403
|
creation_time: string;
|
|
7112
7404
|
notebook_path?: string;
|
|
7405
|
+
dataset_id?: string;
|
|
7406
|
+
status?: string;
|
|
7113
7407
|
params?: {
|
|
7114
7408
|
[key: string]: unknown;
|
|
7115
7409
|
};
|
|
@@ -7117,7 +7411,9 @@ export interface components {
|
|
|
7117
7411
|
metadata?: {
|
|
7118
7412
|
[key: string]: unknown;
|
|
7119
7413
|
};
|
|
7120
|
-
}
|
|
7414
|
+
} & {
|
|
7415
|
+
[key: string]: unknown;
|
|
7416
|
+
})[];
|
|
7121
7417
|
};
|
|
7122
7418
|
GetWorkflowStatusInput: unknown;
|
|
7123
7419
|
GetWorkflowStatusOutput: {
|
|
@@ -7125,6 +7421,8 @@ export interface components {
|
|
|
7125
7421
|
job_message: string;
|
|
7126
7422
|
creation_time: string;
|
|
7127
7423
|
notebook_path?: string;
|
|
7424
|
+
dataset_id?: string;
|
|
7425
|
+
status?: string;
|
|
7128
7426
|
params?: {
|
|
7129
7427
|
[key: string]: unknown;
|
|
7130
7428
|
};
|
|
@@ -7132,7 +7430,11 @@ export interface components {
|
|
|
7132
7430
|
metadata?: {
|
|
7133
7431
|
[key: string]: unknown;
|
|
7134
7432
|
};
|
|
7433
|
+
} & {
|
|
7434
|
+
[key: string]: unknown;
|
|
7135
7435
|
};
|
|
7436
|
+
DeleteWorkflowStatusInput: unknown;
|
|
7437
|
+
DeleteWorkflowStatusOutput: unknown;
|
|
7136
7438
|
UpsertWorkflowMetadataInput: {
|
|
7137
7439
|
/** @description Edit and add metadata for the workflow. */
|
|
7138
7440
|
metadata: {
|
|
@@ -7140,6 +7442,57 @@ export interface components {
|
|
|
7140
7442
|
};
|
|
7141
7443
|
};
|
|
7142
7444
|
UpsertWorkflowMetadataOutput: unknown;
|
|
7445
|
+
UpsertWorkflowStatusInput: {
|
|
7446
|
+
/** @description Metadata of the workflow. Can be an object including any information you want to store. */
|
|
7447
|
+
metadata?: {
|
|
7448
|
+
[key: string]: unknown;
|
|
7449
|
+
};
|
|
7450
|
+
/** @description Status of the workflow. Used for knowing when to send an email notification. */
|
|
7451
|
+
status: "complete" | "inprogress" | "failed";
|
|
7452
|
+
/** @description Workflow name that is passed into the email. */
|
|
7453
|
+
workflow_name?: string;
|
|
7454
|
+
/** @description Additional information of the workflow that is passed into the email. */
|
|
7455
|
+
additional_information?: string;
|
|
7456
|
+
};
|
|
7457
|
+
UpsertWorkflowStatusOutput: unknown;
|
|
7458
|
+
DeleteFieldChildrenInput: unknown;
|
|
7459
|
+
DeleteFieldChildrenOutput: unknown;
|
|
7460
|
+
ListFieldChildrensInput: {
|
|
7461
|
+
[key: string]: unknown;
|
|
7462
|
+
};
|
|
7463
|
+
ListFieldChildrensOutput: {
|
|
7464
|
+
results: {
|
|
7465
|
+
_id?: string;
|
|
7466
|
+
field?: string;
|
|
7467
|
+
field_children?: string[];
|
|
7468
|
+
metadata?: {
|
|
7469
|
+
[key: string]: unknown;
|
|
7470
|
+
};
|
|
7471
|
+
}[];
|
|
7472
|
+
};
|
|
7473
|
+
UpdateFieldChildrenInput: {
|
|
7474
|
+
_id?: string;
|
|
7475
|
+
field?: string;
|
|
7476
|
+
field_children?: string[];
|
|
7477
|
+
metadata?: {
|
|
7478
|
+
[key: string]: unknown;
|
|
7479
|
+
};
|
|
7480
|
+
};
|
|
7481
|
+
UpdateFieldChildrenOutput: unknown;
|
|
7482
|
+
DeleteFavouriteWorkflowInput: unknown;
|
|
7483
|
+
DeleteFavouriteWorkflowOutput: unknown;
|
|
7484
|
+
ListFavouriteWorkflowsInput: {
|
|
7485
|
+
[key: string]: unknown;
|
|
7486
|
+
};
|
|
7487
|
+
ListFavouriteWorkflowsOutput: {
|
|
7488
|
+
results: {
|
|
7489
|
+
_id?: string;
|
|
7490
|
+
}[];
|
|
7491
|
+
};
|
|
7492
|
+
UpdateFavouriteWorkflowInput: {
|
|
7493
|
+
_id?: string;
|
|
7494
|
+
};
|
|
7495
|
+
UpdateFavouriteWorkflowOutput: unknown;
|
|
7143
7496
|
};
|
|
7144
7497
|
}
|
|
7145
7498
|
export interface operations {
|
|
@@ -7280,26 +7633,60 @@ export interface operations {
|
|
|
7280
7633
|
};
|
|
7281
7634
|
};
|
|
7282
7635
|
};
|
|
7283
|
-
/**
|
|
7284
|
-
|
|
7636
|
+
/** Create a new Project that your user will have access to */
|
|
7637
|
+
CreateProject: {
|
|
7285
7638
|
parameters: {};
|
|
7286
7639
|
responses: {
|
|
7287
7640
|
/** successful operation */
|
|
7288
7641
|
200: {
|
|
7289
7642
|
content: {
|
|
7290
|
-
"application/json": components["schemas"]["
|
|
7643
|
+
"application/json": components["schemas"]["CreateProjectOutput"];
|
|
7291
7644
|
};
|
|
7292
7645
|
};
|
|
7293
7646
|
};
|
|
7294
7647
|
requestBody: {
|
|
7295
7648
|
content: {
|
|
7296
|
-
"application/json": components["schemas"]["
|
|
7649
|
+
"application/json": components["schemas"]["CreateProjectInput"];
|
|
7297
7650
|
};
|
|
7298
7651
|
};
|
|
7299
7652
|
};
|
|
7300
|
-
/**
|
|
7301
|
-
|
|
7302
|
-
parameters: {};
|
|
7653
|
+
/** Update metadata of a Project */
|
|
7654
|
+
UpdateProject: {
|
|
7655
|
+
parameters: {};
|
|
7656
|
+
responses: {
|
|
7657
|
+
/** successful operation */
|
|
7658
|
+
200: {
|
|
7659
|
+
content: {
|
|
7660
|
+
"application/json": components["schemas"]["UpdateProjectOutput"];
|
|
7661
|
+
};
|
|
7662
|
+
};
|
|
7663
|
+
};
|
|
7664
|
+
requestBody: {
|
|
7665
|
+
content: {
|
|
7666
|
+
"application/json": components["schemas"]["UpdateProjectInput"];
|
|
7667
|
+
};
|
|
7668
|
+
};
|
|
7669
|
+
};
|
|
7670
|
+
/** Tie a project to an organization. This requires admin privileges over project and organization. */
|
|
7671
|
+
TransferProjectToOrganization: {
|
|
7672
|
+
parameters: {};
|
|
7673
|
+
responses: {
|
|
7674
|
+
/** successful operation */
|
|
7675
|
+
200: {
|
|
7676
|
+
content: {
|
|
7677
|
+
"application/json": components["schemas"]["TransferProjectToOrganizationOutput"];
|
|
7678
|
+
};
|
|
7679
|
+
};
|
|
7680
|
+
};
|
|
7681
|
+
requestBody: {
|
|
7682
|
+
content: {
|
|
7683
|
+
"application/json": components["schemas"]["TransferProjectToOrganizationInput"];
|
|
7684
|
+
};
|
|
7685
|
+
};
|
|
7686
|
+
};
|
|
7687
|
+
/** List all projects and their metadata */
|
|
7688
|
+
ListProjects: {
|
|
7689
|
+
parameters: {};
|
|
7303
7690
|
responses: {
|
|
7304
7691
|
/** successful operation */
|
|
7305
7692
|
200: {
|
|
@@ -7825,6 +8212,23 @@ export interface operations {
|
|
|
7825
8212
|
};
|
|
7826
8213
|
};
|
|
7827
8214
|
};
|
|
8215
|
+
/** List centroids configs for a dataset. */
|
|
8216
|
+
ListCentroidConfigs: {
|
|
8217
|
+
parameters: {
|
|
8218
|
+
path: {
|
|
8219
|
+
/** ID of dataset */
|
|
8220
|
+
dataset_id: string;
|
|
8221
|
+
};
|
|
8222
|
+
};
|
|
8223
|
+
responses: {
|
|
8224
|
+
/** successful operation */
|
|
8225
|
+
200: {
|
|
8226
|
+
content: {
|
|
8227
|
+
"application/json": components["schemas"]["ListCentroidConfigsOutput"];
|
|
8228
|
+
};
|
|
8229
|
+
};
|
|
8230
|
+
};
|
|
8231
|
+
};
|
|
7828
8232
|
/** Delete a centroid by ID */
|
|
7829
8233
|
DeleteCentroid: {
|
|
7830
8234
|
parameters: {
|
|
@@ -7954,6 +8358,161 @@ export interface operations {
|
|
|
7954
8358
|
};
|
|
7955
8359
|
};
|
|
7956
8360
|
};
|
|
8361
|
+
CreateOrganization: {
|
|
8362
|
+
parameters: {};
|
|
8363
|
+
responses: {
|
|
8364
|
+
/** successful operation */
|
|
8365
|
+
200: {
|
|
8366
|
+
content: {
|
|
8367
|
+
"application/json": components["schemas"]["CreateOrganizationOutput"];
|
|
8368
|
+
};
|
|
8369
|
+
};
|
|
8370
|
+
};
|
|
8371
|
+
requestBody: {
|
|
8372
|
+
content: {
|
|
8373
|
+
"application/json": components["schemas"]["CreateOrganizationInput"];
|
|
8374
|
+
};
|
|
8375
|
+
};
|
|
8376
|
+
};
|
|
8377
|
+
UpdateOrganization: {
|
|
8378
|
+
parameters: {
|
|
8379
|
+
path: {
|
|
8380
|
+
/** ID of organization */
|
|
8381
|
+
organization_id: string;
|
|
8382
|
+
};
|
|
8383
|
+
};
|
|
8384
|
+
responses: {
|
|
8385
|
+
/** successful operation */
|
|
8386
|
+
200: {
|
|
8387
|
+
content: {
|
|
8388
|
+
"application/json": components["schemas"]["UpdateOrganizationOutput"];
|
|
8389
|
+
};
|
|
8390
|
+
};
|
|
8391
|
+
};
|
|
8392
|
+
requestBody: {
|
|
8393
|
+
content: {
|
|
8394
|
+
"application/json": components["schemas"]["UpdateOrganizationInput"];
|
|
8395
|
+
};
|
|
8396
|
+
};
|
|
8397
|
+
};
|
|
8398
|
+
UpdateOrganizationAdmin: {
|
|
8399
|
+
parameters: {
|
|
8400
|
+
path: {
|
|
8401
|
+
/** ID of organization */
|
|
8402
|
+
organization_id: string;
|
|
8403
|
+
};
|
|
8404
|
+
};
|
|
8405
|
+
responses: {
|
|
8406
|
+
/** successful operation */
|
|
8407
|
+
200: {
|
|
8408
|
+
content: {
|
|
8409
|
+
"application/json": components["schemas"]["UpdateOrganizationAdminOutput"];
|
|
8410
|
+
};
|
|
8411
|
+
};
|
|
8412
|
+
};
|
|
8413
|
+
requestBody: {
|
|
8414
|
+
content: {
|
|
8415
|
+
"application/json": components["schemas"]["UpdateOrganizationAdminInput"];
|
|
8416
|
+
};
|
|
8417
|
+
};
|
|
8418
|
+
};
|
|
8419
|
+
/** List all organizations and their metadata */
|
|
8420
|
+
ListOrganizations: {
|
|
8421
|
+
parameters: {};
|
|
8422
|
+
responses: {
|
|
8423
|
+
/** successful operation */
|
|
8424
|
+
200: {
|
|
8425
|
+
content: {
|
|
8426
|
+
"application/json": components["schemas"]["ListOrganizationsOutput"];
|
|
8427
|
+
};
|
|
8428
|
+
};
|
|
8429
|
+
};
|
|
8430
|
+
};
|
|
8431
|
+
DeleteOrganization: {
|
|
8432
|
+
parameters: {
|
|
8433
|
+
path: {
|
|
8434
|
+
/** ID of organization */
|
|
8435
|
+
organization_id: string;
|
|
8436
|
+
};
|
|
8437
|
+
};
|
|
8438
|
+
responses: {
|
|
8439
|
+
/** successful operation */
|
|
8440
|
+
200: {
|
|
8441
|
+
content: {
|
|
8442
|
+
"application/json": components["schemas"]["DeleteOrganizationOutput"];
|
|
8443
|
+
};
|
|
8444
|
+
};
|
|
8445
|
+
};
|
|
8446
|
+
requestBody: {
|
|
8447
|
+
content: {
|
|
8448
|
+
"application/json": components["schemas"]["DeleteOrganizationInput"];
|
|
8449
|
+
};
|
|
8450
|
+
};
|
|
8451
|
+
};
|
|
8452
|
+
GetOrganization: {
|
|
8453
|
+
parameters: {
|
|
8454
|
+
path: {
|
|
8455
|
+
/** ID of organization */
|
|
8456
|
+
organization_id: string;
|
|
8457
|
+
};
|
|
8458
|
+
};
|
|
8459
|
+
responses: {
|
|
8460
|
+
/** successful operation */
|
|
8461
|
+
200: {
|
|
8462
|
+
content: {
|
|
8463
|
+
"application/json": components["schemas"]["GetOrganizationOutput"];
|
|
8464
|
+
};
|
|
8465
|
+
};
|
|
8466
|
+
};
|
|
8467
|
+
};
|
|
8468
|
+
GetOrganizationUsage: {
|
|
8469
|
+
parameters: {
|
|
8470
|
+
path: {
|
|
8471
|
+
/** ID of organization */
|
|
8472
|
+
organization_id: string;
|
|
8473
|
+
};
|
|
8474
|
+
};
|
|
8475
|
+
responses: {
|
|
8476
|
+
/** successful operation */
|
|
8477
|
+
200: {
|
|
8478
|
+
content: {
|
|
8479
|
+
"application/json": components["schemas"]["GetOrganizationUsageOutput"];
|
|
8480
|
+
};
|
|
8481
|
+
};
|
|
8482
|
+
};
|
|
8483
|
+
};
|
|
8484
|
+
ListUsersInOrganization: {
|
|
8485
|
+
parameters: {
|
|
8486
|
+
path: {
|
|
8487
|
+
/** ID of organization */
|
|
8488
|
+
organization_id: string;
|
|
8489
|
+
};
|
|
8490
|
+
};
|
|
8491
|
+
responses: {
|
|
8492
|
+
/** successful operation */
|
|
8493
|
+
200: {
|
|
8494
|
+
content: {
|
|
8495
|
+
"application/json": components["schemas"]["ListUsersInOrganizationOutput"];
|
|
8496
|
+
};
|
|
8497
|
+
};
|
|
8498
|
+
};
|
|
8499
|
+
};
|
|
8500
|
+
ListProjectsInOrganization: {
|
|
8501
|
+
parameters: {
|
|
8502
|
+
path: {
|
|
8503
|
+
/** ID of organization */
|
|
8504
|
+
organization_id: string;
|
|
8505
|
+
};
|
|
8506
|
+
};
|
|
8507
|
+
responses: {
|
|
8508
|
+
/** successful operation */
|
|
8509
|
+
200: {
|
|
8510
|
+
content: {
|
|
8511
|
+
"application/json": components["schemas"]["ListProjectsInOrganizationOutput"];
|
|
8512
|
+
};
|
|
8513
|
+
};
|
|
8514
|
+
};
|
|
8515
|
+
};
|
|
7957
8516
|
/**
|
|
7958
8517
|
* When inserting the document you can specify your own id for a document by using the field name **"\_id"**.
|
|
7959
8518
|
*
|
|
@@ -9284,6 +9843,27 @@ export interface operations {
|
|
|
9284
9843
|
};
|
|
9285
9844
|
};
|
|
9286
9845
|
};
|
|
9846
|
+
DeleteWorkflowStatus: {
|
|
9847
|
+
parameters: {
|
|
9848
|
+
path: {
|
|
9849
|
+
/** ID of workflow */
|
|
9850
|
+
workflow_id: string;
|
|
9851
|
+
};
|
|
9852
|
+
};
|
|
9853
|
+
responses: {
|
|
9854
|
+
/** successful operation */
|
|
9855
|
+
200: {
|
|
9856
|
+
content: {
|
|
9857
|
+
"application/json": components["schemas"]["DeleteWorkflowStatusOutput"];
|
|
9858
|
+
};
|
|
9859
|
+
};
|
|
9860
|
+
};
|
|
9861
|
+
requestBody: {
|
|
9862
|
+
content: {
|
|
9863
|
+
"application/json": components["schemas"]["DeleteWorkflowStatusInput"];
|
|
9864
|
+
};
|
|
9865
|
+
};
|
|
9866
|
+
};
|
|
9287
9867
|
/** Update metadata for a workflow run */
|
|
9288
9868
|
UpsertWorkflowMetadata: {
|
|
9289
9869
|
parameters: {
|
|
@@ -9306,6 +9886,153 @@ export interface operations {
|
|
|
9306
9886
|
};
|
|
9307
9887
|
};
|
|
9308
9888
|
};
|
|
9889
|
+
/** Update status for a workflow run */
|
|
9890
|
+
UpsertWorkflowStatus: {
|
|
9891
|
+
parameters: {
|
|
9892
|
+
path: {
|
|
9893
|
+
/** ID of workflow */
|
|
9894
|
+
workflow_id: string;
|
|
9895
|
+
};
|
|
9896
|
+
};
|
|
9897
|
+
responses: {
|
|
9898
|
+
/** successful operation */
|
|
9899
|
+
200: {
|
|
9900
|
+
content: {
|
|
9901
|
+
"application/json": components["schemas"]["UpsertWorkflowStatusOutput"];
|
|
9902
|
+
};
|
|
9903
|
+
};
|
|
9904
|
+
};
|
|
9905
|
+
requestBody: {
|
|
9906
|
+
content: {
|
|
9907
|
+
"application/json": components["schemas"]["UpsertWorkflowStatusInput"];
|
|
9908
|
+
};
|
|
9909
|
+
};
|
|
9910
|
+
};
|
|
9911
|
+
DeleteFieldChildren: {
|
|
9912
|
+
parameters: {
|
|
9913
|
+
path: {
|
|
9914
|
+
/** ID of dataset */
|
|
9915
|
+
dataset_id: string;
|
|
9916
|
+
/** ID of fieldchildren */
|
|
9917
|
+
fieldchildren_id: string;
|
|
9918
|
+
};
|
|
9919
|
+
};
|
|
9920
|
+
responses: {
|
|
9921
|
+
/** successful operation */
|
|
9922
|
+
200: {
|
|
9923
|
+
content: {
|
|
9924
|
+
"application/json": components["schemas"]["DeleteFieldChildrenOutput"];
|
|
9925
|
+
};
|
|
9926
|
+
};
|
|
9927
|
+
};
|
|
9928
|
+
requestBody: {
|
|
9929
|
+
content: {
|
|
9930
|
+
"application/json": components["schemas"]["DeleteFieldChildrenInput"];
|
|
9931
|
+
};
|
|
9932
|
+
};
|
|
9933
|
+
};
|
|
9934
|
+
ListFieldChildrens: {
|
|
9935
|
+
parameters: {
|
|
9936
|
+
path: {
|
|
9937
|
+
/** ID of dataset */
|
|
9938
|
+
dataset_id: string;
|
|
9939
|
+
};
|
|
9940
|
+
};
|
|
9941
|
+
responses: {
|
|
9942
|
+
/** successful operation */
|
|
9943
|
+
200: {
|
|
9944
|
+
content: {
|
|
9945
|
+
"application/json": components["schemas"]["ListFieldChildrensOutput"];
|
|
9946
|
+
};
|
|
9947
|
+
};
|
|
9948
|
+
};
|
|
9949
|
+
requestBody: {
|
|
9950
|
+
content: {
|
|
9951
|
+
"application/json": components["schemas"]["ListFieldChildrensInput"];
|
|
9952
|
+
};
|
|
9953
|
+
};
|
|
9954
|
+
};
|
|
9955
|
+
UpdateFieldChildren: {
|
|
9956
|
+
parameters: {
|
|
9957
|
+
path: {
|
|
9958
|
+
/** ID of dataset */
|
|
9959
|
+
dataset_id: string;
|
|
9960
|
+
/** ID of fieldchildren */
|
|
9961
|
+
fieldchildren_id: string;
|
|
9962
|
+
};
|
|
9963
|
+
};
|
|
9964
|
+
responses: {
|
|
9965
|
+
/** successful operation */
|
|
9966
|
+
200: {
|
|
9967
|
+
content: {
|
|
9968
|
+
"application/json": components["schemas"]["UpdateFieldChildrenOutput"];
|
|
9969
|
+
};
|
|
9970
|
+
};
|
|
9971
|
+
};
|
|
9972
|
+
requestBody: {
|
|
9973
|
+
content: {
|
|
9974
|
+
"application/json": components["schemas"]["UpdateFieldChildrenInput"];
|
|
9975
|
+
};
|
|
9976
|
+
};
|
|
9977
|
+
};
|
|
9978
|
+
DeleteFavouriteWorkflow: {
|
|
9979
|
+
parameters: {
|
|
9980
|
+
path: {
|
|
9981
|
+
/** ID of favouriteworkflow */
|
|
9982
|
+
favouriteworkflow_id: string;
|
|
9983
|
+
};
|
|
9984
|
+
};
|
|
9985
|
+
responses: {
|
|
9986
|
+
/** successful operation */
|
|
9987
|
+
200: {
|
|
9988
|
+
content: {
|
|
9989
|
+
"application/json": components["schemas"]["DeleteFavouriteWorkflowOutput"];
|
|
9990
|
+
};
|
|
9991
|
+
};
|
|
9992
|
+
};
|
|
9993
|
+
requestBody: {
|
|
9994
|
+
content: {
|
|
9995
|
+
"application/json": components["schemas"]["DeleteFavouriteWorkflowInput"];
|
|
9996
|
+
};
|
|
9997
|
+
};
|
|
9998
|
+
};
|
|
9999
|
+
ListFavouriteWorkflows: {
|
|
10000
|
+
parameters: {};
|
|
10001
|
+
responses: {
|
|
10002
|
+
/** successful operation */
|
|
10003
|
+
200: {
|
|
10004
|
+
content: {
|
|
10005
|
+
"application/json": components["schemas"]["ListFavouriteWorkflowsOutput"];
|
|
10006
|
+
};
|
|
10007
|
+
};
|
|
10008
|
+
};
|
|
10009
|
+
requestBody: {
|
|
10010
|
+
content: {
|
|
10011
|
+
"application/json": components["schemas"]["ListFavouriteWorkflowsInput"];
|
|
10012
|
+
};
|
|
10013
|
+
};
|
|
10014
|
+
};
|
|
10015
|
+
UpdateFavouriteWorkflow: {
|
|
10016
|
+
parameters: {
|
|
10017
|
+
path: {
|
|
10018
|
+
/** ID of favouriteworkflow */
|
|
10019
|
+
favouriteworkflow_id: string;
|
|
10020
|
+
};
|
|
10021
|
+
};
|
|
10022
|
+
responses: {
|
|
10023
|
+
/** successful operation */
|
|
10024
|
+
200: {
|
|
10025
|
+
content: {
|
|
10026
|
+
"application/json": components["schemas"]["UpdateFavouriteWorkflowOutput"];
|
|
10027
|
+
};
|
|
10028
|
+
};
|
|
10029
|
+
};
|
|
10030
|
+
requestBody: {
|
|
10031
|
+
content: {
|
|
10032
|
+
"application/json": components["schemas"]["UpdateFavouriteWorkflowInput"];
|
|
10033
|
+
};
|
|
10034
|
+
};
|
|
10035
|
+
};
|
|
9309
10036
|
}
|
|
9310
10037
|
export interface external {
|
|
9311
10038
|
}
|