mixpeek 0.81.1

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

@@ -0,0 +1,303 @@
+/**
+ * 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 { AdhocExecuteRequest } from '../models';
+import type { AdhocExecutionDetail } from '../models';
+import type { ListAdhocExecutionsRequest } from '../models';
+import type { ListAdhocExecutionsResponse } from '../models';
+/**
+ * AdhocRetrieversApi - axios parameter creator
+ * @export
+ */
+export declare const AdhocRetrieversApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.  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
+     * @summary Execute Adhoc Retriever
+     * @param {AdhocExecuteRequest} adhocExecuteRequest
+     * @param {boolean} [returnPresignedUrls]
+     * @param {boolean} [returnVectors]
+     * @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}
+     */
+    executeAdhocRetriever: (adhocExecuteRequest: AdhocExecuteRequest, returnPresignedUrls?: boolean, returnVectors?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get detailed execution information for a specific ad-hoc retriever execution.  Returns comprehensive execution details including:     - Execution metadata (status, duration, credits used)     - Performance metrics (documents processed/returned, cache hit rate)     - Input data and query summary     - Stage completion information     - Collections queried  Use Cases:     - Debug specific ad-hoc executions     - Analyze performance of a particular query     - Retrieve execution inputs for reproduction     - Audit ad-hoc retriever usage  Raises:     404 NotFoundError: If execution not found or not an ad-hoc execution
+     * @summary Get Adhoc Execution
+     * @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}
+     */
+    getAdhocExecutionRetrievers: (executionId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List execution history for ad-hoc retrievers.  Returns execution history for all ad-hoc retriever executions in the namespace, sorted by timestamp descending (most recent first).  Use Cases:     - Track ad-hoc retriever usage across the namespace     - Debug ad-hoc retriever executions     - Analyze query patterns from ad-hoc searches     - Monitor performance of ad-hoc executions  Filtering:     - Filter by status (completed, failed, etc.)     - Filter by time range (start_time, end_time)  Pagination:     - Supports offset-based pagination via query parameters     - Default limit: 20, max limit: 100     - Use ?page_size=X&page_number=Y for pagination
+     * @summary List Adhoc Executions
+     * @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 {ListAdhocExecutionsRequest} [listAdhocExecutionsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAdhocExecutionsRetrievers: (limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listAdhocExecutionsRequest?: ListAdhocExecutionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AdhocRetrieversApi - functional programming interface
+ * @export
+ */
+export declare const AdhocRetrieversApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.  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
+     * @summary Execute Adhoc Retriever
+     * @param {AdhocExecuteRequest} adhocExecuteRequest
+     * @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}
+     */
+    executeAdhocRetriever(adhocExecuteRequest: AdhocExecuteRequest, returnPresignedUrls?: boolean, returnVectors?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Get detailed execution information for a specific ad-hoc retriever execution.  Returns comprehensive execution details including:     - Execution metadata (status, duration, credits used)     - Performance metrics (documents processed/returned, cache hit rate)     - Input data and query summary     - Stage completion information     - Collections queried  Use Cases:     - Debug specific ad-hoc executions     - Analyze performance of a particular query     - Retrieve execution inputs for reproduction     - Audit ad-hoc retriever usage  Raises:     404 NotFoundError: If execution not found or not an ad-hoc execution
+     * @summary Get Adhoc Execution
+     * @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}
+     */
+    getAdhocExecutionRetrievers(executionId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdhocExecutionDetail>>;
+    /**
+     * List execution history for ad-hoc retrievers.  Returns execution history for all ad-hoc retriever executions in the namespace, sorted by timestamp descending (most recent first).  Use Cases:     - Track ad-hoc retriever usage across the namespace     - Debug ad-hoc retriever executions     - Analyze query patterns from ad-hoc searches     - Monitor performance of ad-hoc executions  Filtering:     - Filter by status (completed, failed, etc.)     - Filter by time range (start_time, end_time)  Pagination:     - Supports offset-based pagination via query parameters     - Default limit: 20, max limit: 100     - Use ?page_size=X&page_number=Y for pagination
+     * @summary List Adhoc Executions
+     * @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 {ListAdhocExecutionsRequest} [listAdhocExecutionsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAdhocExecutionsRetrievers(limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, authorization2?: string, xNamespace?: string, listAdhocExecutionsRequest?: ListAdhocExecutionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAdhocExecutionsResponse>>;
+};
+/**
+ * AdhocRetrieversApi - factory interface
+ * @export
+ */
+export declare const AdhocRetrieversApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.  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
+     * @summary Execute Adhoc Retriever
+     * @param {AdhocRetrieversApiExecuteAdhocRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    executeAdhocRetriever(requestParameters: AdhocRetrieversApiExecuteAdhocRetrieverRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Get detailed execution information for a specific ad-hoc retriever execution.  Returns comprehensive execution details including:     - Execution metadata (status, duration, credits used)     - Performance metrics (documents processed/returned, cache hit rate)     - Input data and query summary     - Stage completion information     - Collections queried  Use Cases:     - Debug specific ad-hoc executions     - Analyze performance of a particular query     - Retrieve execution inputs for reproduction     - Audit ad-hoc retriever usage  Raises:     404 NotFoundError: If execution not found or not an ad-hoc execution
+     * @summary Get Adhoc Execution
+     * @param {AdhocRetrieversApiGetAdhocExecutionRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAdhocExecutionRetrievers(requestParameters: AdhocRetrieversApiGetAdhocExecutionRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdhocExecutionDetail>;
+    /**
+     * List execution history for ad-hoc retrievers.  Returns execution history for all ad-hoc retriever executions in the namespace, sorted by timestamp descending (most recent first).  Use Cases:     - Track ad-hoc retriever usage across the namespace     - Debug ad-hoc retriever executions     - Analyze query patterns from ad-hoc searches     - Monitor performance of ad-hoc executions  Filtering:     - Filter by status (completed, failed, etc.)     - Filter by time range (start_time, end_time)  Pagination:     - Supports offset-based pagination via query parameters     - Default limit: 20, max limit: 100     - Use ?page_size=X&page_number=Y for pagination
+     * @summary List Adhoc Executions
+     * @param {AdhocRetrieversApiListAdhocExecutionsRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listAdhocExecutionsRetrievers(requestParameters?: AdhocRetrieversApiListAdhocExecutionsRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListAdhocExecutionsResponse>;
+};
+/**
+ * Request parameters for executeAdhocRetriever operation in AdhocRetrieversApi.
+ * @export
+ * @interface AdhocRetrieversApiExecuteAdhocRetrieverRequest
+ */
+export interface AdhocRetrieversApiExecuteAdhocRetrieverRequest {
+    /**
+     *
+     * @type {AdhocExecuteRequest}
+     * @memberof AdhocRetrieversApiExecuteAdhocRetriever
+     */
+    readonly adhocExecuteRequest: AdhocExecuteRequest;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdhocRetrieversApiExecuteAdhocRetriever
+     */
+    readonly returnPresignedUrls?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdhocRetrieversApiExecuteAdhocRetriever
+     */
+    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 AdhocRetrieversApiExecuteAdhocRetriever
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdhocRetrieversApiExecuteAdhocRetriever
+     */
+    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 AdhocRetrieversApiExecuteAdhocRetriever
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getAdhocExecutionRetrievers operation in AdhocRetrieversApi.
+ * @export
+ * @interface AdhocRetrieversApiGetAdhocExecutionRetrieversRequest
+ */
+export interface AdhocRetrieversApiGetAdhocExecutionRetrieversRequest {
+    /**
+     * Execution identifier.
+     * @type {string}
+     * @memberof AdhocRetrieversApiGetAdhocExecutionRetrievers
+     */
+    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 AdhocRetrieversApiGetAdhocExecutionRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdhocRetrieversApiGetAdhocExecutionRetrievers
+     */
+    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 AdhocRetrieversApiGetAdhocExecutionRetrievers
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listAdhocExecutionsRetrievers operation in AdhocRetrieversApi.
+ * @export
+ * @interface AdhocRetrieversApiListAdhocExecutionsRetrieversRequest
+ */
+export interface AdhocRetrieversApiListAdhocExecutionsRetrieversRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    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 AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    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 AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    readonly xNamespace?: string;
+    /**
+     *
+     * @type {ListAdhocExecutionsRequest}
+     * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
+     */
+    readonly listAdhocExecutionsRequest?: ListAdhocExecutionsRequest;
+}
+/**
+ * AdhocRetrieversApi - object-oriented interface
+ * @export
+ * @class AdhocRetrieversApi
+ * @extends {BaseAPI}
+ */
+export declare class AdhocRetrieversApi extends BaseAPI {
+    /**
+     * 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.  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
+     * @summary Execute Adhoc Retriever
+     * @param {AdhocRetrieversApiExecuteAdhocRetrieverRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdhocRetrieversApi
+     */
+    executeAdhocRetriever(requestParameters: AdhocRetrieversApiExecuteAdhocRetrieverRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Get detailed execution information for a specific ad-hoc retriever execution.  Returns comprehensive execution details including:     - Execution metadata (status, duration, credits used)     - Performance metrics (documents processed/returned, cache hit rate)     - Input data and query summary     - Stage completion information     - Collections queried  Use Cases:     - Debug specific ad-hoc executions     - Analyze performance of a particular query     - Retrieve execution inputs for reproduction     - Audit ad-hoc retriever usage  Raises:     404 NotFoundError: If execution not found or not an ad-hoc execution
+     * @summary Get Adhoc Execution
+     * @param {AdhocRetrieversApiGetAdhocExecutionRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdhocRetrieversApi
+     */
+    getAdhocExecutionRetrievers(requestParameters: AdhocRetrieversApiGetAdhocExecutionRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdhocExecutionDetail, any, {}>>;
+    /**
+     * List execution history for ad-hoc retrievers.  Returns execution history for all ad-hoc retriever executions in the namespace, sorted by timestamp descending (most recent first).  Use Cases:     - Track ad-hoc retriever usage across the namespace     - Debug ad-hoc retriever executions     - Analyze query patterns from ad-hoc searches     - Monitor performance of ad-hoc executions  Filtering:     - Filter by status (completed, failed, etc.)     - Filter by time range (start_time, end_time)  Pagination:     - Supports offset-based pagination via query parameters     - Default limit: 20, max limit: 100     - Use ?page_size=X&page_number=Y for pagination
+     * @summary List Adhoc Executions
+     * @param {AdhocRetrieversApiListAdhocExecutionsRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdhocRetrieversApi
+     */
+    listAdhocExecutionsRetrievers(requestParameters?: AdhocRetrieversApiListAdhocExecutionsRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAdhocExecutionsResponse, any, {}>>;
+}
+//# sourceMappingURL=adhoc-retrievers-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"adhoc-retrievers-api.d.ts","sourceRoot":"","sources":["../../api/adhoc-retrievers-api.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAMhF,OAAO,EAAiC,KAAK,WAAW,EAAE,OAAO,EAAqC,MAAM,SAAS,CAAC;AAEtH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAErD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAMtD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAE5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,WAAW,CAAC;AAC7D;;;GAGG;AACH,eAAO,MAAM,mCAAmC,GAAa,gBAAgB,aAAa;IAElF;;;;;;;;;;;OAWG;iDACgD,mBAAmB,wBAAwB,OAAO,kBAAkB,OAAO,kBAAkB,MAAM,mBAAmB,MAAM,eAAe,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA8ChQ;;;;;;;;;OASG;+CAC8C,MAAM,kBAAkB,MAAM,mBAAmB,MAAM,eAAe,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAoCzL;;;;;;;;;;;;;OAaG;4CAC2C,MAAM,WAAW,MAAM,WAAW,MAAM,iBAAiB,OAAO,kBAAkB,MAAM,mBAAmB,MAAM,eAAe,MAAM,+BAA+B,0BAA0B,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CAqDhT,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAY,gBAAgB,aAAa;IAGlE;;;;;;;;;;;OAWG;+CAC8C,mBAAmB,wBAAwB,OAAO,kBAAkB,OAAO,kBAAkB,MAAM,mBAAmB,MAAM,eAAe,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;IAM9S;;;;;;;;;OASG;6CAC4C,MAAM,kBAAkB,MAAM,mBAAmB,MAAM,eAAe,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAMxP;;;;;;;;;;;;;OAaG;0CACyC,MAAM,WAAW,MAAM,WAAW,MAAM,iBAAiB,OAAO,kBAAkB,MAAM,mBAAmB,MAAM,eAAe,MAAM,+BAA+B,0BAA0B,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,2BAA2B,CAAC,CAAC;CAOtX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGlH;;;;;;OAMG;6CACsC,8CAA8C,YAAY,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC;IAG5I;;;;;;OAMG;mDAC4C,oDAAoD,YAAY,qBAAqB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IAGzK;;;;;;OAMG;sDAC8C,sDAAsD,YAAiB,qBAAqB,GAAG,YAAY,CAAC,2BAA2B,CAAC;CAIhM,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,8CAA8C;IAC3D;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAA;IAEjD;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAA;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,oDAAoD;IACjE;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,sDAAsD;IACnE;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,0BAA0B,CAAC,EAAE,0BAA0B,CAAA;CACnE;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,OAAO;IAC3C;;;;;;;OAOG;IACI,qBAAqB,CAAC,iBAAiB,EAAE,8CAA8C,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI/H;;;;;;;OAOG;IACI,2BAA2B,CAAC,iBAAiB,EAAE,oDAAoD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI3I;;;;;;;OAOG;IACI,6BAA6B,CAAC,iBAAiB,GAAE,sDAA2D,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGvJ"}