mixpeek 0.81.1

package/dist/api/collection-documents-api.d.ts

@@ -0,0 +1,918 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { BatchDeleteDocumentsRequest } from '../models';
+import type { BatchDeleteDocumentsResponse } from '../models';
+import type { BatchUpdateDocumentsRequest } from '../models';
+import type { BatchUpdateDocumentsResponse } from '../models';
+import type { BulkUpdateDocumentsRequest } from '../models';
+import type { BulkUpdateDocumentsResponse } from '../models';
+import type { DocumentAggregationRequest } from '../models';
+import type { DocumentAggregationResponse } from '../models';
+import type { DocumentCreateRequest } from '../models';
+import type { DocumentResponse } from '../models';
+import type { GenericDeleteResponse } from '../models';
+import type { ListDocumentsRequest } from '../models';
+import type { ListDocumentsResponse } from '../models';
+/**
+ * CollectionDocumentsApi - axios parameter creator
+ * @export
+ */
+export declare const CollectionDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This endpoint performs aggregation operations on documents in a collection.      **Aggregation Framework**: Provides MongoDB-style aggregation operations:     - GROUP BY: Group documents by one or more fields     - Aggregations: COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT, etc.     - Date Operations: Truncate or extract date parts for time-series analysis     - Filtering: Pre-aggregation filters (WHERE) and post-aggregation filters (HAVING)     - Sorting & Limiting: Control result ordering and size      **Use Cases**:     - Count documents by feature type or collection     - Calculate daily/monthly processing statistics     - Analyze feature distributions and confidence scores     - Generate reports with multiple metrics      **Note**: This endpoint works with both MongoDB and Qdrant using the same interface.     The system automatically selects the appropriate aggregation provider based on     the underlying metadata store.
+     * @summary Aggregate Documents
+     * @param {string} collectionIdentifier The unique identifier of the collection.
+     * @param {DocumentAggregationRequest} documentAggregationRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \'Bearer sk_xxxxxxxxxxxxx\'. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \'my-namespace\'
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    aggregateDocuments: (collectionIdentifier: string, documentAggregationRequest: DocumentAggregationRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Batch delete multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'document_ids\' array    - Deletes specific documents by ID    - Returns detailed per-document results    - Maximum 1000 documents per batch  2. Filter mode: Provide \'filters\' to delete all matching documents    - Deletes ALL documents matching the filters    - Returns total count only    - Use with caution - can delete many documents  Key Features: - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection - Automatic document count update for the collection - Efficient bulk deletion  Examples:     Explicit IDs mode:     ```json     {         \"document_ids\": [\"doc_123\", \"doc_456\", \"doc_789\"]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"archived\"}]}     }     ```
+     * @summary Batch Delete Documents
+     * @param {string} collectionIdentifier The ID of the collection to delete documents from.
+     * @param {BatchDeleteDocumentsRequest} batchDeleteDocumentsRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchDelete: (collectionIdentifier: string, batchDeleteDocumentsRequest: BatchDeleteDocumentsRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Batch update multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'updates\' array with document_id + update_data for each document    - Each document can have DIFFERENT update_data    - Returns detailed per-document results  2. Filter mode: Provide \'filters\' + \'update_data\' to update all matching documents    - All documents receive the SAME update_data    - Returns total count only  Key Features: - Update any document field except vectors (metadata, internal_metadata, source_blobs, etc.) - Maximum 1000 documents per batch in explicit mode - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection  Examples:     Explicit IDs mode:     ```json     {         \"updates\": [             {\"document_id\": \"doc_123\", \"update_data\": {\"metadata\": {\"status\": \"processed\"}}},             {\"document_id\": \"doc_456\", \"update_data\": {\"metadata\": {\"status\": \"archived\"}}}         ]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"pending\"}]},         \"update_data\": {\"metadata\": {\"status\": \"processed\"}}     }     ```
+     * @summary Batch Update Documents
+     * @param {string} collectionIdentifier The ID of the collection to update documents in.
+     * @param {BatchUpdateDocumentsRequest} batchUpdateDocumentsRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchUpdate: (collectionIdentifier: string, batchUpdateDocumentsRequest: BatchUpdateDocumentsRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Bulk update documents matching filter conditions.  Partially updates all documents in the collection that match the provided filters. If no filters are provided, updates all documents in the collection.  This endpoint applies the SAME update_data to ALL documents matching the filters. For per-document updates with different values, use POST /batch endpoint instead.
+     * @summary Bulk Update Documents
+     * @param {string} collectionIdentifier The ID of the collection to update documents in.
+     * @param {BulkUpdateDocumentsRequest} bulkUpdateDocumentsRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdate: (collectionIdentifier: string, bulkUpdateDocumentsRequest: BulkUpdateDocumentsRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a document by ID.
+     * @summary Create a document.
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {DocumentCreateRequest} documentCreateRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocument: (collectionIdentifier: string, documentCreateRequest: DocumentCreateRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a document by ID.
+     * @summary Delete a document by ID.
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to delete.
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocument: (collectionIdentifier: string, documentId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a document by ID.
+     * @summary Get a document by ID.
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to retrieve.
+     * @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
+     * @param {boolean} [returnVectors]
+     * @param {boolean} [returnVectorNames] Include a \&#39;_vectors\&#39; field listing available vector names for this document (without actual embedding data)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocument: (collectionIdentifier: string, documentId: string, returnPresignedUrls?: boolean, returnVectors?: boolean, returnVectorNames?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List documents with optional grouping support.  Supports two modes: 1. Regular listing: Returns flat list of documents with pagination 2. Grouped listing: When group_by is specified, returns documents grouped by field value  When using group_by: - Requires a payload index on the specified field in Qdrant - Pagination applies to groups, not individual documents - Each group contains all documents sharing the same field value
+     * @summary List documents.
+     * @param {string} collectionIdentifier The ID of the collection to list documents from.
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {ListDocumentsRequest} [listDocumentsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDocuments: (collectionIdentifier: string, limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listDocumentsRequest?: ListDocumentsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Partially update a document by ID (PATCH operation).
+     * @summary Patch Document
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to patch.
+     * @param {{ [key: string]: any; }} requestBody
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchDocument: (collectionIdentifier: string, documentId: string, requestBody: {
+        [key: string]: any;
+    }, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a document by ID.
+     * @summary Update Document
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to update.
+     * @param {{ [key: string]: any; }} requestBody
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocument: (collectionIdentifier: string, documentId: string, requestBody: {
+        [key: string]: any;
+    }, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CollectionDocumentsApi - functional programming interface
+ * @export
+ */
+export declare const CollectionDocumentsApiFp: (configuration?: Configuration) => {
+    /**
+     * This endpoint performs aggregation operations on documents in a collection.      **Aggregation Framework**: Provides MongoDB-style aggregation operations:     - GROUP BY: Group documents by one or more fields     - Aggregations: COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT, etc.     - Date Operations: Truncate or extract date parts for time-series analysis     - Filtering: Pre-aggregation filters (WHERE) and post-aggregation filters (HAVING)     - Sorting & Limiting: Control result ordering and size      **Use Cases**:     - Count documents by feature type or collection     - Calculate daily/monthly processing statistics     - Analyze feature distributions and confidence scores     - Generate reports with multiple metrics      **Note**: This endpoint works with both MongoDB and Qdrant using the same interface.     The system automatically selects the appropriate aggregation provider based on     the underlying metadata store.
+     * @summary Aggregate Documents
+     * @param {string} collectionIdentifier The unique identifier of the collection.
+     * @param {DocumentAggregationRequest} documentAggregationRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    aggregateDocuments(collectionIdentifier: string, documentAggregationRequest: DocumentAggregationRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentAggregationResponse>>;
+    /**
+     * Batch delete multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'document_ids\' array    - Deletes specific documents by ID    - Returns detailed per-document results    - Maximum 1000 documents per batch  2. Filter mode: Provide \'filters\' to delete all matching documents    - Deletes ALL documents matching the filters    - Returns total count only    - Use with caution - can delete many documents  Key Features: - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection - Automatic document count update for the collection - Efficient bulk deletion  Examples:     Explicit IDs mode:     ```json     {         \"document_ids\": [\"doc_123\", \"doc_456\", \"doc_789\"]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"archived\"}]}     }     ```
+     * @summary Batch Delete Documents
+     * @param {string} collectionIdentifier The ID of the collection to delete documents from.
+     * @param {BatchDeleteDocumentsRequest} batchDeleteDocumentsRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchDelete(collectionIdentifier: string, batchDeleteDocumentsRequest: BatchDeleteDocumentsRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchDeleteDocumentsResponse>>;
+    /**
+     * Batch update multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'updates\' array with document_id + update_data for each document    - Each document can have DIFFERENT update_data    - Returns detailed per-document results  2. Filter mode: Provide \'filters\' + \'update_data\' to update all matching documents    - All documents receive the SAME update_data    - Returns total count only  Key Features: - Update any document field except vectors (metadata, internal_metadata, source_blobs, etc.) - Maximum 1000 documents per batch in explicit mode - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection  Examples:     Explicit IDs mode:     ```json     {         \"updates\": [             {\"document_id\": \"doc_123\", \"update_data\": {\"metadata\": {\"status\": \"processed\"}}},             {\"document_id\": \"doc_456\", \"update_data\": {\"metadata\": {\"status\": \"archived\"}}}         ]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"pending\"}]},         \"update_data\": {\"metadata\": {\"status\": \"processed\"}}     }     ```
+     * @summary Batch Update Documents
+     * @param {string} collectionIdentifier The ID of the collection to update documents in.
+     * @param {BatchUpdateDocumentsRequest} batchUpdateDocumentsRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchUpdate(collectionIdentifier: string, batchUpdateDocumentsRequest: BatchUpdateDocumentsRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchUpdateDocumentsResponse>>;
+    /**
+     * Bulk update documents matching filter conditions.  Partially updates all documents in the collection that match the provided filters. If no filters are provided, updates all documents in the collection.  This endpoint applies the SAME update_data to ALL documents matching the filters. For per-document updates with different values, use POST /batch endpoint instead.
+     * @summary Bulk Update Documents
+     * @param {string} collectionIdentifier The ID of the collection to update documents in.
+     * @param {BulkUpdateDocumentsRequest} bulkUpdateDocumentsRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdate(collectionIdentifier: string, bulkUpdateDocumentsRequest: BulkUpdateDocumentsRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkUpdateDocumentsResponse>>;
+    /**
+     * Create a document by ID.
+     * @summary Create a document.
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {DocumentCreateRequest} documentCreateRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocument(collectionIdentifier: string, documentCreateRequest: DocumentCreateRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentResponse>>;
+    /**
+     * Delete a document by ID.
+     * @summary Delete a document by ID.
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to delete.
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocument(collectionIdentifier: string, documentId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenericDeleteResponse>>;
+    /**
+     * Get a document by ID.
+     * @summary Get a document by ID.
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to retrieve.
+     * @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
+     * @param {boolean} [returnVectors]
+     * @param {boolean} [returnVectorNames] Include a \&#39;_vectors\&#39; field listing available vector names for this document (without actual embedding data)
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocument(collectionIdentifier: string, documentId: string, returnPresignedUrls?: boolean, returnVectors?: boolean, returnVectorNames?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentResponse>>;
+    /**
+     * List documents with optional grouping support.  Supports two modes: 1. Regular listing: Returns flat list of documents with pagination 2. Grouped listing: When group_by is specified, returns documents grouped by field value  When using group_by: - Requires a payload index on the specified field in Qdrant - Pagination applies to groups, not individual documents - Each group contains all documents sharing the same field value
+     * @summary List documents.
+     * @param {string} collectionIdentifier The ID of the collection to list documents from.
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {ListDocumentsRequest} [listDocumentsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDocuments(collectionIdentifier: string, limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listDocumentsRequest?: ListDocumentsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponse>>;
+    /**
+     * Partially update a document by ID (PATCH operation).
+     * @summary Patch Document
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to patch.
+     * @param {{ [key: string]: any; }} requestBody
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchDocument(collectionIdentifier: string, documentId: string, requestBody: {
+        [key: string]: any;
+    }, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentResponse>>;
+    /**
+     * Update a document by ID.
+     * @summary Update Document
+     * @param {string} collectionIdentifier The ID of the collection.
+     * @param {string} documentId The ID of the document to update.
+     * @param {{ [key: string]: any; }} requestBody
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {string} [authorization2]
+     * @param {string} [xNamespace] REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocument(collectionIdentifier: string, documentId: string, requestBody: {
+        [key: string]: any;
+    }, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentResponse>>;
+};
+/**
+ * CollectionDocumentsApi - factory interface
+ * @export
+ */
+export declare const CollectionDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This endpoint performs aggregation operations on documents in a collection.      **Aggregation Framework**: Provides MongoDB-style aggregation operations:     - GROUP BY: Group documents by one or more fields     - Aggregations: COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT, etc.     - Date Operations: Truncate or extract date parts for time-series analysis     - Filtering: Pre-aggregation filters (WHERE) and post-aggregation filters (HAVING)     - Sorting & Limiting: Control result ordering and size      **Use Cases**:     - Count documents by feature type or collection     - Calculate daily/monthly processing statistics     - Analyze feature distributions and confidence scores     - Generate reports with multiple metrics      **Note**: This endpoint works with both MongoDB and Qdrant using the same interface.     The system automatically selects the appropriate aggregation provider based on     the underlying metadata store.
+     * @summary Aggregate Documents
+     * @param {CollectionDocumentsApiAggregateDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    aggregateDocuments(requestParameters: CollectionDocumentsApiAggregateDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DocumentAggregationResponse>;
+    /**
+     * Batch delete multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'document_ids\' array    - Deletes specific documents by ID    - Returns detailed per-document results    - Maximum 1000 documents per batch  2. Filter mode: Provide \'filters\' to delete all matching documents    - Deletes ALL documents matching the filters    - Returns total count only    - Use with caution - can delete many documents  Key Features: - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection - Automatic document count update for the collection - Efficient bulk deletion  Examples:     Explicit IDs mode:     ```json     {         \"document_ids\": [\"doc_123\", \"doc_456\", \"doc_789\"]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"archived\"}]}     }     ```
+     * @summary Batch Delete Documents
+     * @param {CollectionDocumentsApiBatchDeleteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchDelete(requestParameters: CollectionDocumentsApiBatchDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchDeleteDocumentsResponse>;
+    /**
+     * Batch update multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'updates\' array with document_id + update_data for each document    - Each document can have DIFFERENT update_data    - Returns detailed per-document results  2. Filter mode: Provide \'filters\' + \'update_data\' to update all matching documents    - All documents receive the SAME update_data    - Returns total count only  Key Features: - Update any document field except vectors (metadata, internal_metadata, source_blobs, etc.) - Maximum 1000 documents per batch in explicit mode - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection  Examples:     Explicit IDs mode:     ```json     {         \"updates\": [             {\"document_id\": \"doc_123\", \"update_data\": {\"metadata\": {\"status\": \"processed\"}}},             {\"document_id\": \"doc_456\", \"update_data\": {\"metadata\": {\"status\": \"archived\"}}}         ]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"pending\"}]},         \"update_data\": {\"metadata\": {\"status\": \"processed\"}}     }     ```
+     * @summary Batch Update Documents
+     * @param {CollectionDocumentsApiBatchUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    batchUpdate(requestParameters: CollectionDocumentsApiBatchUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchUpdateDocumentsResponse>;
+    /**
+     * Bulk update documents matching filter conditions.  Partially updates all documents in the collection that match the provided filters. If no filters are provided, updates all documents in the collection.  This endpoint applies the SAME update_data to ALL documents matching the filters. For per-document updates with different values, use POST /batch endpoint instead.
+     * @summary Bulk Update Documents
+     * @param {CollectionDocumentsApiBulkUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdate(requestParameters: CollectionDocumentsApiBulkUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkUpdateDocumentsResponse>;
+    /**
+     * Create a document by ID.
+     * @summary Create a document.
+     * @param {CollectionDocumentsApiCreateDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createDocument(requestParameters: CollectionDocumentsApiCreateDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DocumentResponse>;
+    /**
+     * Delete a document by ID.
+     * @summary Delete a document by ID.
+     * @param {CollectionDocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteDocument(requestParameters: CollectionDocumentsApiDeleteDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenericDeleteResponse>;
+    /**
+     * Get a document by ID.
+     * @summary Get a document by ID.
+     * @param {CollectionDocumentsApiGetDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDocument(requestParameters: CollectionDocumentsApiGetDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DocumentResponse>;
+    /**
+     * List documents with optional grouping support.  Supports two modes: 1. Regular listing: Returns flat list of documents with pagination 2. Grouped listing: When group_by is specified, returns documents grouped by field value  When using group_by: - Requires a payload index on the specified field in Qdrant - Pagination applies to groups, not individual documents - Each group contains all documents sharing the same field value
+     * @summary List documents.
+     * @param {CollectionDocumentsApiListDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listDocuments(requestParameters: CollectionDocumentsApiListDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListDocumentsResponse>;
+    /**
+     * Partially update a document by ID (PATCH operation).
+     * @summary Patch Document
+     * @param {CollectionDocumentsApiPatchDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchDocument(requestParameters: CollectionDocumentsApiPatchDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DocumentResponse>;
+    /**
+     * Update a document by ID.
+     * @summary Update Document
+     * @param {CollectionDocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateDocument(requestParameters: CollectionDocumentsApiUpdateDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DocumentResponse>;
+};
+/**
+ * Request parameters for aggregateDocuments operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiAggregateDocumentsRequest
+ */
+export interface CollectionDocumentsApiAggregateDocumentsRequest {
+    /**
+     * The unique identifier of the collection.
+     * @type {string}
+     * @memberof CollectionDocumentsApiAggregateDocuments
+     */
+    readonly collectionIdentifier: string;
+    /**
+     *
+     * @type {DocumentAggregationRequest}
+     * @memberof CollectionDocumentsApiAggregateDocuments
+     */
+    readonly documentAggregationRequest: DocumentAggregationRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiAggregateDocuments
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiAggregateDocuments
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiAggregateDocuments
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for batchDelete operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiBatchDeleteRequest
+ */
+export interface CollectionDocumentsApiBatchDeleteRequest {
+    /**
+     * The ID of the collection to delete documents from.
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchDelete
+     */
+    readonly collectionIdentifier: string;
+    /**
+     *
+     * @type {BatchDeleteDocumentsRequest}
+     * @memberof CollectionDocumentsApiBatchDelete
+     */
+    readonly batchDeleteDocumentsRequest: BatchDeleteDocumentsRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchDelete
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchDelete
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchDelete
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for batchUpdate operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiBatchUpdateRequest
+ */
+export interface CollectionDocumentsApiBatchUpdateRequest {
+    /**
+     * The ID of the collection to update documents in.
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchUpdate
+     */
+    readonly collectionIdentifier: string;
+    /**
+     *
+     * @type {BatchUpdateDocumentsRequest}
+     * @memberof CollectionDocumentsApiBatchUpdate
+     */
+    readonly batchUpdateDocumentsRequest: BatchUpdateDocumentsRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchUpdate
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchUpdate
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiBatchUpdate
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for bulkUpdate operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiBulkUpdateRequest
+ */
+export interface CollectionDocumentsApiBulkUpdateRequest {
+    /**
+     * The ID of the collection to update documents in.
+     * @type {string}
+     * @memberof CollectionDocumentsApiBulkUpdate
+     */
+    readonly collectionIdentifier: string;
+    /**
+     *
+     * @type {BulkUpdateDocumentsRequest}
+     * @memberof CollectionDocumentsApiBulkUpdate
+     */
+    readonly bulkUpdateDocumentsRequest: BulkUpdateDocumentsRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiBulkUpdate
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiBulkUpdate
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiBulkUpdate
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createDocument operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiCreateDocumentRequest
+ */
+export interface CollectionDocumentsApiCreateDocumentRequest {
+    /**
+     * The ID of the collection.
+     * @type {string}
+     * @memberof CollectionDocumentsApiCreateDocument
+     */
+    readonly collectionIdentifier: string;
+    /**
+     *
+     * @type {DocumentCreateRequest}
+     * @memberof CollectionDocumentsApiCreateDocument
+     */
+    readonly documentCreateRequest: DocumentCreateRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiCreateDocument
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiCreateDocument
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiCreateDocument
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for deleteDocument operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiDeleteDocumentRequest
+ */
+export interface CollectionDocumentsApiDeleteDocumentRequest {
+    /**
+     * The ID of the collection.
+     * @type {string}
+     * @memberof CollectionDocumentsApiDeleteDocument
+     */
+    readonly collectionIdentifier: string;
+    /**
+     * The ID of the document to delete.
+     * @type {string}
+     * @memberof CollectionDocumentsApiDeleteDocument
+     */
+    readonly documentId: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiDeleteDocument
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiDeleteDocument
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiDeleteDocument
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getDocument operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiGetDocumentRequest
+ */
+export interface CollectionDocumentsApiGetDocumentRequest {
+    /**
+     * The ID of the collection.
+     * @type {string}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly collectionIdentifier: string;
+    /**
+     * The ID of the document to retrieve.
+     * @type {string}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly documentId: string;
+    /**
+     * Generate fresh presigned download URLs for all blobs with S3 storage
+     * @type {boolean}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly returnPresignedUrls?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly returnVectors?: boolean;
+    /**
+     * Include a \&#39;_vectors\&#39; field listing available vector names for this document (without actual embedding data)
+     * @type {boolean}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly returnVectorNames?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiGetDocument
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listDocuments operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiListDocumentsRequest
+ */
+export interface CollectionDocumentsApiListDocumentsRequest {
+    /**
+     * The ID of the collection to list documents from.
+     * @type {string}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly collectionIdentifier: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly includeTotal?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly xNamespace?: string;
+    /**
+     *
+     * @type {ListDocumentsRequest}
+     * @memberof CollectionDocumentsApiListDocuments
+     */
+    readonly listDocumentsRequest?: ListDocumentsRequest;
+}
+/**
+ * Request parameters for patchDocument operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiPatchDocumentRequest
+ */
+export interface CollectionDocumentsApiPatchDocumentRequest {
+    /**
+     * The ID of the collection.
+     * @type {string}
+     * @memberof CollectionDocumentsApiPatchDocument
+     */
+    readonly collectionIdentifier: string;
+    /**
+     * The ID of the document to patch.
+     * @type {string}
+     * @memberof CollectionDocumentsApiPatchDocument
+     */
+    readonly documentId: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof CollectionDocumentsApiPatchDocument
+     */
+    readonly requestBody: {
+        [key: string]: any;
+    };
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiPatchDocument
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiPatchDocument
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiPatchDocument
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for updateDocument operation in CollectionDocumentsApi.
+ * @export
+ * @interface CollectionDocumentsApiUpdateDocumentRequest
+ */
+export interface CollectionDocumentsApiUpdateDocumentRequest {
+    /**
+     * The ID of the collection.
+     * @type {string}
+     * @memberof CollectionDocumentsApiUpdateDocument
+     */
+    readonly collectionIdentifier: string;
+    /**
+     * The ID of the document to update.
+     * @type {string}
+     * @memberof CollectionDocumentsApiUpdateDocument
+     */
+    readonly documentId: string;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof CollectionDocumentsApiUpdateDocument
+     */
+    readonly requestBody: {
+        [key: string]: any;
+    };
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof CollectionDocumentsApiUpdateDocument
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionDocumentsApiUpdateDocument
+     */
+    readonly authorization2?: string;
+    /**
+     * REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like \&#39;my-namespace\&#39;
+     * @type {string}
+     * @memberof CollectionDocumentsApiUpdateDocument
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * CollectionDocumentsApi - object-oriented interface
+ * @export
+ * @class CollectionDocumentsApi
+ * @extends {BaseAPI}
+ */
+export declare class CollectionDocumentsApi extends BaseAPI {
+    /**
+     * This endpoint performs aggregation operations on documents in a collection.      **Aggregation Framework**: Provides MongoDB-style aggregation operations:     - GROUP BY: Group documents by one or more fields     - Aggregations: COUNT, SUM, AVG, MIN, MAX, COUNT_DISTINCT, etc.     - Date Operations: Truncate or extract date parts for time-series analysis     - Filtering: Pre-aggregation filters (WHERE) and post-aggregation filters (HAVING)     - Sorting & Limiting: Control result ordering and size      **Use Cases**:     - Count documents by feature type or collection     - Calculate daily/monthly processing statistics     - Analyze feature distributions and confidence scores     - Generate reports with multiple metrics      **Note**: This endpoint works with both MongoDB and Qdrant using the same interface.     The system automatically selects the appropriate aggregation provider based on     the underlying metadata store.
+     * @summary Aggregate Documents
+     * @param {CollectionDocumentsApiAggregateDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    aggregateDocuments(requestParameters: CollectionDocumentsApiAggregateDocumentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentAggregationResponse, any, {}>>;
+    /**
+     * Batch delete multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'document_ids\' array    - Deletes specific documents by ID    - Returns detailed per-document results    - Maximum 1000 documents per batch  2. Filter mode: Provide \'filters\' to delete all matching documents    - Deletes ALL documents matching the filters    - Returns total count only    - Use with caution - can delete many documents  Key Features: - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection - Automatic document count update for the collection - Efficient bulk deletion  Examples:     Explicit IDs mode:     ```json     {         \"document_ids\": [\"doc_123\", \"doc_456\", \"doc_789\"]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"archived\"}]}     }     ```
+     * @summary Batch Delete Documents
+     * @param {CollectionDocumentsApiBatchDeleteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    batchDelete(requestParameters: CollectionDocumentsApiBatchDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchDeleteDocumentsResponse, any, {}>>;
+    /**
+     * Batch update multiple documents by explicit IDs or filters.  Supports TWO modes: 1. Explicit IDs mode: Provide \'updates\' array with document_id + update_data for each document    - Each document can have DIFFERENT update_data    - Returns detailed per-document results  2. Filter mode: Provide \'filters\' + \'update_data\' to update all matching documents    - All documents receive the SAME update_data    - Returns total count only  Key Features: - Update any document field except vectors (metadata, internal_metadata, source_blobs, etc.) - Maximum 1000 documents per batch in explicit mode - Per-document success/failure reporting in explicit mode - Validates documents exist in the specified collection  Examples:     Explicit IDs mode:     ```json     {         \"updates\": [             {\"document_id\": \"doc_123\", \"update_data\": {\"metadata\": {\"status\": \"processed\"}}},             {\"document_id\": \"doc_456\", \"update_data\": {\"metadata\": {\"status\": \"archived\"}}}         ]     }     ```      Filter mode:     ```json     {         \"filters\": {\"must\": [{\"key\": \"metadata.status\", \"value\": \"pending\"}]},         \"update_data\": {\"metadata\": {\"status\": \"processed\"}}     }     ```
+     * @summary Batch Update Documents
+     * @param {CollectionDocumentsApiBatchUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    batchUpdate(requestParameters: CollectionDocumentsApiBatchUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchUpdateDocumentsResponse, any, {}>>;
+    /**
+     * Bulk update documents matching filter conditions.  Partially updates all documents in the collection that match the provided filters. If no filters are provided, updates all documents in the collection.  This endpoint applies the SAME update_data to ALL documents matching the filters. For per-document updates with different values, use POST /batch endpoint instead.
+     * @summary Bulk Update Documents
+     * @param {CollectionDocumentsApiBulkUpdateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    bulkUpdate(requestParameters: CollectionDocumentsApiBulkUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkUpdateDocumentsResponse, any, {}>>;
+    /**
+     * Create a document by ID.
+     * @summary Create a document.
+     * @param {CollectionDocumentsApiCreateDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    createDocument(requestParameters: CollectionDocumentsApiCreateDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentResponse, any, {}>>;
+    /**
+     * Delete a document by ID.
+     * @summary Delete a document by ID.
+     * @param {CollectionDocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    deleteDocument(requestParameters: CollectionDocumentsApiDeleteDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenericDeleteResponse, any, {}>>;
+    /**
+     * Get a document by ID.
+     * @summary Get a document by ID.
+     * @param {CollectionDocumentsApiGetDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    getDocument(requestParameters: CollectionDocumentsApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentResponse, any, {}>>;
+    /**
+     * List documents with optional grouping support.  Supports two modes: 1. Regular listing: Returns flat list of documents with pagination 2. Grouped listing: When group_by is specified, returns documents grouped by field value  When using group_by: - Requires a payload index on the specified field in Qdrant - Pagination applies to groups, not individual documents - Each group contains all documents sharing the same field value
+     * @summary List documents.
+     * @param {CollectionDocumentsApiListDocumentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    listDocuments(requestParameters: CollectionDocumentsApiListDocumentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponse, any, {}>>;
+    /**
+     * Partially update a document by ID (PATCH operation).
+     * @summary Patch Document
+     * @param {CollectionDocumentsApiPatchDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    patchDocument(requestParameters: CollectionDocumentsApiPatchDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentResponse, any, {}>>;
+    /**
+     * Update a document by ID.
+     * @summary Update Document
+     * @param {CollectionDocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionDocumentsApi
+     */
+    updateDocument(requestParameters: CollectionDocumentsApiUpdateDocumentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentResponse, any, {}>>;
+}
+//# sourceMappingURL=collection-documents-api.d.ts.map