mixpeek 0.81.1

package/dist/api/retriever-benchmarks-api.d.ts

@@ -0,0 +1,652 @@
+/**
+ * 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 { BenchmarkListResponse } from '../models';
+import type { BenchmarkResponse } from '../models';
+import type { CreateBenchmarkRequest } from '../models';
+/**
+ * RetrieverBenchmarksApi - axios parameter creator
+ * @export
+ */
+export declare const RetrieverBenchmarksApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {CreateBenchmarkRequest} createBenchmarkRequest
+     * @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}
+     */
+    createBenchmarkRetrievers: (createBenchmarkRequest: CreateBenchmarkRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {CreateBenchmarkRequest} createBenchmarkRequest
+     * @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}
+     */
+    createBenchmarkRetrievers_1: (createBenchmarkRequest: CreateBenchmarkRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    deleteBenchmarkRetrievers: (benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    deleteBenchmarkRetrievers_2: (benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    getBenchmarkRetrievers: (benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    getBenchmarkRetrievers_3: (benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {string} [retrieverId] Filter to benchmarks involving this retriever (as baseline or candidate)
+     * @param {string} [status] Filter by status (pending, building_sessions, replaying, completed, failed)
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Items per page
+     * @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}
+     */
+    listBenchmarksRetrievers: (retrieverId?: string, status?: string, page?: number, pageSize?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {string} [retrieverId] Filter to benchmarks involving this retriever (as baseline or candidate)
+     * @param {string} [status] Filter by status (pending, building_sessions, replaying, completed, failed)
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Items per page
+     * @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}
+     */
+    listBenchmarksRetrievers_4: (retrieverId?: string, status?: string, page?: number, pageSize?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * RetrieverBenchmarksApi - functional programming interface
+ * @export
+ */
+export declare const RetrieverBenchmarksApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {CreateBenchmarkRequest} createBenchmarkRequest
+     * @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}
+     */
+    createBenchmarkRetrievers(createBenchmarkRequest: CreateBenchmarkRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenchmarkResponse>>;
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {CreateBenchmarkRequest} createBenchmarkRequest
+     * @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}
+     */
+    createBenchmarkRetrievers_1(createBenchmarkRequest: CreateBenchmarkRequest, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenchmarkResponse>>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    deleteBenchmarkRetrievers(benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    deleteBenchmarkRetrievers_2(benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    getBenchmarkRetrievers(benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenchmarkResponse>>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {string} benchmarkId
+     * @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}
+     */
+    getBenchmarkRetrievers_3(benchmarkId: string, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenchmarkResponse>>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {string} [retrieverId] Filter to benchmarks involving this retriever (as baseline or candidate)
+     * @param {string} [status] Filter by status (pending, building_sessions, replaying, completed, failed)
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Items per page
+     * @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}
+     */
+    listBenchmarksRetrievers(retrieverId?: string, status?: string, page?: number, pageSize?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenchmarkListResponse>>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {string} [retrieverId] Filter to benchmarks involving this retriever (as baseline or candidate)
+     * @param {string} [status] Filter by status (pending, building_sessions, replaying, completed, failed)
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Items per page
+     * @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}
+     */
+    listBenchmarksRetrievers_4(retrieverId?: string, status?: string, page?: number, pageSize?: number, authorization?: string, authorization2?: string, xNamespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenchmarkListResponse>>;
+};
+/**
+ * RetrieverBenchmarksApi - factory interface
+ * @export
+ */
+export declare const RetrieverBenchmarksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {RetrieverBenchmarksApiCreateBenchmarkRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBenchmarkRetrievers(requestParameters: RetrieverBenchmarksApiCreateBenchmarkRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<BenchmarkResponse>;
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {RetrieverBenchmarksApiCreateBenchmarkRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBenchmarkRetrievers_1(requestParameters: RetrieverBenchmarksApiCreateBenchmarkRetrievers0Request, options?: RawAxiosRequestConfig): AxiosPromise<BenchmarkResponse>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {RetrieverBenchmarksApiDeleteBenchmarkRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBenchmarkRetrievers(requestParameters: RetrieverBenchmarksApiDeleteBenchmarkRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {RetrieverBenchmarksApiDeleteBenchmarkRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBenchmarkRetrievers_2(requestParameters: RetrieverBenchmarksApiDeleteBenchmarkRetrievers0Request, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {RetrieverBenchmarksApiGetBenchmarkRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBenchmarkRetrievers(requestParameters: RetrieverBenchmarksApiGetBenchmarkRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<BenchmarkResponse>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {RetrieverBenchmarksApiGetBenchmarkRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBenchmarkRetrievers_3(requestParameters: RetrieverBenchmarksApiGetBenchmarkRetrievers0Request, options?: RawAxiosRequestConfig): AxiosPromise<BenchmarkResponse>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {RetrieverBenchmarksApiListBenchmarksRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBenchmarksRetrievers(requestParameters?: RetrieverBenchmarksApiListBenchmarksRetrieversRequest, options?: RawAxiosRequestConfig): AxiosPromise<BenchmarkListResponse>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {RetrieverBenchmarksApiListBenchmarksRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBenchmarksRetrievers_4(requestParameters?: RetrieverBenchmarksApiListBenchmarksRetrievers0Request, options?: RawAxiosRequestConfig): AxiosPromise<BenchmarkListResponse>;
+};
+/**
+ * Request parameters for createBenchmarkRetrievers operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiCreateBenchmarkRetrieversRequest
+ */
+export interface RetrieverBenchmarksApiCreateBenchmarkRetrieversRequest {
+    /**
+     *
+     * @type {CreateBenchmarkRequest}
+     * @memberof RetrieverBenchmarksApiCreateBenchmarkRetrievers
+     */
+    readonly createBenchmarkRequest: CreateBenchmarkRequest;
+    /**
+     * 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 RetrieverBenchmarksApiCreateBenchmarkRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiCreateBenchmarkRetrievers
+     */
+    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 RetrieverBenchmarksApiCreateBenchmarkRetrievers
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for createBenchmarkRetrievers_1 operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiCreateBenchmarkRetrievers0Request
+ */
+export interface RetrieverBenchmarksApiCreateBenchmarkRetrievers0Request {
+    /**
+     *
+     * @type {CreateBenchmarkRequest}
+     * @memberof RetrieverBenchmarksApiCreateBenchmarkRetrievers0
+     */
+    readonly createBenchmarkRequest: CreateBenchmarkRequest;
+    /**
+     * 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 RetrieverBenchmarksApiCreateBenchmarkRetrievers0
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiCreateBenchmarkRetrievers0
+     */
+    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 RetrieverBenchmarksApiCreateBenchmarkRetrievers0
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for deleteBenchmarkRetrievers operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiDeleteBenchmarkRetrieversRequest
+ */
+export interface RetrieverBenchmarksApiDeleteBenchmarkRetrieversRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiDeleteBenchmarkRetrievers
+     */
+    readonly benchmarkId: 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 RetrieverBenchmarksApiDeleteBenchmarkRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiDeleteBenchmarkRetrievers
+     */
+    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 RetrieverBenchmarksApiDeleteBenchmarkRetrievers
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for deleteBenchmarkRetrievers_2 operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiDeleteBenchmarkRetrievers0Request
+ */
+export interface RetrieverBenchmarksApiDeleteBenchmarkRetrievers0Request {
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiDeleteBenchmarkRetrievers0
+     */
+    readonly benchmarkId: 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 RetrieverBenchmarksApiDeleteBenchmarkRetrievers0
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiDeleteBenchmarkRetrievers0
+     */
+    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 RetrieverBenchmarksApiDeleteBenchmarkRetrievers0
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getBenchmarkRetrievers operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiGetBenchmarkRetrieversRequest
+ */
+export interface RetrieverBenchmarksApiGetBenchmarkRetrieversRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiGetBenchmarkRetrievers
+     */
+    readonly benchmarkId: 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 RetrieverBenchmarksApiGetBenchmarkRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiGetBenchmarkRetrievers
+     */
+    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 RetrieverBenchmarksApiGetBenchmarkRetrievers
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for getBenchmarkRetrievers_3 operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiGetBenchmarkRetrievers0Request
+ */
+export interface RetrieverBenchmarksApiGetBenchmarkRetrievers0Request {
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiGetBenchmarkRetrievers0
+     */
+    readonly benchmarkId: 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 RetrieverBenchmarksApiGetBenchmarkRetrievers0
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiGetBenchmarkRetrievers0
+     */
+    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 RetrieverBenchmarksApiGetBenchmarkRetrievers0
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listBenchmarksRetrievers operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiListBenchmarksRetrieversRequest
+ */
+export interface RetrieverBenchmarksApiListBenchmarksRetrieversRequest {
+    /**
+     * Filter to benchmarks involving this retriever (as baseline or candidate)
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    readonly retrieverId?: string;
+    /**
+     * Filter by status (pending, building_sessions, replaying, completed, failed)
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    readonly status?: string;
+    /**
+     * Page number
+     * @type {number}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    readonly page?: number;
+    /**
+     * Items per page
+     * @type {number}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    readonly pageSize?: number;
+    /**
+     * 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 RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    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 RetrieverBenchmarksApiListBenchmarksRetrievers
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * Request parameters for listBenchmarksRetrievers_4 operation in RetrieverBenchmarksApi.
+ * @export
+ * @interface RetrieverBenchmarksApiListBenchmarksRetrievers0Request
+ */
+export interface RetrieverBenchmarksApiListBenchmarksRetrievers0Request {
+    /**
+     * Filter to benchmarks involving this retriever (as baseline or candidate)
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    readonly retrieverId?: string;
+    /**
+     * Filter by status (pending, building_sessions, replaying, completed, failed)
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    readonly status?: string;
+    /**
+     * Page number
+     * @type {number}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    readonly page?: number;
+    /**
+     * Items per page
+     * @type {number}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    readonly pageSize?: number;
+    /**
+     * 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 RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    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 RetrieverBenchmarksApiListBenchmarksRetrievers0
+     */
+    readonly xNamespace?: string;
+}
+/**
+ * RetrieverBenchmarksApi - object-oriented interface
+ * @export
+ * @class RetrieverBenchmarksApi
+ * @extends {BaseAPI}
+ */
+export declare class RetrieverBenchmarksApi extends BaseAPI {
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {RetrieverBenchmarksApiCreateBenchmarkRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    createBenchmarkRetrievers(requestParameters: RetrieverBenchmarksApiCreateBenchmarkRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BenchmarkResponse, any, {}>>;
+    /**
+     * Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior.
+     * @summary Create benchmark
+     * @param {RetrieverBenchmarksApiCreateBenchmarkRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    createBenchmarkRetrievers_1(requestParameters: RetrieverBenchmarksApiCreateBenchmarkRetrievers0Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BenchmarkResponse, any, {}>>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {RetrieverBenchmarksApiDeleteBenchmarkRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    deleteBenchmarkRetrievers(requestParameters: RetrieverBenchmarksApiDeleteBenchmarkRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Delete a benchmark and its results
+     * @summary Delete benchmark
+     * @param {RetrieverBenchmarksApiDeleteBenchmarkRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    deleteBenchmarkRetrievers_2(requestParameters: RetrieverBenchmarksApiDeleteBenchmarkRetrievers0Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {RetrieverBenchmarksApiGetBenchmarkRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    getBenchmarkRetrievers(requestParameters: RetrieverBenchmarksApiGetBenchmarkRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BenchmarkResponse, any, {}>>;
+    /**
+     * Get benchmark status and results by ID
+     * @summary Get benchmark
+     * @param {RetrieverBenchmarksApiGetBenchmarkRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    getBenchmarkRetrievers_3(requestParameters: RetrieverBenchmarksApiGetBenchmarkRetrievers0Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BenchmarkResponse, any, {}>>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {RetrieverBenchmarksApiListBenchmarksRetrieversRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    listBenchmarksRetrievers(requestParameters?: RetrieverBenchmarksApiListBenchmarksRetrieversRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BenchmarkListResponse, any, {}>>;
+    /**
+     * List benchmarks with optional filtering
+     * @summary List benchmarks
+     * @param {RetrieverBenchmarksApiListBenchmarksRetrievers0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetrieverBenchmarksApi
+     */
+    listBenchmarksRetrievers_4(requestParameters?: RetrieverBenchmarksApiListBenchmarksRetrievers0Request, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BenchmarkListResponse, any, {}>>;
+}
+//# sourceMappingURL=retriever-benchmarks-api.d.ts.map