chromadb 3.2.2 → 3.3.1

package/src/api/types.gen.ts

@@ -1,8 +1,21 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
+/**
+ * Payload for adding records to a collection.
+ *
+ * Records are added in batches. All arrays must have the same length, with each index
+ * representing a single record. For example, `ids[0]`, `embeddings[0]`, `documents[0]`, etc.
+ * all belong to the same record.
+ */
 export type AddCollectionRecordsPayload = {
     documents?: Array<string | null> | null;
+    /**
+     * Embeddings for each record. Can contain the raw f32 arrays or base64 encoded strings.
+     */
     embeddings: EmbeddingsPayload;
+    /**
+     * Unique identifiers for each record.
+     */
     ids: Array<string>;
     metadatas?: Array<null | HashMap> | null;
     uris?: Array<string | null> | null;
@@ -22,7 +35,7 @@ export type AttachFunctionRequest = {
 export type AttachFunctionResponse = {
     attached_function: AttachedFunctionInfo;
     /**
-     * True if newly created, false if already existed (idempotent request)
+     * True if newly created, false if already existed (idempotent request).
      */
     created: boolean;
 };
@@ -75,8 +88,17 @@ export type AttachedFunctionApiResponse = {
 };
 
 export type AttachedFunctionInfo = {
+    /**
+     * Name of the function (e.g., "record_counter", "statistics").
+     */
     function_name: string;
+    /**
+     * Unique identifier for the attached function.
+     */
     id: string;
+    /**
+     * Human-readable name for the attached function instance.
+     */
     name: string;
 };
 
@@ -125,9 +147,6 @@ export type CollectionConfiguration = {
     spann?: null | SpannConfiguration;
 };
 
-/**
- * CollectionUuid is a wrapper around Uuid to provide a type for the collection id.
- */
 export type CollectionUuid = string;
 
 export type CreateCollectionPayload = {
@@ -160,6 +179,12 @@ export type Database = {
     tenant: string;
 };
 
+/**
+ * Payload for deleting records from a collection.
+ *
+ * Records can be deleted by their IDs or by a metadata filter. At least one of `ids` or `where`
+ * must be provided.
+ */
 export type DeleteCollectionRecordsPayload = RawWhereFields & {
     ids?: Array<string> | null;
 };
@@ -174,7 +199,7 @@ export type DeleteDatabaseResponse = {
 
 export type DetachFunctionRequest = {
     /**
-     * Whether to delete the output collection as well
+     * Whether to delete the output collection as well when detaching the function.
      */
     delete_output?: boolean;
 };
@@ -243,6 +268,10 @@ export type GetAttachedFunctionResponse = {
     attached_function: AttachedFunctionApiResponse;
 };
 
+/**
+ * Records can be retrieved by their IDs or by a metadata filter. At least one of `ids` or `where`
+ * must be provided. Use `include` to specify which fields to return in the response.
+ */
 export type GetRequestPayload = RawWhereFields & {
     ids?: Array<string> | null;
     include?: IncludeList;
@@ -250,10 +279,17 @@ export type GetRequestPayload = RawWhereFields & {
     offset?: number | null;
 };
 
+/**
+ * All arrays have the same length, with each index representing a single record.
+ * Only fields specified in the request's `include` parameter are populated.
+ */
 export type GetResponse = {
     documents?: Array<string | null> | null;
     embeddings?: Array<Array<number>> | null;
     ids: Array<string>;
+    /**
+     * List of fields that were included in this response.
+     */
     include: Array<Include>;
     metadatas?: Array<null | HashMap> | null;
     uris?: Array<string | null> | null;
@@ -271,7 +307,7 @@ export type GetUserIdentityResponse = {
 };
 
 export type HashMap = {
-  [key: string]: boolean | number | string | SparseVector | null;
+  [key: string]: boolean | number | string | SparseVector | Array<boolean> | Array<number> | Array<string> | null;
 };
 
 export type HeartbeatResponse = {
@@ -300,6 +336,9 @@ export type HnswIndexConfig = {
     sync_threshold?: number | null;
 };
 
+/**
+ * Use this enum to specify which fields should be returned when retrieving records.
+ */
 export type Include = 'distances' | 'documents' | 'embeddings' | 'metadatas' | 'uris';
 
 export type IncludeList = Array<Include>;
@@ -397,6 +436,11 @@ export type Key = 'Document' | 'Embedding' | 'Metadata' | 'Score' | {
     MetadataField: string;
 };
 
+/**
+ * Quantization implementation for SPANN vector index.
+ */
+export type Quantization = 'none' | 'four_bit_rabit_q_with_u_search';
+
 export type QueryRequestPayload = RawWhereFields & {
     ids?: Array<string> | null;
     include?: IncludeList;
@@ -477,8 +521,7 @@ export type SearchPayload = {
 
 export type SearchRequestPayload = {
     /**
-     * Specifies the read level for consistency vs performance tradeoffs.
-     * Defaults to IndexAndWal (full consistency).
+     * Specifies whether to include unindexed data in the search results.
      */
     read_level?: ReadLevel;
     searches: Array<SearchPayload>;
@@ -511,6 +554,7 @@ export type SpannConfiguration = {
  * Configuration for SPANN vector index algorithm parameters
  */
 export type SpannIndexConfig = {
+    center_drift_threshold?: number | null;
     ef_construction?: number | null;
     ef_search?: number | null;
     initial_lambda?: number | null;
@@ -519,6 +563,10 @@ export type SpannIndexConfig = {
     nreplica_count?: number | null;
     num_centers_to_merge_to?: number | null;
     num_samples_kmeans?: number | null;
+    /**
+     * Quantization implementation for vector search (cloud-only feature)
+     */
+    quantize?: Quantization;
     reassign_neighbor_count?: number | null;
     search_nprobe?: number | null;
     search_rng_epsilon?: number | null;
@@ -605,6 +653,13 @@ export type UpdateCollectionPayload = {
     new_name?: string | null;
 };
 
+/**
+ * Payload for updating existing records in a collection.
+ *
+ * Records are added in batches. All arrays must have the same length, with each index
+ * representing a single record. For example, `ids[0]`, `embeddings[0]`, `documents[0]`, etc.
+ * all belong to the same record.
+ */
 export type UpdateCollectionRecordsPayload = {
     documents?: Array<string | null> | null;
     embeddings?: null | UpdateEmbeddingsPayload;
@@ -645,8 +700,19 @@ export type UpdateTenantResponse = {
     [key: string]: unknown;
 };
 
+/**
+ * Payload for upserting records in a collection.
+ *
+ * Upsert creates records if they don't exist, or updates them if they do.
+ * Records are added in batches. All arrays must have the same length, with each index
+ * representing a single record. For example, `ids[0]`, `embeddings[0]`, `documents[0]`, etc.
+ * all belong to the same record.
+ */
 export type UpsertCollectionRecordsPayload = {
     documents?: Array<string | null> | null;
+    /**
+     * Embeddings for each record. Can contain the raw f32 arrays or base64 encoded strings.
+     */
     embeddings: EmbeddingsPayload;
     ids: Array<string>;
     metadatas?: Array<null | HashMap> | null;
@@ -719,7 +785,7 @@ export type GetUserIdentityError = GetUserIdentityErrors[keyof GetUserIdentityEr
 
 export type GetUserIdentityResponses = {
     /**
-     * Get user identity
+     * User identity
      */
     200: GetUserIdentityResponse;
 };
@@ -901,7 +967,7 @@ export type GetTenantData = {
     body?: never;
     path: {
         /**
-         * Tenant to retrieve
+         * Tenant UUID
          */
         tenant_name: string;
     };
@@ -939,7 +1005,7 @@ export type UpdateTenantData = {
     body: UpdateTenantPayload;
     path: {
         /**
-         * Tenant to update
+         * Tenant UUID
          */
         tenant_name: string;
     };
@@ -981,7 +1047,7 @@ export type ListDatabasesData = {
     body?: never;
     path: {
         /**
-         * Tenant ID to list databases for
+         * Tenant UUID
          */
         tenant: string;
     };
@@ -1024,7 +1090,7 @@ export type CreateDatabaseData = {
     body: CreateDatabasePayload;
     path: {
         /**
-         * Tenant ID to associate with the new database
+         * Tenant UUID
          */
         tenant: string;
     };
@@ -1058,11 +1124,11 @@ export type DeleteDatabaseData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Name of the database to delete
+         * Database name
          */
         database: string;
     };
@@ -1100,11 +1166,11 @@ export type GetDatabaseData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Name of the database to retrieve
+         * Database name
          */
         database: string;
     };
@@ -1142,11 +1208,11 @@ export type ListCollectionsData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name to list collections from
+         * Database name
          */
         database: string;
     };
@@ -1186,14 +1252,17 @@ export type ListCollectionsResponses = {
 export type ListCollectionsResponse = ListCollectionsResponses[keyof ListCollectionsResponses];
 
 export type CreateCollectionData = {
+    /**
+     * Collection creation payload
+     */
     body: CreateCollectionPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name containing the new collection
+         * Database name
          */
         database: string;
     };
@@ -1227,7 +1296,7 @@ export type DeleteCollectionData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1235,7 +1304,7 @@ export type DeleteCollectionData = {
          */
         database: string;
         /**
-         * UUID of the collection to delete
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1273,7 +1342,7 @@ export type GetCollectionData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1281,7 +1350,7 @@ export type GetCollectionData = {
          */
         database: string;
         /**
-         * UUID of the collection
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1316,10 +1385,13 @@ export type GetCollectionResponses = {
 export type GetCollectionResponse = GetCollectionResponses[keyof GetCollectionResponses];
 
 export type UpdateCollectionData = {
+    /**
+     * Collection update payload
+     */
     body: UpdateCollectionPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1327,7 +1399,7 @@ export type UpdateCollectionData = {
          */
         database: string;
         /**
-         * UUID of the collection to update
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1364,8 +1436,17 @@ export type UpdateCollectionResponse2 = UpdateCollectionResponses[keyof UpdateCo
 export type CollectionAddData = {
     body: AddCollectionRecordsPayload;
     path: {
+        /**
+         * Tenant UUID
+         */
         tenant: string;
+        /**
+         * Database name
+         */
         database: string;
+        /**
+         * Collection UUID
+         */
         collection_id: string;
     };
     query?: never;
@@ -1392,7 +1473,7 @@ export type DetachFunctionData = {
     body: DetachFunctionRequest;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1400,11 +1481,11 @@ export type DetachFunctionData = {
          */
         database: string;
         /**
-         * Input collection ID
+         * Collection UUID
          */
         collection_id: string;
         /**
-         * Attached function name
+         * Function name
          */
         name: string;
     };
@@ -1438,15 +1519,15 @@ export type CollectionCountData = {
     body?: never;
     path: {
         /**
-         * Tenant ID for the collection
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database containing this collection
+         * Database name
          */
         database: string;
         /**
-         * Collection ID whose records are counted
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1484,7 +1565,7 @@ export type CollectionDeleteData = {
     body: DeleteCollectionRecordsPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1492,7 +1573,7 @@ export type CollectionDeleteData = {
          */
         database: string;
         /**
-         * Collection ID
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1530,7 +1611,7 @@ export type ForkCollectionData = {
     body: ForkCollectionPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1538,7 +1619,7 @@ export type ForkCollectionData = {
          */
         database: string;
         /**
-         * UUID of the collection to update
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1573,10 +1654,13 @@ export type ForkCollectionResponses = {
 export type ForkCollectionResponse = ForkCollectionResponses[keyof ForkCollectionResponses];
 
 export type AttachFunctionData = {
+    /**
+     * Function attachment request
+     */
     body: AttachFunctionRequest;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1584,7 +1668,7 @@ export type AttachFunctionData = {
          */
         database: string;
         /**
-         * Collection ID
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1618,7 +1702,7 @@ export type GetAttachedFunctionData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1626,11 +1710,11 @@ export type GetAttachedFunctionData = {
          */
         database: string;
         /**
-         * Collection ID
+         * Collection UUID
          */
         collection_id: string;
         /**
-         * Attached function name
+         * Function name
          */
         function_name: string;
     };
@@ -1668,15 +1752,15 @@ export type CollectionGetData = {
     body: GetRequestPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name for the collection
+         * Database name
          */
         database: string;
         /**
-         * Collection ID to fetch records from
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1714,15 +1798,15 @@ export type IndexingStatusData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name for the collection
+         * Database name
          */
         database: string;
         /**
-         * Collection ID to get index status for
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1757,18 +1841,21 @@ export type IndexingStatusResponses = {
 export type IndexingStatusResponse = IndexingStatusResponses[keyof IndexingStatusResponses];
 
 export type CollectionQueryData = {
+    /**
+     * Query request payload
+     */
     body: QueryRequestPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name containing the collection
+         * Database name
          */
         database: string;
         /**
-         * Collection ID to query
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1812,18 +1899,21 @@ export type CollectionQueryResponses = {
 export type CollectionQueryResponse = CollectionQueryResponses[keyof CollectionQueryResponses];
 
 export type CollectionSearchData = {
+    /**
+     * Search request payload
+     */
     body: SearchRequestPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name for the collection
+         * Database name
          */
         database: string;
         /**
-         * Collection ID to search records from
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1860,8 +1950,17 @@ export type CollectionSearchResponse = CollectionSearchResponses[keyof Collectio
 export type CollectionUpdateData = {
     body: UpdateCollectionRecordsPayload;
     path: {
+        /**
+         * Tenant UUID
+         */
         tenant: string;
+        /**
+         * Database name
+         */
         database: string;
+        /**
+         * Collection UUID
+         */
         collection_id: string;
     };
     query?: never;
@@ -1888,7 +1987,7 @@ export type CollectionUpsertData = {
     body: UpsertCollectionRecordsPayload;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
@@ -1896,7 +1995,7 @@ export type CollectionUpsertData = {
          */
         database: string;
         /**
-         * Collection ID
+         * Collection UUID
          */
         collection_id: string;
     };
@@ -1934,11 +2033,11 @@ export type CountCollectionsData = {
     body?: never;
     path: {
         /**
-         * Tenant ID
+         * Tenant UUID
          */
         tenant: string;
         /**
-         * Database name to count collections from
+         * Database name
          */
         database: string;
     };