mixpeek 0.81.1

package/dist/api/retrievers-api.d.ts

@@ -0,0 +1,978 @@
+/**
+ * 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 { CloneRetrieverRequest } from '../models';
+import type { CloneRetrieverResponse } from '../models';
+import type { CreateRetrieverRequest } from '../models';
+import type { CreateRetrieverResponse } from '../models';
+import type { ExecuteRetrieverRequest } from '../models';
+import type { ExecutionDetail } from '../models';
+import type { ExplainRetrieverRequest } from '../models';
+import type { ExplainRetrieverResponse } from '../models';
+import type { ListExecutionsRequest } from '../models';
+import type { ListExecutionsResponse } from '../models';
+import type { ListRetrieversRequest } from '../models';
+import type { ListRetrieversResponse } from '../models';
+import type { PatchRetrieverRequest } from '../models';
+import type { PatchRetrieverResponse } from '../models';
+import type { RetrieverModelOutput } from '../models';
+/**
+ * RetrieversApi - axios parameter creator
+ * @export
+ */
+export declare const RetrieversApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Clone a retriever with optional modifications.  **Purpose:** Creates a NEW retriever (with new ID) based on an existing one. This is the recommended way to iterate on retriever designs when you need to modify core logic that PATCH doesn\'t allow (stages, input_schema, collections).  **Clone vs PATCH vs Template:** - **PATCH**: Update metadata only (name, description, tags, display_config) - **Clone**: Copy and modify core logic (stages, input_schema, collections) - **Template**: Start from a pre-configured pattern (for new projects)  **Common Use Cases:** - Fix a typo in a stage name - Add or remove stages - Change target collections - Create variants (e.g., \"strict\" vs \"relaxed\" versions) - Test modifications before replacing production retriever  **How it works:** 1. Source retriever is copied 2. You provide a new name (REQUIRED) 3. Optionally override any other fields 4. A new retriever is created with a new ID 5. Original retriever remains unchanged  **All fields except retriever_name are OPTIONAL:** - Omit a field to copy from source - Provide a field to override the source value
+     * @summary Clone Retriever
+     * @param {string} retrieverId Source retriever ID or name to clone.
+     * @param {CloneRetrieverRequest} cloneRetrieverRequest
+     * @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}
+     */
+    cloneRetriever: (retrieverId: string, cloneRetrieverRequest: CloneRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new retriever.  A retriever executes a series of stages to find and process documents from one or more collections.
+     * @summary Create Retriever
+     * @param {CreateRetrieverRequest} createRetrieverRequest
+     * @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}
+     */
+    createRetriever: (createRetrieverRequest: CreateRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a retriever and all its resources comprehensively.  Deletes: - Published retrievers - Execution history - Interactions (user feedback) - Evaluations - Cache entries - Retriever metadata  The deletion is performed synchronously and returns when complete.
+     * @summary Delete Retriever
+     * @param {string} retrieverId Retriever ID or name.
+     * @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}
+     */
+    deleteRetriever: (retrieverId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Execute a retriever and return matching documents. The pipeline is automatically optimized before execution for best performance.  **Automatic Optimization:** Your pipeline stages are automatically transformed for optimal performance: - Filters pushed down to reduce expensive operations - Redundant stages merged or eliminated - Grouping operations pushed to database layer (10-100x faster) - Operations reordered for efficiency  **Streaming Support:** Set stream=true in the request body to receive real-time stage updates via SSE: - Response uses text/event-stream content type - Each stage emits stage_start and stage_complete events - Final event contains complete results and pagination - Useful for progress tracking and debugging  **Response Includes (when stream=false):** - documents: Final matching documents - pagination: Pagination metadata - stage_statistics: Per-stage execution metrics - budget: Credit/time consumption - optimization_applied: Whether optimizations were applied - optimization_summary: Details about transformations (when applied)  **Optimization Summary Example:** ```json {   \"optimization_applied\": true,   \"optimization_summary\": {     \"original_stage_count\": 5,     \"optimized_stage_count\": 3,     \"optimization_time_ms\": 8.2,     \"rules_applied\": [\"push_down_filters\", \"group_by_push_down\"],     \"stage_reduction_pct\": 40.0   } } ```  Use the /explain endpoint to see the optimized execution plan before running.
+     * @summary Execute Retriever (Auto-Optimized)
+     * @param {string} retrieverId Retriever ID or name. Pipeline will be automatically optimized before execution.
+     * @param {ExecuteRetrieverRequest} executeRetrieverRequest
+     * @param {boolean} [returnPresignedUrls]
+     * @param {boolean} [returnVectors]
+     * @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}
+     */
+    executeRetriever: (retrieverId: string, executeRetrieverRequest: ExecuteRetrieverRequest, returnPresignedUrls?: boolean, returnVectors?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a detailed execution plan for a retriever without actually executing it. Similar to MongoDB\'s explain plan or SQL\'s EXPLAIN command, this endpoint helps you understand performance characteristics, identify bottlenecks, estimate costs, and troubleshoot retrieval issues before running expensive queries.  **What This Returns:** - Stage-by-stage execution plan (AFTER automatic optimizations) - Estimated costs (credits + time per stage) - Document flow projections (input/output counts per stage) - Efficiency metrics (selectivity ratios, cache likelihood) - Bottleneck identification (slowest/most expensive stages) - Optimization details (transformations applied by the optimizer) - Performance warnings and improvement suggestions   **Key Features:** - **Cost Estimation**: See how many credits and milliseconds each stage will consume - **Bottleneck Detection**: Identify which stages dominate execution time - **Optimization Transparency**: Understand how your pipeline was optimized - **Cache Analysis**: See which stages are likely to hit cache - **Accuracy Troubleshooting**: Analyze stage efficiency and document flow - **Latency Analysis**: Break down estimated duration by stage   **Important:** The execution_plan shows OPTIMIZED stages (after automatic transformations like filter push-down, stage fusion, and grouping optimization). Check optimization_details to understand what changed from your original configuration.   **Use Cases:** - Debug slow retrievers by identifying bottleneck stages - Estimate costs before running expensive queries - Understand how the optimizer transformed your pipeline - Troubleshoot accuracy issues by analyzing stage selectivity - Compare different retriever configurations - Plan budget allocation for production workloads   **Example Response:** ```json {   \"retriever_id\": \"ret_abc123\",   \"retriever_name\": \"product_search\",   \"execution_plan\": [     {       \"stage_index\": 0,       \"stage_name\": \"attribute_filter\",       \"stage_type\": \"filter\",       \"estimated_input\": 10000,       \"estimated_output\": 5000,       \"estimated_efficiency\": 0.5,       \"estimated_cost_credits\": 0.01,       \"estimated_duration_ms\": 20,       \"cache_likely\": true,       \"optimization_notes\": [\"Pushed down from stage 2\"],       \"warnings\": []     },     {       \"stage_index\": 1,       \"stage_name\": \"semantic_search\",       \"stage_type\": \"filter\",       \"estimated_input\": 5000,       \"estimated_output\": 100,       \"estimated_efficiency\": 0.02,       \"estimated_cost_credits\": 0.5,       \"estimated_duration_ms\": 200,       \"cache_likely\": false,       \"optimization_notes\": [],       \"warnings\": [\"High cost stage - consider reducing limit\"]     }   ],   \"estimated_cost\": {     \"total_credits\": 0.51,     \"total_duration_ms\": 220   },   \"bottleneck_stages\": [\"semantic_search\"],   \"optimization_applied\": true,   \"optimization_details\": {     \"original_stage_count\": 3,     \"optimized_stage_count\": 2,     \"optimization_time_ms\": 8.2,     \"stage_reduction_pct\": 33.3,     \"decisions\": [       {         \"rule_type\": \"push_down_filters\",         \"applied\": true,         \"reason\": \"Moved attribute_filter before semantic_search to reduce search scope\"       }     ]   },   \"optimization_suggestions\": [     {       \"type\": \"reduce_limit\",       \"stage\": \"semantic_search\",       \"message\": \"Consider reducing limit to improve latency\"     }   ] } ```
+     * @summary Explain Retriever Execution Plan
+     * @param {string} retrieverId Retriever ID or name to explain. The execution plan will show the OPTIMIZED version after automatic transformations.
+     * @param {ExplainRetrieverRequest} explainRetrieverRequest
+     * @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}
+     */
+    explainRetrieverExecutionIdExecute: (retrieverId: string, explainRetrieverRequest: ExplainRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get execution details and statistics.
+     * @summary Get Execution
+     * @param {string} retrieverId Retriever ID or name.
+     * @param {string} executionId Execution identifier.
+     * @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}
+     */
+    getExecutionRetrievers: (retrieverId: string, executionId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a retriever by ID or name.
+     * @summary Get Retriever
+     * @param {string} retrieverId Retriever ID or name.
+     * @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}
+     */
+    getRetriever: (retrieverId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List execution history for a retriever.
+     * @summary List Executions
+     * @param {string} retrieverId Retriever ID or name.
+     * @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 {ListExecutionsRequest} [listExecutionsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listExecutionsRetrievers: (retrieverId: string, limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listExecutionsRequest?: ListExecutionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all retrievers in the namespace.
+     * @summary List Retrievers
+     * @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 {ListRetrieversRequest} [listRetrieversRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrievers: (limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listRetrieversRequest?: ListRetrieversRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all retrievers in the namespace (GET alias for POST /list).
+     * @summary List Retrievers Get
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrieversGet: (limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a retriever\'s metadata.  Only metadata fields can be updated: - name: Rename the retriever - description: Update the description - tags: Update tags for organization - display_config: Update display configuration  Core logic (input_schema, stages, collection_ids) is immutable. To modify core logic, use POST /{retriever_id}/clone instead.
+     * @summary Patch Retriever
+     * @param {string} retrieverId Retriever ID or name.
+     * @param {PatchRetrieverRequest} patchRetrieverRequest
+     * @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}
+     */
+    patchRetriever: (retrieverId: string, patchRetrieverRequest: PatchRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * RetrieversApi - functional programming interface
+ * @export
+ */
+export declare const RetrieversApiFp: (configuration?: Configuration) => {
+    /**
+     * Clone a retriever with optional modifications.  **Purpose:** Creates a NEW retriever (with new ID) based on an existing one. This is the recommended way to iterate on retriever designs when you need to modify core logic that PATCH doesn\'t allow (stages, input_schema, collections).  **Clone vs PATCH vs Template:** - **PATCH**: Update metadata only (name, description, tags, display_config) - **Clone**: Copy and modify core logic (stages, input_schema, collections) - **Template**: Start from a pre-configured pattern (for new projects)  **Common Use Cases:** - Fix a typo in a stage name - Add or remove stages - Change target collections - Create variants (e.g., \"strict\" vs \"relaxed\" versions) - Test modifications before replacing production retriever  **How it works:** 1. Source retriever is copied 2. You provide a new name (REQUIRED) 3. Optionally override any other fields 4. A new retriever is created with a new ID 5. Original retriever remains unchanged  **All fields except retriever_name are OPTIONAL:** - Omit a field to copy from source - Provide a field to override the source value
+     * @summary Clone Retriever
+     * @param {string} retrieverId Source retriever ID or name to clone.
+     * @param {CloneRetrieverRequest} cloneRetrieverRequest
+     * @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}
+     */
+    cloneRetriever(retrieverId: string, cloneRetrieverRequest: CloneRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CloneRetrieverResponse>>;
+    /**
+     * Create a new retriever.  A retriever executes a series of stages to find and process documents from one or more collections.
+     * @summary Create Retriever
+     * @param {CreateRetrieverRequest} createRetrieverRequest
+     * @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}
+     */
+    createRetriever(createRetrieverRequest: CreateRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRetrieverResponse>>;
+    /**
+     * Delete a retriever and all its resources comprehensively.  Deletes: - Published retrievers - Execution history - Interactions (user feedback) - Evaluations - Cache entries - Retriever metadata  The deletion is performed synchronously and returns when complete.
+     * @summary Delete Retriever
+     * @param {string} retrieverId Retriever ID or name.
+     * @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}
+     */
+    deleteRetriever(retrieverId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Execute a retriever and return matching documents. The pipeline is automatically optimized before execution for best performance.  **Automatic Optimization:** Your pipeline stages are automatically transformed for optimal performance: - Filters pushed down to reduce expensive operations - Redundant stages merged or eliminated - Grouping operations pushed to database layer (10-100x faster) - Operations reordered for efficiency  **Streaming Support:** Set stream=true in the request body to receive real-time stage updates via SSE: - Response uses text/event-stream content type - Each stage emits stage_start and stage_complete events - Final event contains complete results and pagination - Useful for progress tracking and debugging  **Response Includes (when stream=false):** - documents: Final matching documents - pagination: Pagination metadata - stage_statistics: Per-stage execution metrics - budget: Credit/time consumption - optimization_applied: Whether optimizations were applied - optimization_summary: Details about transformations (when applied)  **Optimization Summary Example:** ```json {   \"optimization_applied\": true,   \"optimization_summary\": {     \"original_stage_count\": 5,     \"optimized_stage_count\": 3,     \"optimization_time_ms\": 8.2,     \"rules_applied\": [\"push_down_filters\", \"group_by_push_down\"],     \"stage_reduction_pct\": 40.0   } } ```  Use the /explain endpoint to see the optimized execution plan before running.
+     * @summary Execute Retriever (Auto-Optimized)
+     * @param {string} retrieverId Retriever ID or name. Pipeline will be automatically optimized before execution.
+     * @param {ExecuteRetrieverRequest} executeRetrieverRequest
+     * @param {boolean} [returnPresignedUrls]
+     * @param {boolean} [returnVectors]
+     * @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}
+     */
+    executeRetriever(retrieverId: string, executeRetrieverRequest: ExecuteRetrieverRequest, returnPresignedUrls?: boolean, returnVectors?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Get a detailed execution plan for a retriever without actually executing it. Similar to MongoDB\'s explain plan or SQL\'s EXPLAIN command, this endpoint helps you understand performance characteristics, identify bottlenecks, estimate costs, and troubleshoot retrieval issues before running expensive queries.  **What This Returns:** - Stage-by-stage execution plan (AFTER automatic optimizations) - Estimated costs (credits + time per stage) - Document flow projections (input/output counts per stage) - Efficiency metrics (selectivity ratios, cache likelihood) - Bottleneck identification (slowest/most expensive stages) - Optimization details (transformations applied by the optimizer) - Performance warnings and improvement suggestions   **Key Features:** - **Cost Estimation**: See how many credits and milliseconds each stage will consume - **Bottleneck Detection**: Identify which stages dominate execution time - **Optimization Transparency**: Understand how your pipeline was optimized - **Cache Analysis**: See which stages are likely to hit cache - **Accuracy Troubleshooting**: Analyze stage efficiency and document flow - **Latency Analysis**: Break down estimated duration by stage   **Important:** The execution_plan shows OPTIMIZED stages (after automatic transformations like filter push-down, stage fusion, and grouping optimization). Check optimization_details to understand what changed from your original configuration.   **Use Cases:** - Debug slow retrievers by identifying bottleneck stages - Estimate costs before running expensive queries - Understand how the optimizer transformed your pipeline - Troubleshoot accuracy issues by analyzing stage selectivity - Compare different retriever configurations - Plan budget allocation for production workloads   **Example Response:** ```json {   \"retriever_id\": \"ret_abc123\",   \"retriever_name\": \"product_search\",   \"execution_plan\": [     {       \"stage_index\": 0,       \"stage_name\": \"attribute_filter\",       \"stage_type\": \"filter\",       \"estimated_input\": 10000,       \"estimated_output\": 5000,       \"estimated_efficiency\": 0.5,       \"estimated_cost_credits\": 0.01,       \"estimated_duration_ms\": 20,       \"cache_likely\": true,       \"optimization_notes\": [\"Pushed down from stage 2\"],       \"warnings\": []     },     {       \"stage_index\": 1,       \"stage_name\": \"semantic_search\",       \"stage_type\": \"filter\",       \"estimated_input\": 5000,       \"estimated_output\": 100,       \"estimated_efficiency\": 0.02,       \"estimated_cost_credits\": 0.5,       \"estimated_duration_ms\": 200,       \"cache_likely\": false,       \"optimization_notes\": [],       \"warnings\": [\"High cost stage - consider reducing limit\"]     }   ],   \"estimated_cost\": {     \"total_credits\": 0.51,     \"total_duration_ms\": 220   },   \"bottleneck_stages\": [\"semantic_search\"],   \"optimization_applied\": true,   \"optimization_details\": {     \"original_stage_count\": 3,     \"optimized_stage_count\": 2,     \"optimization_time_ms\": 8.2,     \"stage_reduction_pct\": 33.3,     \"decisions\": [       {         \"rule_type\": \"push_down_filters\",         \"applied\": true,         \"reason\": \"Moved attribute_filter before semantic_search to reduce search scope\"       }     ]   },   \"optimization_suggestions\": [     {       \"type\": \"reduce_limit\",       \"stage\": \"semantic_search\",       \"message\": \"Consider reducing limit to improve latency\"     }   ] } ```
+     * @summary Explain Retriever Execution Plan
+     * @param {string} retrieverId Retriever ID or name to explain. The execution plan will show the OPTIMIZED version after automatic transformations.
+     * @param {ExplainRetrieverRequest} explainRetrieverRequest
+     * @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}
+     */
+    explainRetrieverExecutionIdExecute(retrieverId: string, explainRetrieverRequest: ExplainRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExplainRetrieverResponse>>;
+    /**
+     * Get execution details and statistics.
+     * @summary Get Execution
+     * @param {string} retrieverId Retriever ID or name.
+     * @param {string} executionId Execution identifier.
+     * @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}
+     */
+    getExecutionRetrievers(retrieverId: string, executionId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecutionDetail>>;
+    /**
+     * Get a retriever by ID or name.
+     * @summary Get Retriever
+     * @param {string} retrieverId Retriever ID or name.
+     * @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}
+     */
+    getRetriever(retrieverId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieverModelOutput>>;
+    /**
+     * List execution history for a retriever.
+     * @summary List Executions
+     * @param {string} retrieverId Retriever ID or name.
+     * @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 {ListExecutionsRequest} [listExecutionsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listExecutionsRetrievers(retrieverId: string, limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listExecutionsRequest?: ListExecutionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListExecutionsResponse>>;
+    /**
+     * List all retrievers in the namespace.
+     * @summary List Retrievers
+     * @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 {ListRetrieversRequest} [listRetrieversRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrievers(limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listRetrieversRequest?: ListRetrieversRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRetrieversResponse>>;
+    /**
+     * List all retrievers in the namespace (GET alias for POST /list).
+     * @summary List Retrievers Get
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrieversGet(limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRetrieversResponse>>;
+    /**
+     * Update a retriever\'s metadata.  Only metadata fields can be updated: - name: Rename the retriever - description: Update the description - tags: Update tags for organization - display_config: Update display configuration  Core logic (input_schema, stages, collection_ids) is immutable. To modify core logic, use POST /{retriever_id}/clone instead.
+     * @summary Patch Retriever
+     * @param {string} retrieverId Retriever ID or name.
+     * @param {PatchRetrieverRequest} patchRetrieverRequest
+     * @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}
+     */
+    patchRetriever(retrieverId: string, patchRetrieverRequest: PatchRetrieverRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchRetrieverResponse>>;
+};
+/**
+ * RetrieversApi - factory interface
+ * @export
+ */
+export declare const RetrieversApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Clone a retriever with optional modifications.  **Purpose:** Creates a NEW retriever (with new ID) based on an existing one. This is the recommended way to iterate on retriever designs when you need to modify core logic that PATCH doesn\'t allow (stages, input_schema, collections).  **Clone vs PATCH vs Template:** - **PATCH**: Update metadata only (name, description, tags, display_config) - **Clone**: Copy and modify core logic (stages, input_schema, collections) - **Template**: Start from a pre-configured pattern (for new projects)  **Common Use Cases:** - Fix a typo in a stage name - Add or remove stages - Change target collections - Create variants (e.g., \"strict\" vs \"relaxed\" versions) - Test modifications before replacing production retriever  **How it works:** 1. Source retriever is copied 2. You provide a new name (REQUIRED) 3. Optionally override any other fields 4. A new retriever is created with a new ID 5. Original retriever remains unchanged  **All fields except retriever_name are OPTIONAL:** - Omit a field to copy from source - Provide a field to override the source value
+     * @summary Clone Retriever
+     * @param {RetrieversApiCloneRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cloneRetriever(requestParameters: RetrieversApiCloneRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<CloneRetrieverResponse>;
+    /**
+     * Create a new retriever.  A retriever executes a series of stages to find and process documents from one or more collections.
+     * @summary Create Retriever
+     * @param {RetrieversApiCreateRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createRetriever(requestParameters: RetrieversApiCreateRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateRetrieverResponse>;
+    /**
+     * Delete a retriever and all its resources comprehensively.  Deletes: - Published retrievers - Execution history - Interactions (user feedback) - Evaluations - Cache entries - Retriever metadata  The deletion is performed synchronously and returns when complete.
+     * @summary Delete Retriever
+     * @param {RetrieversApiDeleteRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteRetriever(requestParameters: RetrieversApiDeleteRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Execute a retriever and return matching documents. The pipeline is automatically optimized before execution for best performance.  **Automatic Optimization:** Your pipeline stages are automatically transformed for optimal performance: - Filters pushed down to reduce expensive operations - Redundant stages merged or eliminated - Grouping operations pushed to database layer (10-100x faster) - Operations reordered for efficiency  **Streaming Support:** Set stream=true in the request body to receive real-time stage updates via SSE: - Response uses text/event-stream content type - Each stage emits stage_start and stage_complete events - Final event contains complete results and pagination - Useful for progress tracking and debugging  **Response Includes (when stream=false):** - documents: Final matching documents - pagination: Pagination metadata - stage_statistics: Per-stage execution metrics - budget: Credit/time consumption - optimization_applied: Whether optimizations were applied - optimization_summary: Details about transformations (when applied)  **Optimization Summary Example:** ```json {   \"optimization_applied\": true,   \"optimization_summary\": {     \"original_stage_count\": 5,     \"optimized_stage_count\": 3,     \"optimization_time_ms\": 8.2,     \"rules_applied\": [\"push_down_filters\", \"group_by_push_down\"],     \"stage_reduction_pct\": 40.0   } } ```  Use the /explain endpoint to see the optimized execution plan before running.
+     * @summary Execute Retriever (Auto-Optimized)
+     * @param {RetrieversApiExecuteRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeRetriever(requestParameters: RetrieversApiExecuteRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Get a detailed execution plan for a retriever without actually executing it. Similar to MongoDB\'s explain plan or SQL\'s EXPLAIN command, this endpoint helps you understand performance characteristics, identify bottlenecks, estimate costs, and troubleshoot retrieval issues before running expensive queries.  **What This Returns:** - Stage-by-stage execution plan (AFTER automatic optimizations) - Estimated costs (credits + time per stage) - Document flow projections (input/output counts per stage) - Efficiency metrics (selectivity ratios, cache likelihood) - Bottleneck identification (slowest/most expensive stages) - Optimization details (transformations applied by the optimizer) - Performance warnings and improvement suggestions   **Key Features:** - **Cost Estimation**: See how many credits and milliseconds each stage will consume - **Bottleneck Detection**: Identify which stages dominate execution time - **Optimization Transparency**: Understand how your pipeline was optimized - **Cache Analysis**: See which stages are likely to hit cache - **Accuracy Troubleshooting**: Analyze stage efficiency and document flow - **Latency Analysis**: Break down estimated duration by stage   **Important:** The execution_plan shows OPTIMIZED stages (after automatic transformations like filter push-down, stage fusion, and grouping optimization). Check optimization_details to understand what changed from your original configuration.   **Use Cases:** - Debug slow retrievers by identifying bottleneck stages - Estimate costs before running expensive queries - Understand how the optimizer transformed your pipeline - Troubleshoot accuracy issues by analyzing stage selectivity - Compare different retriever configurations - Plan budget allocation for production workloads   **Example Response:** ```json {   \"retriever_id\": \"ret_abc123\",   \"retriever_name\": \"product_search\",   \"execution_plan\": [     {       \"stage_index\": 0,       \"stage_name\": \"attribute_filter\",       \"stage_type\": \"filter\",       \"estimated_input\": 10000,       \"estimated_output\": 5000,       \"estimated_efficiency\": 0.5,       \"estimated_cost_credits\": 0.01,       \"estimated_duration_ms\": 20,       \"cache_likely\": true,       \"optimization_notes\": [\"Pushed down from stage 2\"],       \"warnings\": []     },     {       \"stage_index\": 1,       \"stage_name\": \"semantic_search\",       \"stage_type\": \"filter\",       \"estimated_input\": 5000,       \"estimated_output\": 100,       \"estimated_efficiency\": 0.02,       \"estimated_cost_credits\": 0.5,       \"estimated_duration_ms\": 200,       \"cache_likely\": false,       \"optimization_notes\": [],       \"warnings\": [\"High cost stage - consider reducing limit\"]     }   ],   \"estimated_cost\": {     \"total_credits\": 0.51,     \"total_duration_ms\": 220   },   \"bottleneck_stages\": [\"semantic_search\"],   \"optimization_applied\": true,   \"optimization_details\": {     \"original_stage_count\": 3,     \"optimized_stage_count\": 2,     \"optimization_time_ms\": 8.2,     \"stage_reduction_pct\": 33.3,     \"decisions\": [       {         \"rule_type\": \"push_down_filters\",         \"applied\": true,         \"reason\": \"Moved attribute_filter before semantic_search to reduce search scope\"       }     ]   },   \"optimization_suggestions\": [     {       \"type\": \"reduce_limit\",       \"stage\": \"semantic_search\",       \"message\": \"Consider reducing limit to improve latency\"     }   ] } ```
+     * @summary Explain Retriever Execution Plan
+     * @param {RetrieversApiExplainRetrieverExecutionIdExecuteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    explainRetrieverExecutionIdExecute(requestParameters: RetrieversApiExplainRetrieverExecutionIdExecuteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExplainRetrieverResponse>;
+    /**
+     * Get execution details and statistics.
+     * @summary Get Execution
+     * @param {RetrieversApiGetExecutionRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getExecutionRetrievers(requestParameters: RetrieversApiGetExecutionRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecutionDetail>;
+    /**
+     * Get a retriever by ID or name.
+     * @summary Get Retriever
+     * @param {RetrieversApiGetRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRetriever(requestParameters: RetrieversApiGetRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetrieverModelOutput>;
+    /**
+     * List execution history for a retriever.
+     * @summary List Executions
+     * @param {RetrieversApiListExecutionsRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listExecutionsRetrievers(requestParameters: RetrieversApiListExecutionsRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListExecutionsResponse>;
+    /**
+     * List all retrievers in the namespace.
+     * @summary List Retrievers
+     * @param {RetrieversApiListRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrievers(requestParameters?: RetrieversApiListRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListRetrieversResponse>;
+    /**
+     * List all retrievers in the namespace (GET alias for POST /list).
+     * @summary List Retrievers Get
+     * @param {RetrieversApiListRetrieversGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listRetrieversGet(requestParameters?: RetrieversApiListRetrieversGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListRetrieversResponse>;
+    /**
+     * Update a retriever\'s metadata.  Only metadata fields can be updated: - name: Rename the retriever - description: Update the description - tags: Update tags for organization - display_config: Update display configuration  Core logic (input_schema, stages, collection_ids) is immutable. To modify core logic, use POST /{retriever_id}/clone instead.
+     * @summary Patch Retriever
+     * @param {RetrieversApiPatchRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchRetriever(requestParameters: RetrieversApiPatchRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<PatchRetrieverResponse>;
+};
+/**
+ * Request parameters for cloneRetriever operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiCloneRetrieverRequest
+ */
+export interface RetrieversApiCloneRetrieverRequest {
+    /**
+     * Source retriever ID or name to clone.
+     * @type {string}
+     * @memberof RetrieversApiCloneRetriever
+     */
+    readonly retrieverId: string;
+    /**
+     *
+     * @type {CloneRetrieverRequest}
+     * @memberof RetrieversApiCloneRetriever
+     */
+    readonly cloneRetrieverRequest: CloneRetrieverRequest;
+    /**
+     * 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 RetrieversApiCloneRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiCloneRetriever
+     */
+    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 RetrieversApiCloneRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createRetriever operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiCreateRetrieverRequest
+ */
+export interface RetrieversApiCreateRetrieverRequest {
+    /**
+     *
+     * @type {CreateRetrieverRequest}
+     * @memberof RetrieversApiCreateRetriever
+     */
+    readonly createRetrieverRequest: CreateRetrieverRequest;
+    /**
+     * 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 RetrieversApiCreateRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiCreateRetriever
+     */
+    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 RetrieversApiCreateRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for deleteRetriever operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiDeleteRetrieverRequest
+ */
+export interface RetrieversApiDeleteRetrieverRequest {
+    /**
+     * Retriever ID or name.
+     * @type {string}
+     * @memberof RetrieversApiDeleteRetriever
+     */
+    readonly retrieverId: 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 RetrieversApiDeleteRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiDeleteRetriever
+     */
+    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 RetrieversApiDeleteRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for executeRetriever operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiExecuteRetrieverRequest
+ */
+export interface RetrieversApiExecuteRetrieverRequest {
+    /**
+     * Retriever ID or name. Pipeline will be automatically optimized before execution.
+     * @type {string}
+     * @memberof RetrieversApiExecuteRetriever
+     */
+    readonly retrieverId: string;
+    /**
+     *
+     * @type {ExecuteRetrieverRequest}
+     * @memberof RetrieversApiExecuteRetriever
+     */
+    readonly executeRetrieverRequest: ExecuteRetrieverRequest;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RetrieversApiExecuteRetriever
+     */
+    readonly returnPresignedUrls?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RetrieversApiExecuteRetriever
+     */
+    readonly returnVectors?: 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 RetrieversApiExecuteRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiExecuteRetriever
+     */
+    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 RetrieversApiExecuteRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for explainRetrieverExecutionIdExecute operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiExplainRetrieverExecutionIdExecuteRequest
+ */
+export interface RetrieversApiExplainRetrieverExecutionIdExecuteRequest {
+    /**
+     * Retriever ID or name to explain. The execution plan will show the OPTIMIZED version after automatic transformations.
+     * @type {string}
+     * @memberof RetrieversApiExplainRetrieverExecutionIdExecute
+     */
+    readonly retrieverId: string;
+    /**
+     *
+     * @type {ExplainRetrieverRequest}
+     * @memberof RetrieversApiExplainRetrieverExecutionIdExecute
+     */
+    readonly explainRetrieverRequest: ExplainRetrieverRequest;
+    /**
+     * 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 RetrieversApiExplainRetrieverExecutionIdExecute
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiExplainRetrieverExecutionIdExecute
+     */
+    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 RetrieversApiExplainRetrieverExecutionIdExecute
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getExecutionRetrievers operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiGetExecutionRetrieversRequest
+ */
+export interface RetrieversApiGetExecutionRetrieversRequest {
+    /**
+     * Retriever ID or name.
+     * @type {string}
+     * @memberof RetrieversApiGetExecutionRetrievers
+     */
+    readonly retrieverId: string;
+    /**
+     * Execution identifier.
+     * @type {string}
+     * @memberof RetrieversApiGetExecutionRetrievers
+     */
+    readonly executionId: 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 RetrieversApiGetExecutionRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiGetExecutionRetrievers
+     */
+    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 RetrieversApiGetExecutionRetrievers
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getRetriever operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiGetRetrieverRequest
+ */
+export interface RetrieversApiGetRetrieverRequest {
+    /**
+     * Retriever ID or name.
+     * @type {string}
+     * @memberof RetrieversApiGetRetriever
+     */
+    readonly retrieverId: 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 RetrieversApiGetRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiGetRetriever
+     */
+    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 RetrieversApiGetRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listExecutionsRetrievers operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiListExecutionsRetrieversRequest
+ */
+export interface RetrieversApiListExecutionsRetrieversRequest {
+    /**
+     * Retriever ID or name.
+     * @type {string}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    readonly retrieverId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    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 RetrieversApiListExecutionsRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    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 RetrieversApiListExecutionsRetrievers
+     */
+    readonly xNamespace?: string;
+    /**
+     *
+     * @type {ListExecutionsRequest}
+     * @memberof RetrieversApiListExecutionsRetrievers
+     */
+    readonly listExecutionsRequest?: ListExecutionsRequest;
+}
+/**
+ * Request parameters for listRetrievers operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiListRetrieversRequest
+ */
+export interface RetrieversApiListRetrieversRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof RetrieversApiListRetrievers
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RetrieversApiListRetrievers
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiListRetrievers
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RetrieversApiListRetrievers
+     */
+    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 RetrieversApiListRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiListRetrievers
+     */
+    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 RetrieversApiListRetrievers
+     */
+    readonly xNamespace?: string;
+    /**
+     *
+     * @type {ListRetrieversRequest}
+     * @memberof RetrieversApiListRetrievers
+     */
+    readonly listRetrieversRequest?: ListRetrieversRequest;
+}
+/**
+ * Request parameters for listRetrieversGet operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiListRetrieversGetRequest
+ */
+export interface RetrieversApiListRetrieversGetRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof RetrieversApiListRetrieversGet
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RetrieversApiListRetrieversGet
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiListRetrieversGet
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RetrieversApiListRetrieversGet
+     */
+    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 RetrieversApiListRetrieversGet
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiListRetrieversGet
+     */
+    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 RetrieversApiListRetrieversGet
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for patchRetriever operation in RetrieversApi.
+ * @export
+ * @interface RetrieversApiPatchRetrieverRequest
+ */
+export interface RetrieversApiPatchRetrieverRequest {
+    /**
+     * Retriever ID or name.
+     * @type {string}
+     * @memberof RetrieversApiPatchRetriever
+     */
+    readonly retrieverId: string;
+    /**
+     *
+     * @type {PatchRetrieverRequest}
+     * @memberof RetrieversApiPatchRetriever
+     */
+    readonly patchRetrieverRequest: PatchRetrieverRequest;
+    /**
+     * 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 RetrieversApiPatchRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieversApiPatchRetriever
+     */
+    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 RetrieversApiPatchRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * RetrieversApi - object-oriented interface
+ * @export
+ * @class RetrieversApi
+ * @extends {BaseAPI}
+ */
+export declare class RetrieversApi extends BaseAPI {
+    /**
+     * Clone a retriever with optional modifications.  **Purpose:** Creates a NEW retriever (with new ID) based on an existing one. This is the recommended way to iterate on retriever designs when you need to modify core logic that PATCH doesn\'t allow (stages, input_schema, collections).  **Clone vs PATCH vs Template:** - **PATCH**: Update metadata only (name, description, tags, display_config) - **Clone**: Copy and modify core logic (stages, input_schema, collections) - **Template**: Start from a pre-configured pattern (for new projects)  **Common Use Cases:** - Fix a typo in a stage name - Add or remove stages - Change target collections - Create variants (e.g., \"strict\" vs \"relaxed\" versions) - Test modifications before replacing production retriever  **How it works:** 1. Source retriever is copied 2. You provide a new name (REQUIRED) 3. Optionally override any other fields 4. A new retriever is created with a new ID 5. Original retriever remains unchanged  **All fields except retriever_name are OPTIONAL:** - Omit a field to copy from source - Provide a field to override the source value
+     * @summary Clone Retriever
+     * @param {RetrieversApiCloneRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    cloneRetriever(requestParameters: RetrieversApiCloneRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CloneRetrieverResponse, any, {}>>;
+    /**
+     * Create a new retriever.  A retriever executes a series of stages to find and process documents from one or more collections.
+     * @summary Create Retriever
+     * @param {RetrieversApiCreateRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    createRetriever(requestParameters: RetrieversApiCreateRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRetrieverResponse, any, {}>>;
+    /**
+     * Delete a retriever and all its resources comprehensively.  Deletes: - Published retrievers - Execution history - Interactions (user feedback) - Evaluations - Cache entries - Retriever metadata  The deletion is performed synchronously and returns when complete.
+     * @summary Delete Retriever
+     * @param {RetrieversApiDeleteRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    deleteRetriever(requestParameters: RetrieversApiDeleteRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Execute a retriever and return matching documents. The pipeline is automatically optimized before execution for best performance.  **Automatic Optimization:** Your pipeline stages are automatically transformed for optimal performance: - Filters pushed down to reduce expensive operations - Redundant stages merged or eliminated - Grouping operations pushed to database layer (10-100x faster) - Operations reordered for efficiency  **Streaming Support:** Set stream=true in the request body to receive real-time stage updates via SSE: - Response uses text/event-stream content type - Each stage emits stage_start and stage_complete events - Final event contains complete results and pagination - Useful for progress tracking and debugging  **Response Includes (when stream=false):** - documents: Final matching documents - pagination: Pagination metadata - stage_statistics: Per-stage execution metrics - budget: Credit/time consumption - optimization_applied: Whether optimizations were applied - optimization_summary: Details about transformations (when applied)  **Optimization Summary Example:** ```json {   \"optimization_applied\": true,   \"optimization_summary\": {     \"original_stage_count\": 5,     \"optimized_stage_count\": 3,     \"optimization_time_ms\": 8.2,     \"rules_applied\": [\"push_down_filters\", \"group_by_push_down\"],     \"stage_reduction_pct\": 40.0   } } ```  Use the /explain endpoint to see the optimized execution plan before running.
+     * @summary Execute Retriever (Auto-Optimized)
+     * @param {RetrieversApiExecuteRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    executeRetriever(requestParameters: RetrieversApiExecuteRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Get a detailed execution plan for a retriever without actually executing it. Similar to MongoDB\'s explain plan or SQL\'s EXPLAIN command, this endpoint helps you understand performance characteristics, identify bottlenecks, estimate costs, and troubleshoot retrieval issues before running expensive queries.  **What This Returns:** - Stage-by-stage execution plan (AFTER automatic optimizations) - Estimated costs (credits + time per stage) - Document flow projections (input/output counts per stage) - Efficiency metrics (selectivity ratios, cache likelihood) - Bottleneck identification (slowest/most expensive stages) - Optimization details (transformations applied by the optimizer) - Performance warnings and improvement suggestions   **Key Features:** - **Cost Estimation**: See how many credits and milliseconds each stage will consume - **Bottleneck Detection**: Identify which stages dominate execution time - **Optimization Transparency**: Understand how your pipeline was optimized - **Cache Analysis**: See which stages are likely to hit cache - **Accuracy Troubleshooting**: Analyze stage efficiency and document flow - **Latency Analysis**: Break down estimated duration by stage   **Important:** The execution_plan shows OPTIMIZED stages (after automatic transformations like filter push-down, stage fusion, and grouping optimization). Check optimization_details to understand what changed from your original configuration.   **Use Cases:** - Debug slow retrievers by identifying bottleneck stages - Estimate costs before running expensive queries - Understand how the optimizer transformed your pipeline - Troubleshoot accuracy issues by analyzing stage selectivity - Compare different retriever configurations - Plan budget allocation for production workloads   **Example Response:** ```json {   \"retriever_id\": \"ret_abc123\",   \"retriever_name\": \"product_search\",   \"execution_plan\": [     {       \"stage_index\": 0,       \"stage_name\": \"attribute_filter\",       \"stage_type\": \"filter\",       \"estimated_input\": 10000,       \"estimated_output\": 5000,       \"estimated_efficiency\": 0.5,       \"estimated_cost_credits\": 0.01,       \"estimated_duration_ms\": 20,       \"cache_likely\": true,       \"optimization_notes\": [\"Pushed down from stage 2\"],       \"warnings\": []     },     {       \"stage_index\": 1,       \"stage_name\": \"semantic_search\",       \"stage_type\": \"filter\",       \"estimated_input\": 5000,       \"estimated_output\": 100,       \"estimated_efficiency\": 0.02,       \"estimated_cost_credits\": 0.5,       \"estimated_duration_ms\": 200,       \"cache_likely\": false,       \"optimization_notes\": [],       \"warnings\": [\"High cost stage - consider reducing limit\"]     }   ],   \"estimated_cost\": {     \"total_credits\": 0.51,     \"total_duration_ms\": 220   },   \"bottleneck_stages\": [\"semantic_search\"],   \"optimization_applied\": true,   \"optimization_details\": {     \"original_stage_count\": 3,     \"optimized_stage_count\": 2,     \"optimization_time_ms\": 8.2,     \"stage_reduction_pct\": 33.3,     \"decisions\": [       {         \"rule_type\": \"push_down_filters\",         \"applied\": true,         \"reason\": \"Moved attribute_filter before semantic_search to reduce search scope\"       }     ]   },   \"optimization_suggestions\": [     {       \"type\": \"reduce_limit\",       \"stage\": \"semantic_search\",       \"message\": \"Consider reducing limit to improve latency\"     }   ] } ```
+     * @summary Explain Retriever Execution Plan
+     * @param {RetrieversApiExplainRetrieverExecutionIdExecuteRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    explainRetrieverExecutionIdExecute(requestParameters: RetrieversApiExplainRetrieverExecutionIdExecuteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExplainRetrieverResponse, any, {}>>;
+    /**
+     * Get execution details and statistics.
+     * @summary Get Execution
+     * @param {RetrieversApiGetExecutionRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    getExecutionRetrievers(requestParameters: RetrieversApiGetExecutionRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecutionDetail, any, {}>>;
+    /**
+     * Get a retriever by ID or name.
+     * @summary Get Retriever
+     * @param {RetrieversApiGetRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    getRetriever(requestParameters: RetrieversApiGetRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieverModelOutput, any, {}>>;
+    /**
+     * List execution history for a retriever.
+     * @summary List Executions
+     * @param {RetrieversApiListExecutionsRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    listExecutionsRetrievers(requestParameters: RetrieversApiListExecutionsRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListExecutionsResponse, any, {}>>;
+    /**
+     * List all retrievers in the namespace.
+     * @summary List Retrievers
+     * @param {RetrieversApiListRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    listRetrievers(requestParameters?: RetrieversApiListRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRetrieversResponse, any, {}>>;
+    /**
+     * List all retrievers in the namespace (GET alias for POST /list).
+     * @summary List Retrievers Get
+     * @param {RetrieversApiListRetrieversGetRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    listRetrieversGet(requestParameters?: RetrieversApiListRetrieversGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRetrieversResponse, any, {}>>;
+    /**
+     * Update a retriever\'s metadata.  Only metadata fields can be updated: - name: Rename the retriever - description: Update the description - tags: Update tags for organization - display_config: Update display configuration  Core logic (input_schema, stages, collection_ids) is immutable. To modify core logic, use POST /{retriever_id}/clone instead.
+     * @summary Patch Retriever
+     * @param {RetrieversApiPatchRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieversApi
+     */
+    patchRetriever(requestParameters: RetrieversApiPatchRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchRetrieverResponse, any, {}>>;
+}
+//# sourceMappingURL=retrievers-api.d.ts.map