npm - mixpeek - Versions diffs - 0.81.1 → 0.81.2 - Mend

mixpeek 0.81.1 → 0.81.2

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.

Files changed (1562) hide show

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

@@ -2,7 +2,7 @@
  * 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
+ * The version of the OpenAPI document: 0.81
  * Contact: info@mixpeek.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,9 +27,9 @@ export declare const AdhocRetrieversApiAxiosParamCreator: (configuration?: Confi
      * @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} [authorization] 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 {string} [xNamespace] 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -38,9 +38,9 @@ export declare const AdhocRetrieversApiAxiosParamCreator: (configuration?: Confi
      * 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} [authorization] 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 {string} [xNamespace] 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -52,9 +52,9 @@ export declare const AdhocRetrieversApiAxiosParamCreator: (configuration?: Confi
      * @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} [authorization] 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 {string} [xNamespace] 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @param {ListAdhocExecutionsRequest} [listAdhocExecutionsRequest]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -72,9 +72,9 @@ export declare const AdhocRetrieversApiFp: (configuration?: Configuration) => {
      * @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} [authorization] 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 {string} [xNamespace] 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -83,9 +83,9 @@ export declare const AdhocRetrieversApiFp: (configuration?: Configuration) => {
      * 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} [authorization] 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 {string} [xNamespace] 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -97,9 +97,9 @@ export declare const AdhocRetrieversApiFp: (configuration?: Configuration) => {
      * @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} [authorization] 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 {string} [xNamespace] 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @param {ListAdhocExecutionsRequest} [listAdhocExecutionsRequest]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -161,7 +161,7 @@ export interface AdhocRetrieversApiExecuteAdhocRetrieverRequest {
      */
     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.
+     * 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
      */
@@ -173,7 +173,7 @@ export interface AdhocRetrieversApiExecuteAdhocRetrieverRequest {
      */
     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;
+     * 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @type {string}
      * @memberof AdhocRetrieversApiExecuteAdhocRetriever
      */
@@ -192,7 +192,7 @@ export interface AdhocRetrieversApiGetAdhocExecutionRetrieversRequest {
      */
     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.
+     * 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
      */
@@ -204,7 +204,7 @@ export interface AdhocRetrieversApiGetAdhocExecutionRetrieversRequest {
      */
     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;
+     * 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @type {string}
      * @memberof AdhocRetrieversApiGetAdhocExecutionRetrievers
      */
@@ -241,7 +241,7 @@ export interface AdhocRetrieversApiListAdhocExecutionsRetrieversRequest {
      */
     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.
+     * 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
      */
@@ -253,7 +253,7 @@ export interface AdhocRetrieversApiListAdhocExecutionsRetrieversRequest {
      */
     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;
+     * 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;. Falls back to ?namespace&#x3D; query parameter if the header is omitted.
      * @type {string}
      * @memberof AdhocRetrieversApiListAdhocExecutionsRetrievers
      */