mixpeek 0.81.382 → 0.81.384

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,7 +22,7 @@ import type { ListAdhocExecutionsResponse } from '../models';
22
22
  */
23
23
  export declare const AdhocRetrieversApiAxiosParamCreator: (configuration?: Configuration) => {
24
24
  /**
25
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
25
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
26
26
  * @summary Execute Adhoc Retriever
27
27
  * @param {AdhocExecuteRequest} adhocExecuteRequest
28
28
  * @param {boolean} [returnPresignedUrls]
@@ -62,7 +62,7 @@ export declare const AdhocRetrieversApiAxiosParamCreator: (configuration?: Confi
62
62
  */
63
63
  export declare const AdhocRetrieversApiFp: (configuration?: Configuration) => {
64
64
  /**
65
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
65
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
66
66
  * @summary Execute Adhoc Retriever
67
67
  * @param {AdhocExecuteRequest} adhocExecuteRequest
68
68
  * @param {boolean} [returnPresignedUrls]
@@ -102,7 +102,7 @@ export declare const AdhocRetrieversApiFp: (configuration?: Configuration) => {
102
102
  */
103
103
  export declare const AdhocRetrieversApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
104
104
  /**
105
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
105
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
106
106
  * @summary Execute Adhoc Retriever
107
107
  * @param {AdhocRetrieversApiExecuteAdhocRetrieverRequest} requestParameters Request parameters.
108
108
  * @param {*} [options] Override http request option.
@@ -233,7 +233,7 @@ export interface AdhocRetrieversApiListAdhocExecutionsRetrieversRequest {
233
233
  */
234
234
  export declare class AdhocRetrieversApi extends BaseAPI {
235
235
  /**
236
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
236
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
237
237
  * @summary Execute Adhoc Retriever
238
238
  * @param {AdhocRetrieversApiExecuteAdhocRetrieverRequest} requestParameters Request parameters.
239
239
  * @param {*} [options] Override http request option.
@@ -176,7 +176,7 @@ export declare const RetrieversApiAxiosParamCreator: (configuration?: Configurat
176
176
  */
177
177
  listRetrieversGet: (limit?: number, pageSize?: number, offset?: number, page?: number, cursor?: string, nextCursor?: string, after?: string, includeTotal?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
178
178
  /**
179
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
179
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
180
180
  * @summary Patch Retriever
181
181
  * @param {string} retrieverId Retriever ID or name.
182
182
  * @param {PatchRetrieverRequest} patchRetrieverRequest
@@ -337,7 +337,7 @@ export declare const RetrieversApiFp: (configuration?: Configuration) => {
337
337
  */
338
338
  listRetrieversGet(limit?: number, pageSize?: number, offset?: number, page?: number, cursor?: string, nextCursor?: string, after?: string, includeTotal?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRetrieversResponse>>;
339
339
  /**
340
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
340
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
341
341
  * @summary Patch Retriever
342
342
  * @param {string} retrieverId Retriever ID or name.
343
343
  * @param {PatchRetrieverRequest} patchRetrieverRequest
@@ -460,7 +460,7 @@ export declare const RetrieversApiFactory: (configuration?: Configuration, baseP
460
460
  */
461
461
  listRetrieversGet(requestParameters?: RetrieversApiListRetrieversGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListRetrieversResponse>;
462
462
  /**
463
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
463
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
464
464
  * @summary Patch Retriever
465
465
  * @param {RetrieversApiPatchRetrieverRequest} requestParameters Request parameters.
466
466
  * @param {*} [options] Override http request option.
@@ -1013,7 +1013,7 @@ export declare class RetrieversApi extends BaseAPI {
1013
1013
  */
1014
1014
  listRetrieversGet(requestParameters?: RetrieversApiListRetrieversGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRetrieversResponse, any, {}>>;
1015
1015
  /**
1016
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
1016
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
1017
1017
  * @summary Patch Retriever
1018
1018
  * @param {RetrieversApiPatchRetrieverRequest} requestParameters Request parameters.
1019
1019
  * @param {*} [options] Override http request option.
package/dist/index.js CHANGED
@@ -119,7 +119,7 @@ var createRequestFunction = function(axiosArgs, globalAxios100, BASE_PATH2, conf
119
119
  var AdhocRetrieversApiAxiosParamCreator = function(configuration) {
120
120
  return {
121
121
  /**
122
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
122
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
123
123
  * @summary Execute Adhoc Retriever
124
124
  * @param {AdhocExecuteRequest} adhocExecuteRequest
125
125
  * @param {boolean} [returnPresignedUrls]
@@ -251,7 +251,7 @@ var AdhocRetrieversApiFp = function(configuration) {
251
251
  const localVarAxiosParamCreator = AdhocRetrieversApiAxiosParamCreator(configuration);
252
252
  return {
253
253
  /**
254
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
254
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
255
255
  * @summary Execute Adhoc Retriever
256
256
  * @param {AdhocExecuteRequest} adhocExecuteRequest
257
257
  * @param {boolean} [returnPresignedUrls]
@@ -303,7 +303,7 @@ var AdhocRetrieversApiFp = function(configuration) {
303
303
  };
304
304
  var AdhocRetrieversApi = class extends BaseAPI {
305
305
  /**
306
- * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching (MI-4726): ad-hoc executions are ALWAYS fresh — this route never reads or writes the execute/stage cache (``cache_status`` is always ``disabled``), so there is no ``skip_cache`` parameter and none is needed. If you want caching with an explicit opt-out, persist the retriever (``POST /retrievers``) and call its ``/retrievers/{id}/execute`` route, which accepts ``skip_cache`` in both the query string and the body. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
306
+ * Execute a retriever ad-hoc without persisting the configuration. This endpoint allows you to execute a retriever without saving it to the database. Useful for one-time queries, testing configurations, or temporary searches. Caching: this route does not use the retriever-level execute cache, so ``cache_status`` is always ``disabled`` and there is no ``skip_cache`` parameter. That does NOT mean every response is freshly computed. Individual stages keep their own caches, which this route cannot switch off, so a stage may serve a cached result and report ``cache_hit: true`` under ``stage_statistics.stages[*]`` on a response whose top-level ``cache_status`` reads ``disabled``. The two fields describe different caches. If you need a guaranteed fresh execution, persist the retriever (``POST /retrievers``) and call ``/retrievers/{id}/execute`` with ``skip_cache``, which this route lacks and which does reach the stages. Streaming Execution (stream=True): Response uses Server-Sent Events (SSE) format with Content-Type: text/event-stream. Each stage emits events as it executes, formatted as: data: {json}\\n\\n Event Types (StreamEventType): - stage_start: Emitted when a stage begins (includes stage_name, stage_index, total_stages) - stage_complete: Emitted when a stage finishes (includes documents, statistics, budget_used) - stage_error: Emitted if a stage fails (includes error message) - execution_complete: Final event with complete results and pagination - execution_error: Emitted if entire execution fails StreamStageEvent Fields: - event_type: Type of event - execution_id: Unique execution identifier - stage_name/stage_index/total_stages: Stage progress info - documents: Intermediate results (stage_complete only) - statistics: Stage metrics (duration_ms, input_count, output_count, efficiency) - budget_used: Cumulative consumption (credits_used, time_elapsed_ms, tokens_used) Response Headers: - Content-Type: text/event-stream - Cache-Control: no-cache - Connection: keep-alive - X-Execution-Mode: adhoc Standard Execution (stream=False, default): - Returns ExecuteRetrieverResponse after all stages complete - Includes X-Execution-Mode: adhoc header - execution_metadata.retriever_persisted = False Use Cases: - One-time queries without saving retriever configuration - Testing stage configurations before persisting - Dynamic retrieval with varying parameters - Real-time progress tracking with streaming
307
307
  * @summary Execute Adhoc Retriever
308
308
  * @param {AdhocRetrieversApiExecuteAdhocRetrieverRequest} requestParameters Request parameters.
309
309
  * @param {*} [options] Override http request option.
@@ -17157,7 +17157,7 @@ var RetrieversApiAxiosParamCreator = function(configuration) {
17157
17157
  };
17158
17158
  },
17159
17159
  /**
17160
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
17160
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
17161
17161
  * @summary Patch Retriever
17162
17162
  * @param {string} retrieverId Retriever ID or name.
17163
17163
  * @param {PatchRetrieverRequest} patchRetrieverRequest
@@ -17401,7 +17401,7 @@ var RetrieversApiFp = function(configuration) {
17401
17401
  return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios6__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
17402
17402
  },
17403
17403
  /**
17404
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
17404
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
17405
17405
  * @summary Patch Retriever
17406
17406
  * @param {string} retrieverId Retriever ID or name.
17407
17407
  * @param {PatchRetrieverRequest} patchRetrieverRequest
@@ -17561,7 +17561,7 @@ var RetrieversApi = class extends BaseAPI {
17561
17561
  return RetrieversApiFp(this.configuration).listRetrieversGet(requestParameters.limit, requestParameters.pageSize, requestParameters.offset, requestParameters.page, requestParameters.cursor, requestParameters.nextCursor, requestParameters.after, requestParameters.includeTotal, options).then((request) => request(this.axios, this.basePath));
17562
17562
  }
17563
17563
  /**
17564
- * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. input_schema and budget_limits remain immutable; use POST /{retriever_id}/clone.
17564
+ * Update a retriever\'s metadata. Editable fields: - name, description, tags, display_config: metadata - collection_identifiers: re-points + re-validates stage feature URIs - stages (BACKE-1287): edit stages in place on an UNPUBLISHED retriever (change a filter/operator/rerank without clone+repoint+delete); the full stage list is replaced + re-validated as on create. A PUBLISHED retriever\'s stages stay immutable — clone or unpublish to change them. - input_schema: NON-BREAKING evolution only (add default/examples/description to a field, add a new optional field). Breaking changes — removing a field, changing a type, making a field newly required — are rejected with 422 naming each one; clone the retriever for those. budget_limits remains immutable; use POST /{retriever_id}/clone.
17565
17565
  * @summary Patch Retriever
17566
17566
  * @param {RetrieversApiPatchRetrieverRequest} requestParameters Request parameters.
17567
17567
  * @param {*} [options] Override http request option.