chromadb 2.2.0 → 2.2.1

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.
@@ -36,7 +36,8 @@ declare enum IncludeEnum {
36
36
  Documents = "documents",
37
37
  Embeddings = "embeddings",
38
38
  Metadatas = "metadatas",
39
- Distances = "distances"
39
+ Distances = "distances",
40
+ Uris = "uris"
40
41
  }
41
42
  type Embedding = number[];
42
43
  type Embeddings = Embedding[];
@@ -98,7 +99,7 @@ interface CollectionParams {
98
99
  metadata: CollectionMetadata | undefined;
99
100
  embeddingFunction: IEmbeddingFunction;
100
101
  }
101
- type CollectionMetadata = Record<string, unknown>;
102
+ type CollectionMetadata = Record<string, boolean | number | string>;
102
103
  type ConfigOptions = {
103
104
  options?: RequestInit;
104
105
  };
@@ -299,7 +300,7 @@ declare class Collection {
299
300
  * limit: 10,
300
301
  * offset: 0,
301
302
  * include: ["embeddings", "metadatas", "documents"],
302
- * whereDocument: { $contains: "value" },
303
+ * whereDocument: { "$contains": "value" },
303
304
  * });
304
305
  * ```
305
306
  */
@@ -414,7 +415,7 @@ declare class Collection {
414
415
  }
415
416
 
416
417
  /**
417
- * Chroma
418
+ * chroma-frontend
418
419
  *
419
420
  *
420
421
  * OpenAPI spec version: 1.0.0
@@ -470,7 +471,7 @@ declare class Configuration {
470
471
  }
471
472
 
472
473
  /**
473
- * Chroma
474
+ * chroma-frontend
474
475
  *
475
476
  *
476
477
  * OpenAPI spec version: 1.0.0
@@ -501,7 +502,7 @@ declare class BaseAPI {
501
502
  }
502
503
 
503
504
  /**
504
- * Chroma
505
+ * chroma-frontend
505
506
  *
506
507
  *
507
508
  * OpenAPI spec version: 1.0.0
@@ -512,314 +513,391 @@ declare class BaseAPI {
512
513
  * Do not edit the class manually.
513
514
  */
514
515
  declare namespace Api {
515
- interface AddV1V1Request {
516
- embeddings?: (unknown[]) | null;
517
- metadatas?: ((Api.AddV1V1Request.Metadatum | null)[]) | null;
518
- documents?: ((string | null)[]) | null;
519
- uris?: ((string | null)[]) | null;
516
+ interface AddCollectionRecordsPayload {
517
+ documents?: (string | null)[] | null;
518
+ embeddings?: number[][] | null;
520
519
  ids: string[];
520
+ metadatas?: ({
521
+ [name: string]: boolean | number | number | string;
522
+ } | null)[] | null;
523
+ uris?: (string | null)[] | null;
521
524
  }
522
- /**
523
- * @export
524
- * @namespace AddV1V1Request
525
- */
526
- namespace AddV1V1Request {
527
- interface Metadatum {
528
- }
529
- }
530
- interface AddV2Request {
531
- embeddings?: (unknown[]) | null;
532
- metadatas?: ((Api.AddV2Request.Metadatum | null)[]) | null;
533
- documents?: ((string | null)[]) | null;
534
- uris?: ((string | null)[]) | null;
535
- ids: string[];
525
+ interface AddCollectionRecordsResponse {
536
526
  }
537
- /**
538
- * @export
539
- * @namespace AddV2Request
540
- */
541
- namespace AddV2Request {
542
- interface Metadatum {
543
- }
527
+ interface ChecklistResponse {
528
+ /**
529
+ * @type {number}
530
+ * @memberof ChecklistResponse
531
+ * minimum: 0
532
+ */
533
+ max_batch_size: number;
544
534
  }
545
- interface CreateCollectionV1V1Request {
535
+ interface Collection {
536
+ database: string;
537
+ /**
538
+ * @type {number | null}
539
+ * @memberof Collection
540
+ */
541
+ dimension?: number | null;
542
+ /**
543
+ * @description <p>CollectionUuid is a wrapper around Uuid to provide a type for the collection id.</p>
544
+ * @type {string}
545
+ * @memberof Collection
546
+ */
547
+ id: string;
548
+ /**
549
+ * @type {number}
550
+ * @memberof Collection
551
+ */
552
+ log_position: number;
553
+ metadata?: {
554
+ [name: string]: boolean | number | number | string;
555
+ } | null;
546
556
  name: string;
547
- configuration?: Api.CreateCollectionV1V1Request.Configuration | null;
548
- metadata?: Api.CreateCollectionV1V1Request.Metadata | null;
549
- 'get_or_create'?: boolean;
557
+ tenant: string;
558
+ /**
559
+ * @type {number}
560
+ * @memberof Collection
561
+ */
562
+ version: number;
550
563
  }
551
- /**
552
- * @export
553
- * @namespace CreateCollectionV1V1Request
554
- */
555
- namespace CreateCollectionV1V1Request {
556
- interface Configuration {
557
- }
558
- interface Metadata {
559
- }
564
+ interface CollectionConfiguration {
565
+ embedding_function?: Api.EmbeddingFunctionConfiguration | null;
566
+ hnsw?: Api.HnswConfiguration | null;
567
+ spann?: Api.SpannConfiguration | null;
560
568
  }
561
- interface CreateCollectionV2Request {
569
+ interface CreateCollectionPayload {
570
+ configuration?: Api.CollectionConfiguration | null;
571
+ get_or_create?: boolean;
572
+ metadata?: {
573
+ [name: string]: boolean | number | number | string;
574
+ } | null;
562
575
  name: string;
563
- configuration?: Api.CreateCollectionV2Request.Configuration | null;
564
- metadata?: Api.CreateCollectionV2Request.Metadata | null;
565
- 'get_or_create'?: boolean;
566
576
  }
567
- /**
568
- * @export
569
- * @namespace CreateCollectionV2Request
570
- */
571
- namespace CreateCollectionV2Request {
572
- interface Configuration {
573
- }
574
- interface Metadata {
575
- }
576
- }
577
- interface CreateDatabaseV1V1Request {
577
+ interface CreateDatabasePayload {
578
578
  name: string;
579
579
  }
580
- interface CreateDatabaseV2Request {
581
- name: string;
580
+ interface CreateDatabaseResponse {
582
581
  }
583
- interface CreateTenantV1V1Request {
582
+ interface CreateTenantPayload {
584
583
  name: string;
585
584
  }
586
- interface CreateTenantV2Request {
585
+ interface CreateTenantResponse {
586
+ }
587
+ interface Database {
588
+ id: string;
587
589
  name: string;
590
+ tenant: string;
588
591
  }
589
- interface DeleteV1V1Request {
590
- ids?: (string[]) | null;
591
- where?: Api.DeleteV1V1Request.Where | null;
592
- 'where_document'?: Api.DeleteV1V1Request.WhereDocument | null;
592
+ interface DeleteCollectionRecordsPayload extends Api.RawWhereFields {
593
+ ids?: string[] | null;
593
594
  }
594
- /**
595
- * @export
596
- * @namespace DeleteV1V1Request
597
- */
598
- namespace DeleteV1V1Request {
599
- interface Where {
600
- }
601
- interface WhereDocument {
602
- }
595
+ interface DeleteCollectionRecordsResponse {
603
596
  }
604
- interface DeleteV2Request {
605
- ids?: (string[]) | null;
606
- where?: Api.DeleteV2Request.Where | null;
607
- 'where_document'?: Api.DeleteV2Request.WhereDocument | null;
597
+ interface DeleteDatabaseResponse {
608
598
  }
599
+ type EmbeddingFunctionConfiguration = Api.EmbeddingFunctionConfiguration.ObjectValue | Api.EmbeddingFunctionConfiguration.AllofValue;
609
600
  /**
610
601
  * @export
611
- * @namespace DeleteV2Request
602
+ * @namespace EmbeddingFunctionConfiguration
612
603
  */
613
- namespace DeleteV2Request {
614
- interface Where {
615
- }
616
- interface WhereDocument {
604
+ namespace EmbeddingFunctionConfiguration {
605
+ interface ObjectValue {
606
+ type: Api.EmbeddingFunctionConfiguration.ObjectValue.TypeEnum;
617
607
  }
618
- }
619
- interface GetNearestNeighborsV1V1Request {
620
- where?: Api.GetNearestNeighborsV1V1Request.Where | null;
621
- 'where_document'?: Api.GetNearestNeighborsV1V1Request.WhereDocument | null;
622
- 'query_embeddings': unknown[];
623
608
  /**
624
- * @type {number}
625
- * @memberof GetNearestNeighborsV1V1Request
609
+ * @export
610
+ * @namespace ObjectValue
626
611
  */
627
- 'n_results'?: number;
628
- include?: Api.IncludeEnum[];
629
- }
630
- /**
631
- * @export
632
- * @namespace GetNearestNeighborsV1V1Request
633
- */
634
- namespace GetNearestNeighborsV1V1Request {
635
- interface Where {
612
+ namespace ObjectValue {
613
+ enum TypeEnum {
614
+ Legacy = "legacy"
615
+ }
636
616
  }
637
- interface WhereDocument {
617
+ interface AllofValue extends Api.EmbeddingFunctionNewConfiguration {
618
+ type: Api.EmbeddingFunctionConfiguration.AllofValue.TypeEnum;
638
619
  }
639
- }
640
- interface GetNearestNeighborsV2Request {
641
- where?: Api.GetNearestNeighborsV2Request.Where | null;
642
- 'where_document'?: Api.GetNearestNeighborsV2Request.WhereDocument | null;
643
- 'query_embeddings': unknown[];
644
620
  /**
645
- * @type {number}
646
- * @memberof GetNearestNeighborsV2Request
621
+ * @export
622
+ * @namespace AllofValue
647
623
  */
648
- 'n_results'?: number;
649
- include?: Api.IncludeEnum[];
650
- }
651
- /**
652
- * @export
653
- * @namespace GetNearestNeighborsV2Request
654
- */
655
- namespace GetNearestNeighborsV2Request {
656
- interface Where {
657
- }
658
- interface WhereDocument {
624
+ namespace AllofValue {
625
+ enum TypeEnum {
626
+ Known = "known"
627
+ }
659
628
  }
660
629
  }
661
- interface GetV1V1Request {
662
- ids?: (string[]) | null;
663
- where?: Api.GetV1V1Request.Where | null;
664
- 'where_document'?: Api.GetV1V1Request.WhereDocument | null;
665
- sort?: string | null;
630
+ interface EmbeddingFunctionNewConfiguration {
631
+ config: unknown;
632
+ name: string;
633
+ }
634
+ interface ErrorResponse {
635
+ error: string;
636
+ message: string;
637
+ }
638
+ interface GetRequestPayload extends Api.RawWhereFields {
639
+ ids?: string[] | null;
640
+ include?: Api.Include[];
666
641
  /**
667
642
  * @type {number | null}
668
- * @memberof GetV1V1Request
643
+ * @memberof GetRequestPayload
644
+ * minimum: 0
669
645
  */
670
646
  limit?: number | null;
671
647
  /**
672
648
  * @type {number | null}
673
- * @memberof GetV1V1Request
649
+ * @memberof GetRequestPayload
650
+ * minimum: 0
674
651
  */
675
652
  offset?: number | null;
676
- include?: Api.IncludeEnum[];
677
653
  }
678
- /**
679
- * @export
680
- * @namespace GetV1V1Request
681
- */
682
- namespace GetV1V1Request {
683
- interface Where {
684
- }
685
- interface WhereDocument {
686
- }
654
+ interface GetResponse {
655
+ documents?: (string | null)[] | null;
656
+ embeddings?: number[][] | null;
657
+ ids: string[];
658
+ include: Api.Include[];
659
+ metadatas?: ({
660
+ [name: string]: boolean | number | number | string;
661
+ } | null)[] | null;
662
+ uris?: (string | null)[] | null;
687
663
  }
688
- interface GetV2Request {
689
- ids?: (string[]) | null;
690
- where?: Api.GetV2Request.Where | null;
691
- 'where_document'?: Api.GetV2Request.WhereDocument | null;
692
- sort?: string | null;
664
+ interface GetTenantResponse {
665
+ name: string;
666
+ }
667
+ interface GetUserIdentityResponse {
668
+ databases: string[];
669
+ tenant: string;
670
+ user_id: string;
671
+ }
672
+ interface HeartbeatResponse {
693
673
  /**
694
- * @type {number | null}
695
- * @memberof GetV2Request
674
+ * @type {number}
675
+ * @memberof HeartbeatResponse
676
+ * minimum: 0
696
677
  */
697
- limit?: number | null;
678
+ "nanosecond heartbeat": number;
679
+ }
680
+ interface HnswConfiguration {
698
681
  /**
699
- * @type {number | null}
700
- * @memberof GetV2Request
682
+ * @type {number}
683
+ * @memberof HnswConfiguration
684
+ * minimum: 0
701
685
  */
702
- offset?: number | null;
703
- include?: Api.IncludeEnum[];
704
- }
705
- /**
706
- * @export
707
- * @namespace GetV2Request
708
- */
709
- namespace GetV2Request {
710
- interface Where {
711
- }
712
- interface WhereDocument {
713
- }
686
+ batch_size?: number;
687
+ /**
688
+ * @type {number}
689
+ * @memberof HnswConfiguration
690
+ * minimum: 0
691
+ */
692
+ ef_construction?: number;
693
+ /**
694
+ * @type {number}
695
+ * @memberof HnswConfiguration
696
+ * minimum: 0
697
+ */
698
+ ef_search?: number;
699
+ /**
700
+ * @type {number}
701
+ * @memberof HnswConfiguration
702
+ * minimum: 0
703
+ */
704
+ max_neighbors?: number;
705
+ /**
706
+ * @type {number}
707
+ * @memberof HnswConfiguration
708
+ * minimum: 0
709
+ */
710
+ num_threads?: number;
711
+ /**
712
+ * @type {number}
713
+ * @memberof HnswConfiguration
714
+ */
715
+ resize_factor?: number;
716
+ space?: Api.HnswSpace;
717
+ /**
718
+ * @type {number}
719
+ * @memberof HnswConfiguration
720
+ * minimum: 0
721
+ */
722
+ sync_threshold?: number;
714
723
  }
715
- interface HTTPValidationError {
716
- detail?: Api.ValidationError[];
724
+ enum HnswSpace {
725
+ L2 = "l2",
726
+ Cosine = "cosine",
727
+ Ip = "ip"
717
728
  }
718
- enum IncludeEnum {
729
+ enum Include {
730
+ Distances = "distances",
719
731
  Documents = "documents",
720
732
  Embeddings = "embeddings",
721
733
  Metadatas = "metadatas",
722
- Distances = "distances",
723
- Uris = "uris",
724
- Data = "data"
725
- }
726
- interface PreFlightChecksV1200Response {
727
- }
728
- interface PreFlightChecksV2200Response {
734
+ Uris = "uris"
729
735
  }
730
- interface UpdateCollectionV1V1Request {
731
- 'new_name'?: string | null;
732
- 'new_metadata'?: Api.UpdateCollectionV1V1Request.NewMetadata | null;
736
+ interface QueryRequestPayload extends Api.RawWhereFields {
737
+ ids?: string[] | null;
738
+ include?: Api.Include[];
739
+ /**
740
+ * @type {number | null}
741
+ * @memberof QueryRequestPayload
742
+ * minimum: 0
743
+ */
744
+ n_results?: number | null;
745
+ query_embeddings: number[][];
733
746
  }
734
- /**
735
- * @export
736
- * @namespace UpdateCollectionV1V1Request
737
- */
738
- namespace UpdateCollectionV1V1Request {
739
- interface NewMetadata {
740
- }
747
+ interface QueryResponse {
748
+ distances?: (number | null)[][] | null;
749
+ documents?: (string | null)[][] | null;
750
+ embeddings?: (number[] | null)[][] | null;
751
+ ids: string[][];
752
+ include: Api.Include[];
753
+ metadatas?: ({
754
+ [name: string]: boolean | number | number | string;
755
+ } | null)[][] | null;
756
+ uris?: (string | null)[][] | null;
741
757
  }
742
- interface UpdateCollectionV2Request {
743
- 'new_name'?: string | null;
744
- 'new_metadata'?: Api.UpdateCollectionV2Request.NewMetadata | null;
758
+ interface RawWhereFields {
759
+ where?: unknown;
760
+ where_document?: unknown;
745
761
  }
746
- /**
747
- * @export
748
- * @namespace UpdateCollectionV2Request
749
- */
750
- namespace UpdateCollectionV2Request {
751
- interface NewMetadata {
752
- }
762
+ interface SpannConfiguration {
763
+ /**
764
+ * @type {number}
765
+ * @memberof SpannConfiguration
766
+ * minimum: 0
767
+ */
768
+ construction_ef: number;
769
+ /**
770
+ * @type {number}
771
+ * @memberof SpannConfiguration
772
+ * minimum: 0
773
+ */
774
+ m: number;
775
+ /**
776
+ * @type {number}
777
+ * @memberof SpannConfiguration
778
+ * minimum: 0
779
+ */
780
+ search_ef: number;
781
+ /**
782
+ * @type {number}
783
+ * @memberof SpannConfiguration
784
+ * minimum: 0
785
+ */
786
+ search_nprobe: number;
787
+ space: Api.HnswSpace;
788
+ /**
789
+ * @type {number}
790
+ * @memberof SpannConfiguration
791
+ * minimum: 0
792
+ */
793
+ write_nprobe: number;
753
794
  }
754
- interface UpdateV1V1Request {
755
- embeddings?: (unknown[]) | null;
756
- metadatas?: ((Api.UpdateV1V1Request.Metadatum | null)[]) | null;
757
- documents?: ((string | null)[]) | null;
758
- uris?: ((string | null)[]) | null;
759
- ids: string[];
795
+ interface UpdateCollectionConfiguration {
796
+ embedding_function?: Api.EmbeddingFunctionConfiguration | null;
797
+ hnsw?: Api.UpdateHnswConfiguration | null;
798
+ spann?: Api.SpannConfiguration | null;
760
799
  }
761
- /**
762
- * @export
763
- * @namespace UpdateV1V1Request
764
- */
765
- namespace UpdateV1V1Request {
766
- interface Metadatum {
767
- }
800
+ interface UpdateCollectionPayload {
801
+ new_configuration?: Api.UpdateCollectionConfiguration | null;
802
+ new_metadata?: {
803
+ [name: string]: boolean | number | number | string;
804
+ } | null;
805
+ new_name?: string | null;
768
806
  }
769
- interface UpdateV2Request {
770
- embeddings?: (unknown[]) | null;
771
- metadatas?: ((Api.UpdateV2Request.Metadatum | null)[]) | null;
772
- documents?: ((string | null)[]) | null;
773
- uris?: ((string | null)[]) | null;
807
+ interface UpdateCollectionRecordsPayload {
808
+ documents?: (string | null)[] | null;
809
+ embeddings?: (number[] | null)[] | null;
774
810
  ids: string[];
811
+ metadatas?: ({
812
+ [name: string]: boolean | number | number | string;
813
+ } | null)[] | null;
814
+ uris?: (string | null)[] | null;
775
815
  }
776
- /**
777
- * @export
778
- * @namespace UpdateV2Request
779
- */
780
- namespace UpdateV2Request {
781
- interface Metadatum {
782
- }
816
+ interface UpdateCollectionRecordsResponse {
783
817
  }
784
- interface UpsertV1V1Request {
785
- embeddings?: (unknown[]) | null;
786
- metadatas?: ((Api.UpsertV1V1Request.Metadatum | null)[]) | null;
787
- documents?: ((string | null)[]) | null;
788
- uris?: ((string | null)[]) | null;
789
- ids: string[];
818
+ interface UpdateCollectionResponse {
790
819
  }
791
- /**
792
- * @export
793
- * @namespace UpsertV1V1Request
794
- */
795
- namespace UpsertV1V1Request {
796
- interface Metadatum {
797
- }
820
+ interface UpdateHnswConfiguration {
821
+ /**
822
+ * @type {number | null}
823
+ * @memberof UpdateHnswConfiguration
824
+ * minimum: 0
825
+ */
826
+ batch_size?: number | null;
827
+ /**
828
+ * @type {number | null}
829
+ * @memberof UpdateHnswConfiguration
830
+ * minimum: 0
831
+ */
832
+ ef_search?: number | null;
833
+ /**
834
+ * @type {number | null}
835
+ * @memberof UpdateHnswConfiguration
836
+ * minimum: 0
837
+ */
838
+ max_neighbors?: number | null;
839
+ /**
840
+ * @type {number | null}
841
+ * @memberof UpdateHnswConfiguration
842
+ * minimum: 0
843
+ */
844
+ num_threads?: number | null;
845
+ /**
846
+ * @type {number | null}
847
+ * @memberof UpdateHnswConfiguration
848
+ */
849
+ resize_factor?: number | null;
850
+ /**
851
+ * @type {number | null}
852
+ * @memberof UpdateHnswConfiguration
853
+ * minimum: 0
854
+ */
855
+ sync_threshold?: number | null;
798
856
  }
799
- interface UpsertV2Request {
800
- embeddings?: (unknown[]) | null;
801
- metadatas?: ((Api.UpsertV2Request.Metadatum | null)[]) | null;
802
- documents?: ((string | null)[]) | null;
803
- uris?: ((string | null)[]) | null;
857
+ interface UpsertCollectionRecordsPayload {
858
+ documents?: (string | null)[] | null;
859
+ embeddings?: number[][] | null;
804
860
  ids: string[];
861
+ metadatas?: ({
862
+ [name: string]: boolean | number | number | string;
863
+ } | null)[] | null;
864
+ uris?: (string | null)[] | null;
805
865
  }
806
- /**
807
- * @export
808
- * @namespace UpsertV2Request
809
- */
810
- namespace UpsertV2Request {
811
- interface Metadatum {
812
- }
866
+ interface UpsertCollectionRecordsResponse {
813
867
  }
814
- interface ValidationError {
815
- loc: (string | number)[];
816
- msg: string;
817
- 'type': string;
868
+ interface Vec2 {
869
+ database: string;
870
+ /**
871
+ * @type {number | null}
872
+ * @memberof Vec2
873
+ */
874
+ dimension?: number | null;
875
+ /**
876
+ * @description <p>CollectionUuid is a wrapper around Uuid to provide a type for the collection id.</p>
877
+ * @type {string}
878
+ * @memberof Vec2
879
+ */
880
+ id: string;
881
+ /**
882
+ * @type {number}
883
+ * @memberof Vec2
884
+ */
885
+ log_position: number;
886
+ metadata?: {
887
+ [name: string]: boolean | number | number | string;
888
+ } | null;
889
+ name: string;
890
+ tenant: string;
891
+ /**
892
+ * @type {number}
893
+ * @memberof Vec2
894
+ */
895
+ version: number;
818
896
  }
819
897
  }
820
898
 
821
899
  /**
822
- * Chroma
900
+ * chroma-frontend
823
901
  *
824
902
  *
825
903
  * OpenAPI spec version: 1.0.0
@@ -838,388 +916,214 @@ declare namespace Api {
838
916
  */
839
917
  declare class ApiApi extends BaseAPI {
840
918
  /**
841
- * @summary Add V1
842
- * @param {string} collectionId
843
- * @param {Api.AddV1V1Request} request
844
- * @param {RequestInit} [options] Override http request option.
845
- * @throws {RequiredError}
846
- */
847
- addV1V1(collectionId: string, request: Api.AddV1V1Request, options?: RequestInit): Promise<unknown>;
848
- /**
849
- * @summary Add
850
- * @param {string} tenant
851
- * @param {string} databaseName
852
- * @param {string} collectionId
853
- * @param {Api.AddV2Request} request
854
- * @param {RequestInit} [options] Override http request option.
855
- * @throws {RequiredError}
856
- */
857
- addV2(tenant: string, databaseName: string, collectionId: string, request: Api.AddV2Request, options?: RequestInit): Promise<unknown>;
858
- /**
859
- * @summary Count Collections V1
860
- * @param {string} [tenant]
861
- * @param {string} [database]
862
- * @param {RequestInit} [options] Override http request option.
863
- * @throws {RequiredError}
864
- */
865
- countCollectionsV1V1(tenant: string | undefined, database: string | undefined, options?: RequestInit): Promise<unknown>;
866
- /**
867
- * @summary Count Collections
868
- * @param {string} tenant
869
- * @param {string} databaseName
870
- * @param {RequestInit} [options] Override http request option.
871
- * @throws {RequiredError}
872
- */
873
- countCollectionsV2(tenant: string, databaseName: string, options?: RequestInit): Promise<unknown>;
874
- /**
875
- * @summary Count V1
876
- * @param {string} collectionId
877
- * @param {RequestInit} [options] Override http request option.
878
- * @throws {RequiredError}
879
- */
880
- countV1V1(collectionId: string, options?: RequestInit): Promise<unknown>;
881
- /**
882
- * @summary Count
919
+ * @summary Adds records to a collection.
883
920
  * @param {string} tenant
884
- * @param {string} databaseName
921
+ * @param {string} database
885
922
  * @param {string} collectionId
923
+ * @param {Api.AddCollectionRecordsPayload} request
886
924
  * @param {RequestInit} [options] Override http request option.
887
925
  * @throws {RequiredError}
888
926
  */
889
- countV2(tenant: string, databaseName: string, collectionId: string, options?: RequestInit): Promise<unknown>;
890
- /**
891
- * @summary Create Collection V1
892
- * @param {string} [tenant]
893
- * @param {string} [database]
894
- * @param {Api.CreateCollectionV1V1Request} request
895
- * @param {RequestInit} [options] Override http request option.
896
- * @throws {RequiredError}
897
- */
898
- createCollectionV1V1(tenant: string | undefined, database: string | undefined, request: Api.CreateCollectionV1V1Request, options?: RequestInit): Promise<unknown>;
899
- /**
900
- * @summary Create Collection
901
- * @param {string} tenant
902
- * @param {string} databaseName
903
- * @param {Api.CreateCollectionV2Request} request
904
- * @param {RequestInit} [options] Override http request option.
905
- * @throws {RequiredError}
906
- */
907
- createCollectionV2(tenant: string, databaseName: string, request: Api.CreateCollectionV2Request, options?: RequestInit): Promise<unknown>;
908
- /**
909
- * @summary Create Database V1
910
- * @param {string} [tenant]
911
- * @param {Api.CreateDatabaseV1V1Request} request
912
- * @param {RequestInit} [options] Override http request option.
913
- * @throws {RequiredError}
914
- */
915
- createDatabaseV1V1(tenant: string | undefined, request: Api.CreateDatabaseV1V1Request, options?: RequestInit): Promise<unknown>;
916
- /**
917
- * @summary Create Database
918
- * @param {string} tenant
919
- * @param {Api.CreateDatabaseV2Request} request
920
- * @param {RequestInit} [options] Override http request option.
921
- * @throws {RequiredError}
922
- */
923
- createDatabaseV2(tenant: string, request: Api.CreateDatabaseV2Request, options?: RequestInit): Promise<unknown>;
924
- /**
925
- * @summary Create Tenant V1
926
- * @param {Api.CreateTenantV1V1Request} request
927
- * @param {RequestInit} [options] Override http request option.
928
- * @throws {RequiredError}
929
- */
930
- createTenantV1V1(request: Api.CreateTenantV1V1Request, options?: RequestInit): Promise<unknown>;
931
- /**
932
- * @summary Create Tenant
933
- * @param {Api.CreateTenantV2Request} request
934
- * @param {RequestInit} [options] Override http request option.
935
- * @throws {RequiredError}
936
- */
937
- createTenantV2(request: Api.CreateTenantV2Request, options?: RequestInit): Promise<unknown>;
938
- /**
939
- * @summary Delete Collection V1
940
- * @param {string} collectionName
941
- * @param {string} [tenant]
942
- * @param {string} [database]
943
- * @param {RequestInit} [options] Override http request option.
944
- * @throws {RequiredError}
945
- */
946
- deleteCollectionV1V1(collectionName: string, tenant: string | undefined, database: string | undefined, options?: RequestInit): Promise<unknown>;
947
- /**
948
- * @summary Delete Collection
949
- * @param {string} collectionName
950
- * @param {string} tenant
951
- * @param {string} databaseName
952
- * @param {RequestInit} [options] Override http request option.
953
- * @throws {RequiredError}
954
- */
955
- deleteCollectionV2(collectionName: string, tenant: string, databaseName: string, options?: RequestInit): Promise<unknown>;
927
+ collectionAdd(tenant: string, database: string, collectionId: string, request: Api.AddCollectionRecordsPayload, options?: RequestInit): Promise<Api.AddCollectionRecordsResponse>;
956
928
  /**
957
- * @summary Delete Database
958
- * @param {string} databaseName
959
- * @param {string} tenant
929
+ * @summary Retrieves the number of records in a collection.
930
+ * @param {string} tenant <p>Tenant ID for the collection</p>
931
+ * @param {string} database <p>Database containing this collection</p>
932
+ * @param {string} collectionId <p>Collection ID whose records are counted</p>
960
933
  * @param {RequestInit} [options] Override http request option.
961
934
  * @throws {RequiredError}
962
935
  */
963
- deleteDatabaseV2(databaseName: string, tenant: string, options?: RequestInit): Promise<unknown>;
936
+ collectionCount(tenant: string, database: string, collectionId: string, options?: RequestInit): Promise<number>;
964
937
  /**
965
- * @summary Delete V1
966
- * @param {string} collectionId
967
- * @param {Api.DeleteV1V1Request} request
938
+ * @summary Deletes records in a collection. Can filter by IDs or metadata.
939
+ * @param {string} tenant <p>Tenant ID</p>
940
+ * @param {string} database <p>Database name</p>
941
+ * @param {string} collectionId <p>Collection ID</p>
942
+ * @param {Api.DeleteCollectionRecordsPayload} request
968
943
  * @param {RequestInit} [options] Override http request option.
969
944
  * @throws {RequiredError}
970
945
  */
971
- deleteV1V1(collectionId: string, request: Api.DeleteV1V1Request, options?: RequestInit): Promise<unknown>;
946
+ collectionDelete(tenant: string, database: string, collectionId: string, request: Api.DeleteCollectionRecordsPayload, options?: RequestInit): Promise<Api.DeleteCollectionRecordsResponse>;
972
947
  /**
973
- * @summary Delete
974
- * @param {string} collectionId
975
- * @param {string} tenant
976
- * @param {string} databaseName
977
- * @param {Api.DeleteV2Request} request
948
+ * @summary Retrieves records from a collection by ID or metadata filter.
949
+ * @param {string} tenant <p>Tenant ID</p>
950
+ * @param {string} database <p>Database name for the collection</p>
951
+ * @param {string} collectionId <p>Collection ID to fetch records from</p>
952
+ * @param {Api.GetRequestPayload} request
978
953
  * @param {RequestInit} [options] Override http request option.
979
954
  * @throws {RequiredError}
980
955
  */
981
- deleteV2(collectionId: string, tenant: string, databaseName: string, request: Api.DeleteV2Request, options?: RequestInit): Promise<unknown>;
956
+ collectionGet(tenant: string, database: string, collectionId: string, request: Api.GetRequestPayload, options?: RequestInit): Promise<Api.GetResponse>;
982
957
  /**
983
- * @summary Get Collection V1
984
- * @param {string} collectionName
985
- * @param {string} [tenant]
986
- * @param {string} [database]
958
+ * @summary Query a collection in a variety of ways, including vector search, metadata filtering, and full-text search
959
+ * @param {string} tenant <p>Tenant ID</p>
960
+ * @param {string} database <p>Database name containing the collection</p>
961
+ * @param {string} collectionId <p>Collection ID to query</p>
962
+ * @param {number} [limit] <p>Limit for pagination</p>
963
+ * @param {number} [offset] <p>Offset for pagination</p>
964
+ * @param {Api.QueryRequestPayload} request
987
965
  * @param {RequestInit} [options] Override http request option.
988
966
  * @throws {RequiredError}
989
967
  */
990
- getCollectionV1V1(collectionName: string, tenant: string | undefined, database: string | undefined, options?: RequestInit): Promise<unknown>;
968
+ collectionQuery(tenant: string, database: string, collectionId: string, limit: number | undefined, offset: number | undefined, request: Api.QueryRequestPayload, options?: RequestInit): Promise<Api.QueryResponse>;
991
969
  /**
992
- * @summary Get Collection
970
+ * @summary Updates records in a collection by ID.
993
971
  * @param {string} tenant
994
- * @param {string} databaseName
995
- * @param {string} collectionName
996
- * @param {RequestInit} [options] Override http request option.
997
- * @throws {RequiredError}
998
- */
999
- getCollectionV2(tenant: string, databaseName: string, collectionName: string, options?: RequestInit): Promise<unknown>;
1000
- /**
1001
- * @summary Get Database V1
1002
972
  * @param {string} database
1003
- * @param {string} [tenant]
1004
- * @param {RequestInit} [options] Override http request option.
1005
- * @throws {RequiredError}
1006
- */
1007
- getDatabaseV1V1(database: string, tenant: string | undefined, options?: RequestInit): Promise<unknown>;
1008
- /**
1009
- * @summary Get Database
1010
- * @param {string} databaseName
1011
- * @param {string} tenant
1012
- * @param {RequestInit} [options] Override http request option.
1013
- * @throws {RequiredError}
1014
- */
1015
- getDatabaseV2(databaseName: string, tenant: string, options?: RequestInit): Promise<unknown>;
1016
- /**
1017
- * @summary Get Nearest Neighbors V1
1018
- * @param {string} collectionId
1019
- * @param {Api.GetNearestNeighborsV1V1Request} request
1020
- * @param {RequestInit} [options] Override http request option.
1021
- * @throws {RequiredError}
1022
- */
1023
- getNearestNeighborsV1V1(collectionId: string, request: Api.GetNearestNeighborsV1V1Request, options?: RequestInit): Promise<unknown>;
1024
- /**
1025
- * @summary Get Nearest Neighbors
1026
- * @param {string} tenant
1027
- * @param {string} databaseName
1028
- * @param {string} collectionId
1029
- * @param {Api.GetNearestNeighborsV2Request} request
1030
- * @param {RequestInit} [options] Override http request option.
1031
- * @throws {RequiredError}
1032
- */
1033
- getNearestNeighborsV2(tenant: string, databaseName: string, collectionId: string, request: Api.GetNearestNeighborsV2Request, options?: RequestInit): Promise<unknown>;
1034
- /**
1035
- * @summary Get Tenant V1
1036
- * @param {string} tenant
1037
- * @param {RequestInit} [options] Override http request option.
1038
- * @throws {RequiredError}
1039
- */
1040
- getTenantV1V1(tenant: string, options?: RequestInit): Promise<unknown>;
1041
- /**
1042
- * @summary Get Tenant
1043
- * @param {string} tenant
1044
- * @param {RequestInit} [options] Override http request option.
1045
- * @throws {RequiredError}
1046
- */
1047
- getTenantV2(tenant: string, options?: RequestInit): Promise<unknown>;
1048
- /**
1049
- * @summary Get User Identity
1050
- * @param {RequestInit} [options] Override http request option.
1051
- * @throws {RequiredError}
1052
- */
1053
- getUserIdentityV2(options?: RequestInit): Promise<unknown>;
1054
- /**
1055
- * @summary Get V1
1056
973
  * @param {string} collectionId
1057
- * @param {Api.GetV1V1Request} request
974
+ * @param {Api.UpdateCollectionRecordsPayload} request
1058
975
  * @param {RequestInit} [options] Override http request option.
1059
976
  * @throws {RequiredError}
1060
977
  */
1061
- getV1V1(collectionId: string, request: Api.GetV1V1Request, options?: RequestInit): Promise<unknown>;
978
+ collectionUpdate(tenant: string, database: string, collectionId: string, request: Api.UpdateCollectionRecordsPayload, options?: RequestInit): Promise<Api.UpdateCollectionRecordsResponse>;
1062
979
  /**
1063
- * @summary Get
1064
- * @param {string} collectionId
1065
- * @param {string} tenant
1066
- * @param {string} databaseName
1067
- * @param {Api.GetV2Request} request
980
+ * @summary Upserts records in a collection (create if not exists, otherwise update).
981
+ * @param {string} tenant <p>Tenant ID</p>
982
+ * @param {string} database <p>Database name</p>
983
+ * @param {string} collectionId <p>Collection ID</p>
984
+ * @param {Api.UpsertCollectionRecordsPayload} request
1068
985
  * @param {RequestInit} [options] Override http request option.
1069
986
  * @throws {RequiredError}
1070
987
  */
1071
- getV2(collectionId: string, tenant: string, databaseName: string, request: Api.GetV2Request, options?: RequestInit): Promise<unknown>;
988
+ collectionUpsert(tenant: string, database: string, collectionId: string, request: Api.UpsertCollectionRecordsPayload, options?: RequestInit): Promise<Api.UpsertCollectionRecordsResponse>;
1072
989
  /**
1073
- * @summary Heartbeat
990
+ * @summary Retrieves the total number of collections in a given database.
991
+ * @param {string} tenant <p>Tenant ID</p>
992
+ * @param {string} database <p>Database name to count collections from</p>
1074
993
  * @param {RequestInit} [options] Override http request option.
1075
994
  * @throws {RequiredError}
1076
995
  */
1077
- heartbeatV1(options?: RequestInit): Promise<{
1078
- [name: string]: number;
1079
- }>;
996
+ countCollections(tenant: string, database: string, options?: RequestInit): Promise<number>;
1080
997
  /**
1081
- * @summary Heartbeat
998
+ * @summary Creates a new collection under the specified database.
999
+ * @param {string} tenant <p>Tenant ID</p>
1000
+ * @param {string} database <p>Database name containing the new collection</p>
1001
+ * @param {Api.CreateCollectionPayload} request
1082
1002
  * @param {RequestInit} [options] Override http request option.
1083
1003
  * @throws {RequiredError}
1084
1004
  */
1085
- heartbeatV2(options?: RequestInit): Promise<{
1086
- [name: string]: number;
1087
- }>;
1005
+ createCollection(tenant: string, database: string, request: Api.CreateCollectionPayload, options?: RequestInit): Promise<Api.Collection>;
1088
1006
  /**
1089
- * @summary List Collections V1
1090
- * @param {number | null} [limit]
1091
- * @param {number | null} [offset]
1092
- * @param {string} [tenant]
1093
- * @param {string} [database]
1007
+ * @summary Creates a new database for a given tenant.
1008
+ * @param {string} tenant <p>Tenant ID to associate with the new database</p>
1009
+ * @param {Api.CreateDatabasePayload} request
1094
1010
  * @param {RequestInit} [options] Override http request option.
1095
1011
  * @throws {RequiredError}
1096
1012
  */
1097
- listCollectionsV1V1(limit: number | null | undefined, offset: number | null | undefined, tenant: string | undefined, database: string | undefined, options?: RequestInit): Promise<unknown>;
1013
+ createDatabase(tenant: string, request: Api.CreateDatabasePayload, options?: RequestInit): Promise<Api.CreateDatabaseResponse>;
1098
1014
  /**
1099
- * @summary List Collections
1100
- * @param {string} tenant
1101
- * @param {string} databaseName
1102
- * @param {number | null} [limit]
1103
- * @param {number | null} [offset]
1015
+ * @summary Creates a new tenant.
1016
+ * @param {Api.CreateTenantPayload} request
1104
1017
  * @param {RequestInit} [options] Override http request option.
1105
1018
  * @throws {RequiredError}
1106
1019
  */
1107
- listCollectionsV2(tenant: string, databaseName: string, limit: number | null | undefined, offset: number | null | undefined, options?: RequestInit): Promise<unknown>;
1020
+ createTenant(request: Api.CreateTenantPayload, options?: RequestInit): Promise<Api.CreateTenantResponse>;
1108
1021
  /**
1109
- * @summary List Databases
1110
- * @param {string} tenant
1111
- * @param {number | null} [limit]
1112
- * @param {number | null} [offset]
1022
+ * @summary Deletes a collection in a given database.
1023
+ * @param {string} tenant <p>Tenant ID</p>
1024
+ * @param {string} database <p>Database name</p>
1025
+ * @param {string} collectionId <p>UUID of the collection to delete</p>
1113
1026
  * @param {RequestInit} [options] Override http request option.
1114
1027
  * @throws {RequiredError}
1115
1028
  */
1116
- listDatabasesV2(tenant: string, limit: number | null | undefined, offset: number | null | undefined, options?: RequestInit): Promise<unknown>;
1029
+ deleteCollection(tenant: string, database: string, collectionId: string, options?: RequestInit): Promise<Api.UpdateCollectionResponse>;
1117
1030
  /**
1118
- * @summary Pre Flight Checks
1031
+ * @summary Deletes a specific database.
1032
+ * @param {string} tenant <p>Tenant ID</p>
1033
+ * @param {string} database <p>Name of the database to delete</p>
1119
1034
  * @param {RequestInit} [options] Override http request option.
1120
1035
  * @throws {RequiredError}
1121
1036
  */
1122
- preFlightChecksV1(options?: RequestInit): Promise<Api.PreFlightChecksV1200Response>;
1037
+ deleteDatabase(tenant: string, database: string, options?: RequestInit): Promise<Api.DeleteDatabaseResponse>;
1123
1038
  /**
1124
- * @summary Pre Flight Checks
1039
+ * @summary Retrieves a collection by ID or name.
1040
+ * @param {string} tenant <p>Tenant ID</p>
1041
+ * @param {string} database <p>Database name</p>
1042
+ * @param {string} collectionId <p>UUID of the collection</p>
1125
1043
  * @param {RequestInit} [options] Override http request option.
1126
1044
  * @throws {RequiredError}
1127
1045
  */
1128
- preFlightChecksV2(options?: RequestInit): Promise<Api.PreFlightChecksV2200Response>;
1046
+ getCollection(tenant: string, database: string, collectionId: string, options?: RequestInit): Promise<Api.Collection>;
1129
1047
  /**
1130
- * @summary Reset
1048
+ * @summary Retrieves a specific database by name.
1049
+ * @param {string} tenant <p>Tenant ID</p>
1050
+ * @param {string} database <p>Name of the database to retrieve</p>
1131
1051
  * @param {RequestInit} [options] Override http request option.
1132
1052
  * @throws {RequiredError}
1133
1053
  */
1134
- resetV1(options?: RequestInit): Promise<boolean>;
1054
+ getDatabase(tenant: string, database: string, options?: RequestInit): Promise<Api.Database>;
1135
1055
  /**
1136
- * @summary Reset
1056
+ * @summary Returns an existing tenant by name.
1057
+ * @param {string} tenantName <p>Tenant name or ID to retrieve</p>
1137
1058
  * @param {RequestInit} [options] Override http request option.
1138
1059
  * @throws {RequiredError}
1139
1060
  */
1140
- resetV2(options?: RequestInit): Promise<boolean>;
1061
+ getTenant(tenantName: string, options?: RequestInit): Promise<Api.GetTenantResponse>;
1141
1062
  /**
1142
- * @summary Root
1063
+ * @summary Retrieves the current user's identity, tenant, and databases.
1143
1064
  * @param {RequestInit} [options] Override http request option.
1144
1065
  * @throws {RequiredError}
1145
1066
  */
1146
- rootV1(options?: RequestInit): Promise<{
1147
- [name: string]: number;
1148
- }>;
1067
+ getUserIdentity(options?: RequestInit): Promise<Api.GetUserIdentityResponse>;
1149
1068
  /**
1150
- * @summary Root
1069
+ * @summary Health check endpoint that returns 200 if the server and executor are ready
1151
1070
  * @param {RequestInit} [options] Override http request option.
1152
1071
  * @throws {RequiredError}
1153
1072
  */
1154
- rootV2(options?: RequestInit): Promise<{
1155
- [name: string]: number;
1156
- }>;
1073
+ healthcheck(options?: RequestInit): Promise<string>;
1157
1074
  /**
1158
- * @summary Update Collection V1
1159
- * @param {string} collectionId
1160
- * @param {Api.UpdateCollectionV1V1Request} request
1075
+ * @summary Heartbeat endpoint that returns a nanosecond timestamp of the current time.
1161
1076
  * @param {RequestInit} [options] Override http request option.
1162
1077
  * @throws {RequiredError}
1163
1078
  */
1164
- updateCollectionV1V1(collectionId: string, request: Api.UpdateCollectionV1V1Request, options?: RequestInit): Promise<unknown>;
1079
+ heartbeat(options?: RequestInit): Promise<Api.HeartbeatResponse>;
1165
1080
  /**
1166
- * @summary Update Collection
1167
- * @param {string} tenant
1168
- * @param {string} databaseName
1169
- * @param {string} collectionId
1170
- * @param {Api.UpdateCollectionV2Request} request
1081
+ * @summary Lists all collections in the specified database.
1082
+ * @param {string} tenant <p>Tenant ID</p>
1083
+ * @param {string} database <p>Database name to list collections from</p>
1084
+ * @param {number} [limit] <p>Limit for pagination</p>
1085
+ * @param {number} [offset] <p>Offset for pagination</p>
1171
1086
  * @param {RequestInit} [options] Override http request option.
1172
1087
  * @throws {RequiredError}
1173
1088
  */
1174
- updateCollectionV2(tenant: string, databaseName: string, collectionId: string, request: Api.UpdateCollectionV2Request, options?: RequestInit): Promise<unknown>;
1089
+ listCollections(tenant: string, database: string, limit: number | undefined, offset: number | undefined, options?: RequestInit): Promise<Api.Vec2[]>;
1175
1090
  /**
1176
- * @summary Update V1
1177
- * @param {string} collectionId
1178
- * @param {Api.UpdateV1V1Request} request
1091
+ * @summary Lists all databases for a given tenant.
1092
+ * @param {string} tenant <p>Tenant ID to list databases for</p>
1093
+ * @param {number} [limit] <p>Limit for pagination</p>
1094
+ * @param {number} [offset] <p>Offset for pagination</p>
1179
1095
  * @param {RequestInit} [options] Override http request option.
1180
1096
  * @throws {RequiredError}
1181
1097
  */
1182
- updateV1V1(collectionId: string, request: Api.UpdateV1V1Request, options?: RequestInit): Promise<unknown>;
1098
+ listDatabases(tenant: string, limit: number | undefined, offset: number | undefined, options?: RequestInit): Promise<Api.Vec2[]>;
1183
1099
  /**
1184
- * @summary Update
1185
- * @param {string} tenant
1186
- * @param {string} databaseName
1187
- * @param {string} collectionId
1188
- * @param {Api.UpdateV2Request} request
1100
+ * @summary Pre-flight checks endpoint reporting basic readiness info.
1189
1101
  * @param {RequestInit} [options] Override http request option.
1190
1102
  * @throws {RequiredError}
1191
1103
  */
1192
- updateV2(tenant: string, databaseName: string, collectionId: string, request: Api.UpdateV2Request, options?: RequestInit): Promise<unknown>;
1104
+ preFlightChecks(options?: RequestInit): Promise<Api.ChecklistResponse>;
1193
1105
  /**
1194
- * @summary Upsert V1
1195
- * @param {string} collectionId
1196
- * @param {Api.UpsertV1V1Request} request
1106
+ * @summary Reset endpoint allowing authorized users to reset the database.
1197
1107
  * @param {RequestInit} [options] Override http request option.
1198
1108
  * @throws {RequiredError}
1199
1109
  */
1200
- upsertV1V1(collectionId: string, request: Api.UpsertV1V1Request, options?: RequestInit): Promise<unknown>;
1110
+ reset(options?: RequestInit): Promise<boolean>;
1201
1111
  /**
1202
- * @summary Upsert
1203
- * @param {string} tenant
1204
- * @param {string} databaseName
1205
- * @param {string} collectionId
1206
- * @param {Api.UpsertV2Request} request
1207
- * @param {RequestInit} [options] Override http request option.
1208
- * @throws {RequiredError}
1209
- */
1210
- upsertV2(tenant: string, databaseName: string, collectionId: string, request: Api.UpsertV2Request, options?: RequestInit): Promise<unknown>;
1211
- /**
1212
- * @summary Version
1112
+ * @summary Updates an existing collection's name or metadata.
1113
+ * @param {string} tenant <p>Tenant ID</p>
1114
+ * @param {string} database <p>Database name</p>
1115
+ * @param {string} collectionId <p>UUID of the collection to update</p>
1116
+ * @param {Api.UpdateCollectionPayload} request
1213
1117
  * @param {RequestInit} [options] Override http request option.
1214
1118
  * @throws {RequiredError}
1215
1119
  */
1216
- versionV1(options?: RequestInit): Promise<string>;
1120
+ updateCollection(tenant: string, database: string, collectionId: string, request: Api.UpdateCollectionPayload, options?: RequestInit): Promise<Api.UpdateCollectionResponse>;
1217
1121
  /**
1218
- * @summary Version
1122
+ * @summary Returns the version of the server.
1219
1123
  * @param {RequestInit} [options] Override http request option.
1220
1124
  * @throws {RequiredError}
1221
1125
  */
1222
- versionV2(options?: RequestInit): Promise<string>;
1126
+ version(options?: RequestInit): Promise<string>;
1223
1127
  }
1224
1128
 
1225
1129
  declare class ChromaClient {
@@ -1644,12 +1548,23 @@ declare class CohereEmbeddingFunction implements IEmbeddingFunction {
1644
1548
  name: string;
1645
1549
  private cohereAiApi?;
1646
1550
  private model;
1551
+ private isImage;
1647
1552
  private apiKey;
1648
1553
  private apiKeyEnvVar;
1649
- constructor({ cohere_api_key, model, cohere_api_key_env_var, }: {
1554
+ constructor({ cohere_api_key, model, cohere_api_key_env_var,
1555
+ /**
1556
+ * If true, the input texts passed to `generate` are expected to be
1557
+ * base64 encoded PNG data URIs.
1558
+ */
1559
+ isImage, }: {
1650
1560
  cohere_api_key?: string;
1651
1561
  model?: string;
1652
1562
  cohere_api_key_env_var: string;
1563
+ /**
1564
+ * If true, the input texts passed to `generate` are expected to be
1565
+ * base64 encoded PNG data URIs.
1566
+ */
1567
+ isImage?: boolean;
1653
1568
  });
1654
1569
  private initCohereClient;
1655
1570
  generate(texts: string[]): Promise<number[][]>;