chromadb 1.10.0 → 1.10.4

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.
@@ -405,10 +405,10 @@ declare class Collection {
405
405
  }
406
406
 
407
407
  /**
408
- * FastAPI
408
+ * Chroma
409
409
  *
410
410
  *
411
- * OpenAPI spec version: 0.1.0
411
+ * OpenAPI spec version: 0.5.6.dev52
412
412
  *
413
413
  *
414
414
  * NOTE: This class is auto generated by OpenAPI Generator+.
@@ -461,10 +461,10 @@ declare class Configuration {
461
461
  }
462
462
 
463
463
  /**
464
- * FastAPI
464
+ * Chroma
465
465
  *
466
466
  *
467
- * OpenAPI spec version: 0.1.0
467
+ * OpenAPI spec version: 0.5.6.dev52
468
468
  *
469
469
  *
470
470
  * NOTE: This class is auto generated by OpenAPI Generator+.
@@ -492,10 +492,10 @@ declare class BaseAPI {
492
492
  }
493
493
 
494
494
  /**
495
- * FastAPI
495
+ * Chroma
496
496
  *
497
497
  *
498
- * OpenAPI spec version: 0.1.0
498
+ * OpenAPI spec version: 0.5.6.dev52
499
499
  *
500
500
  *
501
501
  * NOTE: This class is auto generated by OpenAPI Generator+.
@@ -505,18 +505,18 @@ declare class BaseAPI {
505
505
  declare namespace Api {
506
506
  interface Add201Response {
507
507
  }
508
- interface AddEmbedding {
509
- embeddings?: (Api.AddEmbedding.Embedding[]) | null;
510
- metadatas?: ((Api.AddEmbedding.Metadatum | null)[]) | null;
508
+ interface AddRequest {
509
+ embeddings?: (Api.AddRequest.Embedding[]) | null;
510
+ metadatas?: ((Api.AddRequest.Metadatum | null)[]) | null;
511
511
  documents?: ((string | null)[]) | null;
512
512
  uris?: ((string | null)[]) | null;
513
513
  ids: string[];
514
514
  }
515
515
  /**
516
516
  * @export
517
- * @namespace AddEmbedding
517
+ * @namespace AddRequest
518
518
  */
519
- namespace AddEmbedding {
519
+ namespace AddRequest {
520
520
  interface Embedding {
521
521
  }
522
522
  interface Metadatum {
@@ -524,10 +524,69 @@ declare namespace Api {
524
524
  }
525
525
  interface AddV1201Response {
526
526
  }
527
+ interface AddV1Request {
528
+ embeddings?: (Api.AddV1Request.Embedding[]) | null;
529
+ metadatas?: ((Api.AddV1Request.Metadatum | null)[]) | null;
530
+ documents?: ((string | null)[]) | null;
531
+ uris?: ((string | null)[]) | null;
532
+ ids: string[];
533
+ }
534
+ /**
535
+ * @export
536
+ * @namespace AddV1Request
537
+ */
538
+ namespace AddV1Request {
539
+ interface Embedding {
540
+ }
541
+ interface Metadatum {
542
+ }
543
+ }
527
544
  interface ADelete200Response {
528
545
  }
546
+ interface ADeleteRequest {
547
+ ids?: (string[]) | null;
548
+ where?: Api.ADeleteRequest.Where | null;
549
+ 'where_document'?: Api.ADeleteRequest.WhereDocument | null;
550
+ }
551
+ /**
552
+ * @export
553
+ * @namespace ADeleteRequest
554
+ */
555
+ namespace ADeleteRequest {
556
+ interface Where {
557
+ }
558
+ interface WhereDocument {
559
+ }
560
+ }
529
561
  interface AGet200Response {
530
562
  }
563
+ interface AGetRequest {
564
+ ids?: (string[]) | null;
565
+ where?: Api.AGetRequest.Where | null;
566
+ 'where_document'?: Api.AGetRequest.WhereDocument | null;
567
+ sort?: string | null;
568
+ /**
569
+ * @type {number | null}
570
+ * @memberof AGetRequest
571
+ */
572
+ limit?: number | null;
573
+ /**
574
+ * @type {number | null}
575
+ * @memberof AGetRequest
576
+ */
577
+ offset?: number | null;
578
+ include?: Api.IncludeEnum[];
579
+ }
580
+ /**
581
+ * @export
582
+ * @namespace AGetRequest
583
+ */
584
+ namespace AGetRequest {
585
+ interface Where {
586
+ }
587
+ interface WhereDocument {
588
+ }
589
+ }
531
590
  interface Count200Response {
532
591
  }
533
592
  interface CountCollections200Response {
@@ -536,61 +595,85 @@ declare namespace Api {
536
595
  }
537
596
  interface CountV1200Response {
538
597
  }
539
- interface CreateCollection {
598
+ interface CreateCollection200Response {
599
+ }
600
+ interface CreateCollectionRequest {
540
601
  name: string;
541
- configuration?: Api.CreateCollection.Configuration | null;
542
- metadata?: Api.CreateCollection.Metadata | null;
602
+ configuration?: Api.CreateCollectionRequest.Configuration | null;
603
+ metadata?: Api.CreateCollectionRequest.Metadata | null;
543
604
  'get_or_create'?: boolean;
544
605
  }
545
606
  /**
546
607
  * @export
547
- * @namespace CreateCollection
608
+ * @namespace CreateCollectionRequest
548
609
  */
549
- namespace CreateCollection {
610
+ namespace CreateCollectionRequest {
550
611
  interface Configuration {
551
612
  }
552
613
  interface Metadata {
553
614
  }
554
615
  }
555
- interface CreateCollection200Response {
556
- }
557
616
  interface CreateCollectionV1200Response {
558
617
  }
559
- interface CreateDatabase {
618
+ interface CreateCollectionV1Request {
560
619
  name: string;
620
+ configuration?: Api.CreateCollectionV1Request.Configuration | null;
621
+ metadata?: Api.CreateCollectionV1Request.Metadata | null;
622
+ 'get_or_create'?: boolean;
623
+ }
624
+ /**
625
+ * @export
626
+ * @namespace CreateCollectionV1Request
627
+ */
628
+ namespace CreateCollectionV1Request {
629
+ interface Configuration {
630
+ }
631
+ interface Metadata {
632
+ }
561
633
  }
562
634
  interface CreateDatabase200Response {
563
635
  }
636
+ interface CreateDatabaseRequest {
637
+ name: string;
638
+ }
564
639
  interface CreateDatabaseV1200Response {
565
640
  }
566
- interface CreateTenant {
641
+ interface CreateDatabaseV1Request {
567
642
  name: string;
568
643
  }
569
644
  interface CreateTenant200Response {
570
645
  }
646
+ interface CreateTenantRequest {
647
+ name: string;
648
+ }
571
649
  interface CreateTenantV1200Response {
572
650
  }
651
+ interface CreateTenantV1Request {
652
+ name: string;
653
+ }
573
654
  interface DeleteCollection200Response {
574
655
  }
575
656
  interface DeleteCollectionV1200Response {
576
657
  }
577
- interface DeleteEmbedding {
658
+ interface DeleteDatabase200Response {
659
+ }
660
+ interface DeleteV1200Response {
661
+ }
662
+ interface DeleteV1Request {
578
663
  ids?: (string[]) | null;
579
- where?: Api.DeleteEmbedding.Where | null;
580
- 'where_document'?: Api.DeleteEmbedding.WhereDocument | null;
664
+ where?: Api.DeleteV1Request.Where | null;
665
+ 'where_document'?: Api.DeleteV1Request.WhereDocument | null;
581
666
  }
582
667
  /**
583
668
  * @export
584
- * @namespace DeleteEmbedding
669
+ * @namespace DeleteV1Request
585
670
  */
586
- namespace DeleteEmbedding {
671
+ namespace DeleteV1Request {
587
672
  interface Where {
588
673
  }
589
674
  interface WhereDocument {
590
675
  }
591
676
  }
592
- interface DeleteV1200Response {
593
- }
594
677
  interface GetCollection200Response {
595
678
  }
596
679
  interface GetCollectionV1200Response {
@@ -599,37 +682,56 @@ declare namespace Api {
599
682
  }
600
683
  interface GetDatabaseV1200Response {
601
684
  }
602
- interface GetEmbedding {
603
- ids?: (string[]) | null;
604
- where?: Api.GetEmbedding.Where | null;
605
- 'where_document'?: Api.GetEmbedding.WhereDocument | null;
606
- sort?: string | null;
607
- /**
608
- * @type {number | null}
609
- * @memberof GetEmbedding
610
- */
611
- limit?: number | null;
685
+ interface GetNearestNeighbors200Response {
686
+ }
687
+ interface GetNearestNeighborsRequest {
688
+ where?: Api.GetNearestNeighborsRequest.Where | null;
689
+ 'where_document'?: Api.GetNearestNeighborsRequest.WhereDocument | null;
690
+ 'query_embeddings': Api.GetNearestNeighborsRequest.QueryEmbedding[];
612
691
  /**
613
- * @type {number | null}
614
- * @memberof GetEmbedding
692
+ * @type {number}
693
+ * @memberof GetNearestNeighborsRequest
615
694
  */
616
- offset?: number | null;
695
+ 'n_results'?: number;
617
696
  include?: Api.IncludeEnum[];
618
697
  }
619
698
  /**
620
699
  * @export
621
- * @namespace GetEmbedding
700
+ * @namespace GetNearestNeighborsRequest
622
701
  */
623
- namespace GetEmbedding {
702
+ namespace GetNearestNeighborsRequest {
624
703
  interface Where {
625
704
  }
626
705
  interface WhereDocument {
627
706
  }
628
- }
629
- interface GetNearestNeighbors200Response {
707
+ interface QueryEmbedding {
708
+ }
630
709
  }
631
710
  interface GetNearestNeighborsV1200Response {
632
711
  }
712
+ interface GetNearestNeighborsV1Request {
713
+ where?: Api.GetNearestNeighborsV1Request.Where | null;
714
+ 'where_document'?: Api.GetNearestNeighborsV1Request.WhereDocument | null;
715
+ 'query_embeddings': Api.GetNearestNeighborsV1Request.QueryEmbedding[];
716
+ /**
717
+ * @type {number}
718
+ * @memberof GetNearestNeighborsV1Request
719
+ */
720
+ 'n_results'?: number;
721
+ include?: Api.IncludeEnum[];
722
+ }
723
+ /**
724
+ * @export
725
+ * @namespace GetNearestNeighborsV1Request
726
+ */
727
+ namespace GetNearestNeighborsV1Request {
728
+ interface Where {
729
+ }
730
+ interface WhereDocument {
731
+ }
732
+ interface QueryEmbedding {
733
+ }
734
+ }
633
735
  interface GetTenant200Response {
634
736
  }
635
737
  interface GetTenantV1200Response {
@@ -638,6 +740,33 @@ declare namespace Api {
638
740
  }
639
741
  interface GetV1200Response {
640
742
  }
743
+ interface GetV1Request {
744
+ ids?: (string[]) | null;
745
+ where?: Api.GetV1Request.Where | null;
746
+ 'where_document'?: Api.GetV1Request.WhereDocument | null;
747
+ sort?: string | null;
748
+ /**
749
+ * @type {number | null}
750
+ * @memberof GetV1Request
751
+ */
752
+ limit?: number | null;
753
+ /**
754
+ * @type {number | null}
755
+ * @memberof GetV1Request
756
+ */
757
+ offset?: number | null;
758
+ include?: Api.IncludeEnum[];
759
+ }
760
+ /**
761
+ * @export
762
+ * @namespace GetV1Request
763
+ */
764
+ namespace GetV1Request {
765
+ interface Where {
766
+ }
767
+ interface WhereDocument {
768
+ }
769
+ }
641
770
  interface HTTPValidationError {
642
771
  detail?: Api.ValidationError[];
643
772
  }
@@ -653,63 +782,54 @@ declare namespace Api {
653
782
  }
654
783
  interface ListCollectionsV1200Response {
655
784
  }
785
+ interface ListDatabases200Response {
786
+ }
656
787
  interface PreFlightChecks200Response {
657
788
  }
658
789
  interface PreFlightChecks200Response2 {
659
790
  }
660
- interface QueryEmbedding {
661
- where?: Api.QueryEmbedding.Where | null;
662
- 'where_document'?: Api.QueryEmbedding.WhereDocument | null;
663
- 'query_embeddings': Api.QueryEmbedding.QueryEmbedding2[];
664
- /**
665
- * @type {number}
666
- * @memberof QueryEmbedding
667
- */
668
- 'n_results'?: number;
669
- include?: Api.IncludeEnum[];
791
+ interface Update200Response {
792
+ }
793
+ interface UpdateCollection200Response {
794
+ }
795
+ interface UpdateCollectionRequest {
796
+ 'new_name'?: string | null;
797
+ 'new_metadata'?: Api.UpdateCollectionRequest.NewMetadata | null;
670
798
  }
671
799
  /**
672
800
  * @export
673
- * @namespace QueryEmbedding
801
+ * @namespace UpdateCollectionRequest
674
802
  */
675
- namespace QueryEmbedding {
676
- interface Where {
677
- }
678
- interface WhereDocument {
679
- }
680
- interface QueryEmbedding2 {
803
+ namespace UpdateCollectionRequest {
804
+ interface NewMetadata {
681
805
  }
682
806
  }
683
- interface Update200Response {
807
+ interface UpdateCollectionV1200Response {
684
808
  }
685
- interface UpdateCollection {
809
+ interface UpdateCollectionV1Request {
686
810
  'new_name'?: string | null;
687
- 'new_metadata'?: Api.UpdateCollection.NewMetadata | null;
811
+ 'new_metadata'?: Api.UpdateCollectionV1Request.NewMetadata | null;
688
812
  }
689
813
  /**
690
814
  * @export
691
- * @namespace UpdateCollection
815
+ * @namespace UpdateCollectionV1Request
692
816
  */
693
- namespace UpdateCollection {
817
+ namespace UpdateCollectionV1Request {
694
818
  interface NewMetadata {
695
819
  }
696
820
  }
697
- interface UpdateCollection200Response {
698
- }
699
- interface UpdateCollectionV1200Response {
700
- }
701
- interface UpdateEmbedding {
702
- embeddings?: (Api.UpdateEmbedding.Embedding[]) | null;
703
- metadatas?: ((Api.UpdateEmbedding.Metadatum | null)[]) | null;
821
+ interface UpdateRequest {
822
+ embeddings?: (Api.UpdateRequest.Embedding[]) | null;
823
+ metadatas?: ((Api.UpdateRequest.Metadatum | null)[]) | null;
704
824
  documents?: ((string | null)[]) | null;
705
825
  uris?: ((string | null)[]) | null;
706
826
  ids: string[];
707
827
  }
708
828
  /**
709
829
  * @export
710
- * @namespace UpdateEmbedding
830
+ * @namespace UpdateRequest
711
831
  */
712
- namespace UpdateEmbedding {
832
+ namespace UpdateRequest {
713
833
  interface Embedding {
714
834
  }
715
835
  interface Metadatum {
@@ -717,10 +837,61 @@ declare namespace Api {
717
837
  }
718
838
  interface UpdateV1200Response {
719
839
  }
840
+ interface UpdateV1Request {
841
+ embeddings?: (Api.UpdateV1Request.Embedding[]) | null;
842
+ metadatas?: ((Api.UpdateV1Request.Metadatum | null)[]) | null;
843
+ documents?: ((string | null)[]) | null;
844
+ uris?: ((string | null)[]) | null;
845
+ ids: string[];
846
+ }
847
+ /**
848
+ * @export
849
+ * @namespace UpdateV1Request
850
+ */
851
+ namespace UpdateV1Request {
852
+ interface Embedding {
853
+ }
854
+ interface Metadatum {
855
+ }
856
+ }
720
857
  interface Upsert200Response {
721
858
  }
859
+ interface UpsertRequest {
860
+ embeddings?: (Api.UpsertRequest.Embedding[]) | null;
861
+ metadatas?: ((Api.UpsertRequest.Metadatum | null)[]) | null;
862
+ documents?: ((string | null)[]) | null;
863
+ uris?: ((string | null)[]) | null;
864
+ ids: string[];
865
+ }
866
+ /**
867
+ * @export
868
+ * @namespace UpsertRequest
869
+ */
870
+ namespace UpsertRequest {
871
+ interface Embedding {
872
+ }
873
+ interface Metadatum {
874
+ }
875
+ }
722
876
  interface UpsertV1200Response {
723
877
  }
878
+ interface UpsertV1Request {
879
+ embeddings?: (Api.UpsertV1Request.Embedding[]) | null;
880
+ metadatas?: ((Api.UpsertV1Request.Metadatum | null)[]) | null;
881
+ documents?: ((string | null)[]) | null;
882
+ uris?: ((string | null)[]) | null;
883
+ ids: string[];
884
+ }
885
+ /**
886
+ * @export
887
+ * @namespace UpsertV1Request
888
+ */
889
+ namespace UpsertV1Request {
890
+ interface Embedding {
891
+ }
892
+ interface Metadatum {
893
+ }
894
+ }
724
895
  interface ValidationError {
725
896
  loc: (string | number)[];
726
897
  msg: string;
@@ -729,10 +900,10 @@ declare namespace Api {
729
900
  }
730
901
 
731
902
  /**
732
- * FastAPI
903
+ * Chroma
733
904
  *
734
905
  *
735
- * OpenAPI spec version: 0.1.0
906
+ * OpenAPI spec version: 0.5.6.dev52
736
907
  *
737
908
  *
738
909
  * NOTE: This class is auto generated by OpenAPI Generator+.
@@ -752,39 +923,39 @@ declare class ApiApi extends BaseAPI {
752
923
  * @param {string} tenant
753
924
  * @param {string} databaseName
754
925
  * @param {string} collectionId
755
- * @param {Api.AddEmbedding} request
926
+ * @param {Api.AddRequest} request
756
927
  * @param {RequestInit} [options] Override http request option.
757
928
  * @throws {RequiredError}
758
929
  */
759
- add(tenant: string, databaseName: string, collectionId: string, request: Api.AddEmbedding, options?: RequestInit): Promise<Api.Add201Response>;
930
+ add(tenant: string, databaseName: string, collectionId: string, request: Api.AddRequest, options?: RequestInit): Promise<Api.Add201Response>;
760
931
  /**
761
932
  * @summary Add V1
762
933
  * @param {string} collectionId
763
- * @param {Api.AddEmbedding} request
934
+ * @param {Api.AddV1Request} request
764
935
  * @param {RequestInit} [options] Override http request option.
765
936
  * @throws {RequiredError}
766
937
  */
767
- addV1(collectionId: string, request: Api.AddEmbedding, options?: RequestInit): Promise<Api.AddV1201Response>;
938
+ addV1(collectionId: string, request: Api.AddV1Request, options?: RequestInit): Promise<Api.AddV1201Response>;
768
939
  /**
769
940
  * @summary Delete
770
941
  * @param {string} collectionId
771
942
  * @param {string} tenant
772
943
  * @param {string} databaseName
773
- * @param {Api.DeleteEmbedding} request
944
+ * @param {Api.ADeleteRequest} request
774
945
  * @param {RequestInit} [options] Override http request option.
775
946
  * @throws {RequiredError}
776
947
  */
777
- aDelete(collectionId: string, tenant: string, databaseName: string, request: Api.DeleteEmbedding, options?: RequestInit): Promise<Api.ADelete200Response>;
948
+ aDelete(collectionId: string, tenant: string, databaseName: string, request: Api.ADeleteRequest, options?: RequestInit): Promise<Api.ADelete200Response>;
778
949
  /**
779
950
  * @summary Get
780
951
  * @param {string} collectionId
781
952
  * @param {string} tenant
782
953
  * @param {string} databaseName
783
- * @param {Api.GetEmbedding} request
954
+ * @param {Api.AGetRequest} request
784
955
  * @param {RequestInit} [options] Override http request option.
785
956
  * @throws {RequiredError}
786
957
  */
787
- aGet(collectionId: string, tenant: string, databaseName: string, request: Api.GetEmbedding, options?: RequestInit): Promise<Api.AGet200Response>;
958
+ aGet(collectionId: string, tenant: string, databaseName: string, request: Api.AGetRequest, options?: RequestInit): Promise<Api.AGet200Response>;
788
959
  /**
789
960
  * @summary Count
790
961
  * @param {string} tenant
@@ -821,50 +992,50 @@ declare class ApiApi extends BaseAPI {
821
992
  * @summary Create Collection
822
993
  * @param {string} tenant
823
994
  * @param {string} databaseName
824
- * @param {Api.CreateCollection} request
995
+ * @param {Api.CreateCollectionRequest} request
825
996
  * @param {RequestInit} [options] Override http request option.
826
997
  * @throws {RequiredError}
827
998
  */
828
- createCollection(tenant: string, databaseName: string, request: Api.CreateCollection, options?: RequestInit): Promise<Api.CreateCollection200Response>;
999
+ createCollection(tenant: string, databaseName: string, request: Api.CreateCollectionRequest, options?: RequestInit): Promise<Api.CreateCollection200Response>;
829
1000
  /**
830
1001
  * @summary Create Collection V1
831
1002
  * @param {string} [tenant]
832
1003
  * @param {string} [database]
833
- * @param {Api.CreateCollection} request
1004
+ * @param {Api.CreateCollectionV1Request} request
834
1005
  * @param {RequestInit} [options] Override http request option.
835
1006
  * @throws {RequiredError}
836
1007
  */
837
- createCollectionV1(tenant: string | undefined, database: string | undefined, request: Api.CreateCollection, options?: RequestInit): Promise<Api.CreateCollectionV1200Response>;
1008
+ createCollectionV1(tenant: string | undefined, database: string | undefined, request: Api.CreateCollectionV1Request, options?: RequestInit): Promise<Api.CreateCollectionV1200Response>;
838
1009
  /**
839
1010
  * @summary Create Database
840
1011
  * @param {string} tenant
841
- * @param {Api.CreateDatabase} request
1012
+ * @param {Api.CreateDatabaseRequest} request
842
1013
  * @param {RequestInit} [options] Override http request option.
843
1014
  * @throws {RequiredError}
844
1015
  */
845
- createDatabase(tenant: string, request: Api.CreateDatabase, options?: RequestInit): Promise<Api.CreateDatabase200Response>;
1016
+ createDatabase(tenant: string, request: Api.CreateDatabaseRequest, options?: RequestInit): Promise<Api.CreateDatabase200Response>;
846
1017
  /**
847
1018
  * @summary Create Database V1
848
1019
  * @param {string} [tenant]
849
- * @param {Api.CreateDatabase} request
1020
+ * @param {Api.CreateDatabaseV1Request} request
850
1021
  * @param {RequestInit} [options] Override http request option.
851
1022
  * @throws {RequiredError}
852
1023
  */
853
- createDatabaseV1(tenant: string | undefined, request: Api.CreateDatabase, options?: RequestInit): Promise<Api.CreateDatabaseV1200Response>;
1024
+ createDatabaseV1(tenant: string | undefined, request: Api.CreateDatabaseV1Request, options?: RequestInit): Promise<Api.CreateDatabaseV1200Response>;
854
1025
  /**
855
1026
  * @summary Create Tenant
856
- * @param {Api.CreateTenant} request
1027
+ * @param {Api.CreateTenantRequest} request
857
1028
  * @param {RequestInit} [options] Override http request option.
858
1029
  * @throws {RequiredError}
859
1030
  */
860
- createTenant(request: Api.CreateTenant, options?: RequestInit): Promise<Api.CreateTenant200Response>;
1031
+ createTenant(request: Api.CreateTenantRequest, options?: RequestInit): Promise<Api.CreateTenant200Response>;
861
1032
  /**
862
1033
  * @summary Create Tenant V1
863
- * @param {Api.CreateTenant} request
1034
+ * @param {Api.CreateTenantV1Request} request
864
1035
  * @param {RequestInit} [options] Override http request option.
865
1036
  * @throws {RequiredError}
866
1037
  */
867
- createTenantV1(request: Api.CreateTenant, options?: RequestInit): Promise<Api.CreateTenantV1200Response>;
1038
+ createTenantV1(request: Api.CreateTenantV1Request, options?: RequestInit): Promise<Api.CreateTenantV1200Response>;
868
1039
  /**
869
1040
  * @summary Delete Collection
870
1041
  * @param {string} collectionName
@@ -883,14 +1054,22 @@ declare class ApiApi extends BaseAPI {
883
1054
  * @throws {RequiredError}
884
1055
  */
885
1056
  deleteCollectionV1(collectionName: string, tenant: string | undefined, database: string | undefined, options?: RequestInit): Promise<Api.DeleteCollectionV1200Response>;
1057
+ /**
1058
+ * @summary Delete Database
1059
+ * @param {string} databaseName
1060
+ * @param {string} tenant
1061
+ * @param {RequestInit} [options] Override http request option.
1062
+ * @throws {RequiredError}
1063
+ */
1064
+ deleteDatabase(databaseName: string, tenant: string, options?: RequestInit): Promise<Api.DeleteDatabase200Response>;
886
1065
  /**
887
1066
  * @summary Delete V1
888
1067
  * @param {string} collectionId
889
- * @param {Api.DeleteEmbedding} request
1068
+ * @param {Api.DeleteV1Request} request
890
1069
  * @param {RequestInit} [options] Override http request option.
891
1070
  * @throws {RequiredError}
892
1071
  */
893
- deleteV1(collectionId: string, request: Api.DeleteEmbedding, options?: RequestInit): Promise<Api.DeleteV1200Response>;
1072
+ deleteV1(collectionId: string, request: Api.DeleteV1Request, options?: RequestInit): Promise<Api.DeleteV1200Response>;
894
1073
  /**
895
1074
  * @summary Get Collection
896
1075
  * @param {string} tenant
@@ -930,19 +1109,19 @@ declare class ApiApi extends BaseAPI {
930
1109
  * @param {string} tenant
931
1110
  * @param {string} databaseName
932
1111
  * @param {string} collectionId
933
- * @param {Api.QueryEmbedding} request
1112
+ * @param {Api.GetNearestNeighborsRequest} request
934
1113
  * @param {RequestInit} [options] Override http request option.
935
1114
  * @throws {RequiredError}
936
1115
  */
937
- getNearestNeighbors(tenant: string, databaseName: string, collectionId: string, request: Api.QueryEmbedding, options?: RequestInit): Promise<Api.GetNearestNeighbors200Response>;
1116
+ getNearestNeighbors(tenant: string, databaseName: string, collectionId: string, request: Api.GetNearestNeighborsRequest, options?: RequestInit): Promise<Api.GetNearestNeighbors200Response>;
938
1117
  /**
939
1118
  * @summary Get Nearest Neighbors V1
940
1119
  * @param {string} collectionId
941
- * @param {Api.QueryEmbedding} request
1120
+ * @param {Api.GetNearestNeighborsV1Request} request
942
1121
  * @param {RequestInit} [options] Override http request option.
943
1122
  * @throws {RequiredError}
944
1123
  */
945
- getNearestNeighborsV1(collectionId: string, request: Api.QueryEmbedding, options?: RequestInit): Promise<Api.GetNearestNeighborsV1200Response>;
1124
+ getNearestNeighborsV1(collectionId: string, request: Api.GetNearestNeighborsV1Request, options?: RequestInit): Promise<Api.GetNearestNeighborsV1200Response>;
946
1125
  /**
947
1126
  * @summary Get Tenant
948
1127
  * @param {string} tenant
@@ -974,11 +1153,11 @@ declare class ApiApi extends BaseAPI {
974
1153
  /**
975
1154
  * @summary Get V1
976
1155
  * @param {string} collectionId
977
- * @param {Api.GetEmbedding} request
1156
+ * @param {Api.GetV1Request} request
978
1157
  * @param {RequestInit} [options] Override http request option.
979
1158
  * @throws {RequiredError}
980
1159
  */
981
- getV12(collectionId: string, request: Api.GetEmbedding, options?: RequestInit): Promise<Api.GetV1200Response>;
1160
+ getV12(collectionId: string, request: Api.GetV1Request, options?: RequestInit): Promise<Api.GetV1200Response>;
982
1161
  /**
983
1162
  * @summary Heartbeat
984
1163
  * @param {RequestInit} [options] Override http request option.
@@ -992,7 +1171,7 @@ declare class ApiApi extends BaseAPI {
992
1171
  * @param {RequestInit} [options] Override http request option.
993
1172
  * @throws {RequiredError}
994
1173
  */
995
- getV1PreFlightChecks(options?: RequestInit): Promise<Api.PreFlightChecks200Response2>;
1174
+ getV1PreFlightChecks(options?: RequestInit): Promise<Api.PreFlightChecks200Response>;
996
1175
  /**
997
1176
  * @summary Version
998
1177
  * @param {RequestInit} [options] Override http request option.
@@ -1020,7 +1199,7 @@ declare class ApiApi extends BaseAPI {
1020
1199
  * @param {RequestInit} [options] Override http request option.
1021
1200
  * @throws {RequiredError}
1022
1201
  */
1023
- getV2PreFlightChecks(options?: RequestInit): Promise<Api.PreFlightChecks200Response>;
1202
+ getV2PreFlightChecks(options?: RequestInit): Promise<Api.PreFlightChecks200Response2>;
1024
1203
  /**
1025
1204
  * @summary Version
1026
1205
  * @param {RequestInit} [options] Override http request option.
@@ -1047,6 +1226,15 @@ declare class ApiApi extends BaseAPI {
1047
1226
  * @throws {RequiredError}
1048
1227
  */
1049
1228
  listCollectionsV1(limit: number | null | undefined, offset: number | null | undefined, tenant: string | undefined, database: string | undefined, options?: RequestInit): Promise<Api.ListCollectionsV1200Response>;
1229
+ /**
1230
+ * @summary List Databases
1231
+ * @param {string} tenant
1232
+ * @param {number | null} [limit]
1233
+ * @param {number | null} [offset]
1234
+ * @param {RequestInit} [options] Override http request option.
1235
+ * @throws {RequiredError}
1236
+ */
1237
+ listDatabases(tenant: string, limit: number | null | undefined, offset: number | null | undefined, options?: RequestInit): Promise<Api.ListDatabases200Response>;
1050
1238
  /**
1051
1239
  * @summary Reset
1052
1240
  * @param {RequestInit} [options] Override http request option.
@@ -1064,55 +1252,55 @@ declare class ApiApi extends BaseAPI {
1064
1252
  * @param {string} tenant
1065
1253
  * @param {string} databaseName
1066
1254
  * @param {string} collectionId
1067
- * @param {Api.UpdateEmbedding} request
1255
+ * @param {Api.UpdateRequest} request
1068
1256
  * @param {RequestInit} [options] Override http request option.
1069
1257
  * @throws {RequiredError}
1070
1258
  */
1071
- update(tenant: string, databaseName: string, collectionId: string, request: Api.UpdateEmbedding, options?: RequestInit): Promise<Api.Update200Response>;
1259
+ update(tenant: string, databaseName: string, collectionId: string, request: Api.UpdateRequest, options?: RequestInit): Promise<Api.Update200Response>;
1072
1260
  /**
1073
1261
  * @summary Update Collection
1074
1262
  * @param {string} tenant
1075
1263
  * @param {string} databaseName
1076
1264
  * @param {string} collectionId
1077
- * @param {Api.UpdateCollection} request
1265
+ * @param {Api.UpdateCollectionRequest} request
1078
1266
  * @param {RequestInit} [options] Override http request option.
1079
1267
  * @throws {RequiredError}
1080
1268
  */
1081
- updateCollection(tenant: string, databaseName: string, collectionId: string, request: Api.UpdateCollection, options?: RequestInit): Promise<Api.UpdateCollection200Response>;
1269
+ updateCollection(tenant: string, databaseName: string, collectionId: string, request: Api.UpdateCollectionRequest, options?: RequestInit): Promise<Api.UpdateCollection200Response>;
1082
1270
  /**
1083
1271
  * @summary Update Collection V1
1084
1272
  * @param {string} collectionId
1085
- * @param {Api.UpdateCollection} request
1273
+ * @param {Api.UpdateCollectionV1Request} request
1086
1274
  * @param {RequestInit} [options] Override http request option.
1087
1275
  * @throws {RequiredError}
1088
1276
  */
1089
- updateCollectionV1(collectionId: string, request: Api.UpdateCollection, options?: RequestInit): Promise<Api.UpdateCollectionV1200Response>;
1277
+ updateCollectionV1(collectionId: string, request: Api.UpdateCollectionV1Request, options?: RequestInit): Promise<Api.UpdateCollectionV1200Response>;
1090
1278
  /**
1091
1279
  * @summary Update V1
1092
1280
  * @param {string} collectionId
1093
- * @param {Api.UpdateEmbedding} request
1281
+ * @param {Api.UpdateV1Request} request
1094
1282
  * @param {RequestInit} [options] Override http request option.
1095
1283
  * @throws {RequiredError}
1096
1284
  */
1097
- updateV1(collectionId: string, request: Api.UpdateEmbedding, options?: RequestInit): Promise<Api.UpdateV1200Response>;
1285
+ updateV1(collectionId: string, request: Api.UpdateV1Request, options?: RequestInit): Promise<Api.UpdateV1200Response>;
1098
1286
  /**
1099
1287
  * @summary Upsert
1100
1288
  * @param {string} tenant
1101
1289
  * @param {string} databaseName
1102
1290
  * @param {string} collectionId
1103
- * @param {Api.AddEmbedding} request
1291
+ * @param {Api.UpsertRequest} request
1104
1292
  * @param {RequestInit} [options] Override http request option.
1105
1293
  * @throws {RequiredError}
1106
1294
  */
1107
- upsert(tenant: string, databaseName: string, collectionId: string, request: Api.AddEmbedding, options?: RequestInit): Promise<Api.Upsert200Response>;
1295
+ upsert(tenant: string, databaseName: string, collectionId: string, request: Api.UpsertRequest, options?: RequestInit): Promise<Api.Upsert200Response>;
1108
1296
  /**
1109
1297
  * @summary Upsert V1
1110
1298
  * @param {string} collectionId
1111
- * @param {Api.AddEmbedding} request
1299
+ * @param {Api.UpsertV1Request} request
1112
1300
  * @param {RequestInit} [options] Override http request option.
1113
1301
  * @throws {RequiredError}
1114
1302
  */
1115
- upsertV1(collectionId: string, request: Api.AddEmbedding, options?: RequestInit): Promise<Api.UpsertV1200Response>;
1303
+ upsertV1(collectionId: string, request: Api.UpsertV1Request, options?: RequestInit): Promise<Api.UpsertV1200Response>;
1116
1304
  }
1117
1305
 
1118
1306
  declare class ChromaClient {
@@ -1245,7 +1433,7 @@ declare class ChromaClient {
1245
1433
  */
1246
1434
  getOrCreateCollection({ name, metadata, embeddingFunction, }: GetOrCreateCollectionParams): Promise<Collection>;
1247
1435
  /**
1248
- * Lists all collections.
1436
+ * Get all collection names.
1249
1437
  *
1250
1438
  * @returns {Promise<string[]>} A promise that resolves to a list of collection names.
1251
1439
  * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
@@ -1261,6 +1449,26 @@ declare class ChromaClient {
1261
1449
  * ```
1262
1450
  */
1263
1451
  listCollections({ limit, offset }?: ListCollectionsParams): Promise<string[]>;
1452
+ /**
1453
+ * List collection names, IDs, and metadata.
1454
+ *
1455
+ * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
1456
+ * @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
1457
+ * @throws {Error} If there is an issue listing the collections.
1458
+ * @returns {Promise<{ name: string, id: string, metadata?: CollectionMetadata }[]>} A promise that resolves to a list of collection names, IDs, and metadata.
1459
+ *
1460
+ * @example
1461
+ * ```typescript
1462
+ * const collections = await client.listCollectionsAndMetadata({
1463
+ * limit: 10,
1464
+ * offset: 0,
1465
+ * });
1466
+ */
1467
+ listCollectionsAndMetadata({ limit, offset, }?: ListCollectionsParams): Promise<{
1468
+ name: string;
1469
+ id: string;
1470
+ metadata?: CollectionMetadata;
1471
+ }[]>;
1264
1472
  /**
1265
1473
  * Counts all collections.
1266
1474
  *
@@ -1310,6 +1518,8 @@ interface Tenant {
1310
1518
  name: string;
1311
1519
  }
1312
1520
  interface Database {
1521
+ id: string;
1522
+ tenant: string;
1313
1523
  name: string;
1314
1524
  }
1315
1525
  declare class AdminClient {
@@ -1440,7 +1650,9 @@ declare class AdminClient {
1440
1650
  createDatabase({ name, tenantName, }: {
1441
1651
  name: string;
1442
1652
  tenantName: string;
1443
- }): Promise<Database>;
1653
+ }): Promise<{
1654
+ name: string;
1655
+ }>;
1444
1656
  /**
1445
1657
  * Gets a database with the specified properties.
1446
1658
  *
@@ -1463,6 +1675,35 @@ declare class AdminClient {
1463
1675
  name: string;
1464
1676
  tenantName: string;
1465
1677
  }): Promise<Database>;
1678
+ /**
1679
+ * Deletes a database.
1680
+ *
1681
+ * @param {Object} params - The parameters for deleting a database.
1682
+ * @param {string} params.name - The name of the database.
1683
+ * @param {string} params.tenantName - The name of the tenant.
1684
+ *
1685
+ * @returns {Promise<void>} A promise that returns nothing.
1686
+ * @throws {Error} If there is an issue deleting the database.
1687
+ */
1688
+ deleteDatabase({ name, tenantName, }: {
1689
+ name: string;
1690
+ tenantName: string;
1691
+ }): Promise<void>;
1692
+ /**
1693
+ * Lists database for a specific tenant.
1694
+ *
1695
+ * @param {Object} params - The parameters for listing databases.
1696
+ * @param {number} [params.limit] - The maximum number of databases to return.
1697
+ * @param {number} [params.offset] - The number of databases to skip.
1698
+ *
1699
+ * @returns {Promise<Database[]>} A promise that resolves to a list of databases.
1700
+ * @throws {Error} If there is an issue listing the databases.
1701
+ */
1702
+ listDatabases({ limit, offset, tenantName, }: {
1703
+ limit?: number;
1704
+ offset?: number;
1705
+ tenantName: string;
1706
+ }): Promise<Database[]>;
1466
1707
  }
1467
1708
 
1468
1709
  interface CloudClientParams {
@@ -1614,4 +1855,70 @@ declare class OllamaEmbeddingFunction implements IEmbeddingFunction {
1614
1855
  generate(texts: string[]): Promise<number[][]>;
1615
1856
  }
1616
1857
 
1617
- export { AddRecordsParams, AdminClient, ChromaClient, ChromaClientParams, CloudClient, CohereEmbeddingFunction, Collection, CollectionMetadata, CollectionParams, CreateCollectionParams, DefaultEmbeddingFunction, DeleteCollectionParams, DeleteParams, Document, Documents, Embedding, Embeddings, GetCollectionParams, GetOrCreateCollectionParams, GetParams, GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, ID, IDs, IEmbeddingFunction, IncludeEnum, JinaEmbeddingFunction, ListCollectionsParams, Metadata, Metadatas, ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, PeekParams, QueryRecordsParams, QueryResponse, TransformersEmbeddingFunction, UpdateRecordsParams, UpsertRecordsParams, Where, WhereDocument };
1858
+ /**
1859
+ * This is a generic Chroma error.
1860
+ */
1861
+ declare class ChromaError extends Error {
1862
+ readonly cause?: unknown | undefined;
1863
+ constructor(name: string, message: string, cause?: unknown | undefined);
1864
+ }
1865
+ /**
1866
+ * Indicates that there was a problem with the connection to the Chroma server (e.g. the server is down or the client is not connected to the internet)
1867
+ */
1868
+ declare class ChromaConnectionError extends Error {
1869
+ readonly cause?: unknown | undefined;
1870
+ name: string;
1871
+ constructor(message: string, cause?: unknown | undefined);
1872
+ }
1873
+ /** Indicates that the server encountered an error while handling the request. */
1874
+ declare class ChromaServerError extends Error {
1875
+ readonly cause?: unknown | undefined;
1876
+ name: string;
1877
+ constructor(message: string, cause?: unknown | undefined);
1878
+ }
1879
+ /** Indicate that there was an issue with the request that the client made. */
1880
+ declare class ChromaClientError extends Error {
1881
+ readonly cause?: unknown | undefined;
1882
+ name: string;
1883
+ constructor(message: string, cause?: unknown | undefined);
1884
+ }
1885
+ /** The request lacked valid authentication. */
1886
+ declare class ChromaUnauthorizedError extends Error {
1887
+ readonly cause?: unknown | undefined;
1888
+ name: string;
1889
+ constructor(message: string, cause?: unknown | undefined);
1890
+ }
1891
+ /** The user does not have permission to access the requested resource. */
1892
+ declare class ChromaForbiddenError extends Error {
1893
+ readonly cause?: unknown | undefined;
1894
+ name: string;
1895
+ constructor(message: string, cause?: unknown | undefined);
1896
+ }
1897
+ declare class ChromaNotFoundError extends Error {
1898
+ readonly cause?: unknown | undefined;
1899
+ name: string;
1900
+ constructor(message: string, cause?: unknown | undefined);
1901
+ }
1902
+ declare class ChromaValueError extends Error {
1903
+ readonly cause?: unknown | undefined;
1904
+ name: string;
1905
+ constructor(message: string, cause?: unknown | undefined);
1906
+ }
1907
+ declare class InvalidCollectionError extends Error {
1908
+ readonly cause?: unknown | undefined;
1909
+ name: string;
1910
+ constructor(message: string, cause?: unknown | undefined);
1911
+ }
1912
+ declare class InvalidArgumentError extends Error {
1913
+ readonly cause?: unknown | undefined;
1914
+ name: string;
1915
+ constructor(message: string, cause?: unknown | undefined);
1916
+ }
1917
+ declare class ChromaUniqueError extends Error {
1918
+ readonly cause?: unknown | undefined;
1919
+ name: string;
1920
+ constructor(message: string, cause?: unknown | undefined);
1921
+ }
1922
+ declare function createErrorByType(type: string, message: string): InvalidCollectionError | InvalidArgumentError | undefined;
1923
+
1924
+ export { AddRecordsParams, AdminClient, ChromaClient, ChromaClientError, ChromaClientParams, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, CohereEmbeddingFunction, Collection, CollectionMetadata, CollectionParams, CreateCollectionParams, DefaultEmbeddingFunction, DeleteCollectionParams, DeleteParams, Document, Documents, Embedding, Embeddings, GetCollectionParams, GetOrCreateCollectionParams, GetParams, GetResponse, GoogleGenerativeAiEmbeddingFunction, HuggingFaceEmbeddingServerFunction, ID, IDs, IEmbeddingFunction, IncludeEnum, InvalidArgumentError, InvalidCollectionError, JinaEmbeddingFunction, ListCollectionsParams, Metadata, Metadatas, ModifyCollectionParams, OllamaEmbeddingFunction, OpenAIEmbeddingFunction, PeekParams, QueryRecordsParams, QueryResponse, TransformersEmbeddingFunction, UpdateRecordsParams, UpsertRecordsParams, Where, WhereDocument, createErrorByType };