mixpeek 0.81.21 → 0.81.22
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.
- package/dist/api/analytics-api.d.ts +4 -4
- package/dist/api/analytics-namespaces-api.d.ts +4 -4
- package/dist/api/apps-api.d.ts +8 -8
- package/dist/api/bucket-batches-api.d.ts +55 -0
- package/dist/api/bucket-batches-api.d.ts.map +1 -1
- package/dist/api/bucket-objects-api.d.ts +14 -6
- package/dist/api/bucket-objects-api.d.ts.map +1 -1
- package/dist/api/buckets-api.d.ts +10 -2
- package/dist/api/buckets-api.d.ts.map +1 -1
- package/dist/api/collection-documents-api.d.ts +99 -4
- package/dist/api/collection-documents-api.d.ts.map +1 -1
- package/dist/api/features-api.d.ts +71 -0
- package/dist/api/features-api.d.ts.map +1 -0
- package/dist/api/namespaces-api.d.ts +48 -0
- package/dist/api/namespaces-api.d.ts.map +1 -1
- package/dist/api/notifications-api.d.ts +4 -4
- package/dist/api/organization-billing-api.d.ts +152 -8
- package/dist/api/organization-billing-api.d.ts.map +1 -1
- package/dist/api/retriever-evaluations-api.d.ts +35 -0
- package/dist/api/retriever-evaluations-api.d.ts.map +1 -1
- package/dist/api/retrievers-api.d.ts +18 -2
- package/dist/api/retrievers-api.d.ts.map +1 -1
- package/dist/api/support-api.d.ts +1005 -0
- package/dist/api/support-api.d.ts.map +1 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.d.ts.map +1 -1
- package/dist/index.js +240 -35
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +240 -35
- package/dist/index.mjs.map +1 -1
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/client.d.ts +132 -0
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/client.d.ts.map +1 -0
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/index.d.ts +7 -0
- package/dist/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/lib/index.d.ts.map +1 -0
- package/dist/models/account-tier.d.ts +4 -2
- package/dist/models/account-tier.d.ts.map +1 -1
- package/dist/models/alert-source.d.ts +1 -1
- package/dist/models/apply-promo-request.d.ts +25 -0
- package/dist/models/apply-promo-request.d.ts.map +1 -0
- package/dist/models/apply-promo-response.d.ts +61 -0
- package/dist/models/apply-promo-response.d.ts.map +1 -0
- package/dist/models/batch-cost-estimate.d.ts +81 -0
- package/dist/models/batch-cost-estimate.d.ts.map +1 -0
- package/dist/models/batch-model.d.ts +14 -0
- package/dist/models/batch-model.d.ts.map +1 -1
- package/dist/models/billing-portal-request.d.ts +25 -0
- package/dist/models/billing-portal-request.d.ts.map +1 -0
- package/dist/models/billing-portal-response.d.ts +31 -0
- package/dist/models/billing-portal-response.d.ts.map +1 -0
- package/dist/models/bucket-create-request.d.ts +7 -0
- package/dist/models/bucket-create-request.d.ts.map +1 -1
- package/dist/models/bucket-response.d.ts +7 -0
- package/dist/models/bucket-response.d.ts.map +1 -1
- package/dist/models/bucket-update-request.d.ts +7 -0
- package/dist/models/bucket-update-request.d.ts.map +1 -1
- package/dist/models/build-config.d.ts +9 -1
- package/dist/models/build-config.d.ts.map +1 -1
- package/dist/models/cluster-execution-centroid.d.ts +1 -1
- package/dist/models/create-broadcast-request.d.ts +38 -0
- package/dist/models/create-broadcast-request.d.ts.map +1 -0
- package/dist/models/create-collection-request.d.ts +7 -1
- package/dist/models/create-collection-request.d.ts.map +1 -1
- package/dist/models/create-message-request.d.ts +39 -0
- package/dist/models/create-message-request.d.ts.map +1 -0
- package/dist/models/create-retriever-request.d.ts +1 -1
- package/dist/models/create-ticket-request.d.ts +58 -0
- package/dist/models/create-ticket-request.d.ts.map +1 -0
- package/dist/models/create-video-request.d.ts +87 -0
- package/dist/models/create-video-request.d.ts.map +1 -0
- package/dist/models/current-usage-response.d.ts +15 -0
- package/dist/models/current-usage-response.d.ts.map +1 -1
- package/dist/models/document-count-response.d.ts +31 -0
- package/dist/models/document-count-response.d.ts.map +1 -0
- package/dist/models/estimate-item.d.ts +55 -0
- package/dist/models/estimate-item.d.ts.map +1 -0
- package/dist/models/estimate-request.d.ts +38 -0
- package/dist/models/estimate-request.d.ts.map +1 -0
- package/dist/models/estimate-response.d.ts +69 -0
- package/dist/models/estimate-response.d.ts.map +1 -0
- package/dist/models/evaluation-record.d.ts +18 -0
- package/dist/models/evaluation-record.d.ts.map +1 -1
- package/dist/models/execution-detail.d.ts +8 -8
- package/dist/models/execution-detail.d.ts.map +1 -1
- package/dist/models/extractor-job-info.d.ts +14 -0
- package/dist/models/extractor-job-info.d.ts.map +1 -1
- package/dist/models/feature-discovery-response.d.ts +41 -0
- package/dist/models/feature-discovery-response.d.ts.map +1 -0
- package/dist/models/index.d.ts +42 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/instantiated-scaffold-response.d.ts +7 -1
- package/dist/models/instantiated-scaffold-response.d.ts.map +1 -1
- package/dist/models/interaction-response.d.ts +1 -1
- package/dist/models/list-apps-response.d.ts +6 -0
- package/dist/models/list-apps-response.d.ts.map +1 -1
- package/dist/models/list-comms-request.d.ts +32 -0
- package/dist/models/list-comms-request.d.ts.map +1 -0
- package/dist/models/list-comms-response.d.ts +33 -0
- package/dist/models/list-comms-response.d.ts.map +1 -0
- package/dist/models/list-interactions-response.d.ts +6 -0
- package/dist/models/list-interactions-response.d.ts.map +1 -1
- package/dist/models/list-retrievers-request.d.ts +1 -1
- package/dist/models/list-tickets-request.d.ts +46 -0
- package/dist/models/list-tickets-request.d.ts.map +1 -0
- package/dist/models/list-tickets-response.d.ts +33 -0
- package/dist/models/list-tickets-response.d.ts.map +1 -0
- package/dist/models/list-videos-request.d.ts +32 -0
- package/dist/models/list-videos-request.d.ts.map +1 -0
- package/dist/models/list-videos-response.d.ts +33 -0
- package/dist/models/list-videos-response.d.ts.map +1 -0
- package/dist/models/llmlabeling-input.d.ts +11 -0
- package/dist/models/llmlabeling-input.d.ts.map +1 -1
- package/dist/models/llmlabeling-output.d.ts +11 -0
- package/dist/models/llmlabeling-output.d.ts.map +1 -1
- package/dist/models/message-response.d.ts +70 -0
- package/dist/models/message-response.d.ts.map +1 -0
- package/dist/models/namespace-errors-response.d.ts +1 -1
- package/dist/models/namespace-model.d.ts +18 -0
- package/dist/models/namespace-model.d.ts.map +1 -1
- package/dist/models/namespace-stats-batch-request.d.ts +25 -0
- package/dist/models/namespace-stats-batch-request.d.ts.map +1 -0
- package/dist/models/namespace-stats-batch-response.d.ts +28 -0
- package/dist/models/namespace-stats-batch-response.d.ts.map +1 -0
- package/dist/models/onboarding-answers.d.ts +31 -0
- package/dist/models/onboarding-answers.d.ts.map +1 -0
- package/dist/models/organization-model-response.d.ts +6 -0
- package/dist/models/organization-model-response.d.ts.map +1 -1
- package/dist/models/plan-usage.d.ts +91 -0
- package/dist/models/plan-usage.d.ts.map +1 -0
- package/dist/models/pricing-config-response.d.ts +55 -1
- package/dist/models/pricing-config-response.d.ts.map +1 -1
- package/dist/models/search-interaction.d.ts +1 -1
- package/dist/models/stage-params-external-reverse-image.d.ts +51 -0
- package/dist/models/stage-params-external-reverse-image.d.ts.map +1 -0
- package/dist/models/stage-params-feature-search.d.ts +6 -0
- package/dist/models/stage-params-feature-search.d.ts.map +1 -1
- package/dist/models/storage-class.d.ts +24 -0
- package/dist/models/storage-class.d.ts.map +1 -0
- package/dist/models/subscribe-request.d.ts +14 -1
- package/dist/models/subscribe-request.d.ts.map +1 -1
- package/dist/models/support-actor.d.ts +37 -0
- package/dist/models/support-actor.d.ts.map +1 -0
- package/dist/models/support-attachment.d.ts +49 -0
- package/dist/models/support-attachment.d.ts.map +1 -0
- package/dist/models/support-author-type.d.ts +22 -0
- package/dist/models/support-author-type.d.ts.map +1 -0
- package/dist/models/support-scope.d.ts +22 -0
- package/dist/models/support-scope.d.ts.map +1 -0
- package/dist/models/support-ticket-category.d.ts +25 -0
- package/dist/models/support-ticket-category.d.ts.map +1 -0
- package/dist/models/support-ticket-priority.d.ts +24 -0
- package/dist/models/support-ticket-priority.d.ts.map +1 -0
- package/dist/models/support-ticket-status.d.ts +24 -0
- package/dist/models/support-ticket-status.d.ts.map +1 -0
- package/dist/models/support-video-analysis-status.d.ts +25 -0
- package/dist/models/support-video-analysis-status.d.ts.map +1 -0
- package/dist/models/support-video-chapter.d.ts +37 -0
- package/dist/models/support-video-chapter.d.ts.map +1 -0
- package/dist/models/support-video-source.d.ts +22 -0
- package/dist/models/support-video-source.d.ts.map +1 -0
- package/dist/models/ticket-response.d.ts +96 -0
- package/dist/models/ticket-response.d.ts.map +1 -0
- package/dist/models/transaction-info.d.ts +6 -0
- package/dist/models/transaction-info.d.ts.map +1 -1
- package/dist/models/trigger-on.d.ts +1 -1
- package/dist/models/update-ticket-request.d.ts +33 -0
- package/dist/models/update-ticket-request.d.ts.map +1 -0
- package/dist/models/usage-breakdown-response.d.ts +16 -0
- package/dist/models/usage-breakdown-response.d.ts.map +1 -1
- package/dist/models/video-response.d.ts +119 -0
- package/dist/models/video-response.d.ts.map +1 -0
- package/dist/models/video-upload-url-request.d.ts +37 -0
- package/dist/models/video-upload-url-request.d.ts.map +1 -0
- package/dist/models/video-upload-url-response.d.ts +43 -0
- package/dist/models/video-upload-url-response.d.ts.map +1 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -98,8 +98,8 @@ var serializeDataIfNeeded = function(value, requestOptions, configuration) {
|
|
|
98
98
|
var toPathString = function(url) {
|
|
99
99
|
return url.pathname + url.search + url.hash;
|
|
100
100
|
};
|
|
101
|
-
var createRequestFunction = function(axiosArgs,
|
|
102
|
-
return (axios2 =
|
|
101
|
+
var createRequestFunction = function(axiosArgs, globalAxios97, BASE_PATH2, configuration) {
|
|
102
|
+
return (axios2 = globalAxios97, basePath = BASE_PATH2) => {
|
|
103
103
|
const axiosRequestArgs = { ...axiosArgs.options, url: (axios2.defaults.baseURL ? "" : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
104
104
|
return axios2.request(axiosRequestArgs);
|
|
105
105
|
};
|
|
@@ -2908,7 +2908,7 @@ var AnalyticsApiAxiosParamCreator = function(configuration) {
|
|
|
2908
2908
|
};
|
|
2909
2909
|
},
|
|
2910
2910
|
/**
|
|
2911
|
-
* Batch error/failure counts for every collection & cluster in the namespace.
|
|
2911
|
+
* Batch error/failure counts for every collection & cluster in the namespace. Returns one entry per resource that has at least one error/failure in the window, in a single response — replacing the per-resource ``/analytics/{collections,clusters}/{id}/failures`` fan-out (the Studio Monitoring \"Errors & Health\" N+1, which fired ~13+ calls per visit, most returning zero). Collection errors come from the ClickHouse ``extraction_events`` warehouse; cluster failures from Mongo ``clustering_results``. An empty ``collections``/``clusters`` list means that resource type is healthy for the window. **Recommended workflow:** call this once for the aggregate health view, then call the per-resource ``/failures`` endpoint lazily ONLY for the (usually few) resources reporting errors to get the full error-type breakdown. **Example:** ```bash curl -X GET \"https://api.mixpeek.com/v1/analytics/namespaces/errors?hours=24\" \\ -H \"Authorization: Bearer YOUR_API_KEY\" \\ -H \"X-Namespace: your-namespace\" ```
|
|
2912
2912
|
* @summary Get Namespace Errors
|
|
2913
2913
|
* @param {number} [hours] Hours of history to analyze
|
|
2914
2914
|
* @param {*} [options] Override http request option.
|
|
@@ -3737,7 +3737,7 @@ var AnalyticsApiFp = function(configuration) {
|
|
|
3737
3737
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
3738
3738
|
},
|
|
3739
3739
|
/**
|
|
3740
|
-
* Batch error/failure counts for every collection & cluster in the namespace.
|
|
3740
|
+
* Batch error/failure counts for every collection & cluster in the namespace. Returns one entry per resource that has at least one error/failure in the window, in a single response — replacing the per-resource ``/analytics/{collections,clusters}/{id}/failures`` fan-out (the Studio Monitoring \"Errors & Health\" N+1, which fired ~13+ calls per visit, most returning zero). Collection errors come from the ClickHouse ``extraction_events`` warehouse; cluster failures from Mongo ``clustering_results``. An empty ``collections``/``clusters`` list means that resource type is healthy for the window. **Recommended workflow:** call this once for the aggregate health view, then call the per-resource ``/failures`` endpoint lazily ONLY for the (usually few) resources reporting errors to get the full error-type breakdown. **Example:** ```bash curl -X GET \"https://api.mixpeek.com/v1/analytics/namespaces/errors?hours=24\" \\ -H \"Authorization: Bearer YOUR_API_KEY\" \\ -H \"X-Namespace: your-namespace\" ```
|
|
3741
3741
|
* @summary Get Namespace Errors
|
|
3742
3742
|
* @param {number} [hours] Hours of history to analyze
|
|
3743
3743
|
* @param {*} [options] Override http request option.
|
|
@@ -4235,7 +4235,7 @@ var AnalyticsApi = class extends BaseAPI {
|
|
|
4235
4235
|
return AnalyticsApiFp(this.configuration).getMostQueriedFieldsAnalyticsNamespaces(requestParameters.days, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
|
|
4236
4236
|
}
|
|
4237
4237
|
/**
|
|
4238
|
-
* Batch error/failure counts for every collection & cluster in the namespace.
|
|
4238
|
+
* Batch error/failure counts for every collection & cluster in the namespace. Returns one entry per resource that has at least one error/failure in the window, in a single response — replacing the per-resource ``/analytics/{collections,clusters}/{id}/failures`` fan-out (the Studio Monitoring \"Errors & Health\" N+1, which fired ~13+ calls per visit, most returning zero). Collection errors come from the ClickHouse ``extraction_events`` warehouse; cluster failures from Mongo ``clustering_results``. An empty ``collections``/``clusters`` list means that resource type is healthy for the window. **Recommended workflow:** call this once for the aggregate health view, then call the per-resource ``/failures`` endpoint lazily ONLY for the (usually few) resources reporting errors to get the full error-type breakdown. **Example:** ```bash curl -X GET \"https://api.mixpeek.com/v1/analytics/namespaces/errors?hours=24\" \\ -H \"Authorization: Bearer YOUR_API_KEY\" \\ -H \"X-Namespace: your-namespace\" ```
|
|
4239
4239
|
* @summary Get Namespace Errors
|
|
4240
4240
|
* @param {AnalyticsApiGetNamespaceErrorsAnalyticsRequest} requestParameters Request parameters.
|
|
4241
4241
|
* @param {*} [options] Override http request option.
|
|
@@ -4430,7 +4430,7 @@ var AppsApiAxiosParamCreator = function(configuration) {
|
|
|
4430
4430
|
};
|
|
4431
4431
|
},
|
|
4432
4432
|
/**
|
|
4433
|
-
* Create a new App. Apps are full-stack web applications deployed as zip bundles to ``{slug}.mxp.co``. After creation, deploy your built frontend via the deploy pipeline: 1. ``POST /v1/apps/{app_id}/deploy/upload-url`` — get a presigned S3 PUT URL 2. Upload your built ``dist/`` zip to that URL 3. ``POST /v1/apps/{app_id}/deploy`` — trigger the build Only ``slug`` and ``meta`` are required. Set ``auth_config.mode`` to control end-user authentication (``public``, ``clerk``, ``password``, ``api_key``, ``jwt``, ``sso_oidc``, ``sso_saml``). Slugs are globally unique across all organizations. **Deprecated fields:** ``template``, ``sections``, ``custom_html``, ``hero``, ``theme``, ``seo``, ``stats``, ``featured_gallery``, ``tabs``, ``password_secret_name`` are accepted for backward compatibility but should not be used for new apps.
|
|
4433
|
+
* Create a new App. Apps are full-stack web applications deployed as zip bundles to ``{slug}.mxp.co``. After creation, deploy your built frontend via the deploy pipeline: 1. ``POST /v1/apps/{app_id}/deploy/upload-url`` — get a presigned S3 PUT URL 2. Upload your built ``dist/`` zip to that URL 3. ``POST /v1/apps/{app_id}/deploy`` — trigger the build Only ``slug`` and ``meta`` are required. Set ``auth_config.mode`` to control end-user authentication (``public``, ``clerk``, ``password``, ``api_key``, ``jwt``, ``sso_oidc``, ``sso_saml``). Slugs are globally unique across all organizations. **Deprecated fields:** ``template``, ``sections``, ``custom_html``, ``hero``, ``theme``, ``seo``, ``stats``, ``featured_gallery``, ``tabs``, ``password_secret_name`` are accepted for backward compatibility but should not be used for new apps. **Tier limits:** Free = 1 app, Pro = 10, Enterprise = unlimited (``TierLimits._max_apps``). Exceeding your tier\'s limit returns a 400 with the limit + current count in ``error.details``.
|
|
4434
4434
|
* @summary Create an App
|
|
4435
4435
|
* @param {CreateAppRequest} createAppRequest
|
|
4436
4436
|
* @param {*} [options] Override http request option.
|
|
@@ -4948,7 +4948,7 @@ var AppsApiAxiosParamCreator = function(configuration) {
|
|
|
4948
4948
|
};
|
|
4949
4949
|
},
|
|
4950
4950
|
/**
|
|
4951
|
-
* List all Apps for this organization.
|
|
4951
|
+
* List all Apps for this organization. The response includes ``max_apps`` (the tier\'s Canvas App limit, ``null`` = unlimited) so the UI can render usage (\"X of N apps used\") and gate the create action without a second round-trip.
|
|
4952
4952
|
* @summary List Apps
|
|
4953
4953
|
* @param {number} [limit]
|
|
4954
4954
|
* @param {number} [offset]
|
|
@@ -5394,7 +5394,7 @@ var AppsApiFp = function(configuration) {
|
|
|
5394
5394
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
5395
5395
|
},
|
|
5396
5396
|
/**
|
|
5397
|
-
* Create a new App. Apps are full-stack web applications deployed as zip bundles to ``{slug}.mxp.co``. After creation, deploy your built frontend via the deploy pipeline: 1. ``POST /v1/apps/{app_id}/deploy/upload-url`` — get a presigned S3 PUT URL 2. Upload your built ``dist/`` zip to that URL 3. ``POST /v1/apps/{app_id}/deploy`` — trigger the build Only ``slug`` and ``meta`` are required. Set ``auth_config.mode`` to control end-user authentication (``public``, ``clerk``, ``password``, ``api_key``, ``jwt``, ``sso_oidc``, ``sso_saml``). Slugs are globally unique across all organizations. **Deprecated fields:** ``template``, ``sections``, ``custom_html``, ``hero``, ``theme``, ``seo``, ``stats``, ``featured_gallery``, ``tabs``, ``password_secret_name`` are accepted for backward compatibility but should not be used for new apps.
|
|
5397
|
+
* Create a new App. Apps are full-stack web applications deployed as zip bundles to ``{slug}.mxp.co``. After creation, deploy your built frontend via the deploy pipeline: 1. ``POST /v1/apps/{app_id}/deploy/upload-url`` — get a presigned S3 PUT URL 2. Upload your built ``dist/`` zip to that URL 3. ``POST /v1/apps/{app_id}/deploy`` — trigger the build Only ``slug`` and ``meta`` are required. Set ``auth_config.mode`` to control end-user authentication (``public``, ``clerk``, ``password``, ``api_key``, ``jwt``, ``sso_oidc``, ``sso_saml``). Slugs are globally unique across all organizations. **Deprecated fields:** ``template``, ``sections``, ``custom_html``, ``hero``, ``theme``, ``seo``, ``stats``, ``featured_gallery``, ``tabs``, ``password_secret_name`` are accepted for backward compatibility but should not be used for new apps. **Tier limits:** Free = 1 app, Pro = 10, Enterprise = unlimited (``TierLimits._max_apps``). Exceeding your tier\'s limit returns a 400 with the limit + current count in ``error.details``.
|
|
5398
5398
|
* @summary Create an App
|
|
5399
5399
|
* @param {CreateAppRequest} createAppRequest
|
|
5400
5400
|
* @param {*} [options] Override http request option.
|
|
@@ -5643,7 +5643,7 @@ var AppsApiFp = function(configuration) {
|
|
|
5643
5643
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
5644
5644
|
},
|
|
5645
5645
|
/**
|
|
5646
|
-
* List all Apps for this organization.
|
|
5646
|
+
* List all Apps for this organization. The response includes ``max_apps`` (the tier\'s Canvas App limit, ``null`` = unlimited) so the UI can render usage (\"X of N apps used\") and gate the create action without a second round-trip.
|
|
5647
5647
|
* @summary List Apps
|
|
5648
5648
|
* @param {number} [limit]
|
|
5649
5649
|
* @param {number} [offset]
|
|
@@ -5865,7 +5865,7 @@ var AppsApi = class extends BaseAPI {
|
|
|
5865
5865
|
return AppsApiFp(this.configuration).connectRepoApps(requestParameters.appId, requestParameters.connectRepoRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5866
5866
|
}
|
|
5867
5867
|
/**
|
|
5868
|
-
* Create a new App. Apps are full-stack web applications deployed as zip bundles to ``{slug}.mxp.co``. After creation, deploy your built frontend via the deploy pipeline: 1. ``POST /v1/apps/{app_id}/deploy/upload-url`` — get a presigned S3 PUT URL 2. Upload your built ``dist/`` zip to that URL 3. ``POST /v1/apps/{app_id}/deploy`` — trigger the build Only ``slug`` and ``meta`` are required. Set ``auth_config.mode`` to control end-user authentication (``public``, ``clerk``, ``password``, ``api_key``, ``jwt``, ``sso_oidc``, ``sso_saml``). Slugs are globally unique across all organizations. **Deprecated fields:** ``template``, ``sections``, ``custom_html``, ``hero``, ``theme``, ``seo``, ``stats``, ``featured_gallery``, ``tabs``, ``password_secret_name`` are accepted for backward compatibility but should not be used for new apps.
|
|
5868
|
+
* Create a new App. Apps are full-stack web applications deployed as zip bundles to ``{slug}.mxp.co``. After creation, deploy your built frontend via the deploy pipeline: 1. ``POST /v1/apps/{app_id}/deploy/upload-url`` — get a presigned S3 PUT URL 2. Upload your built ``dist/`` zip to that URL 3. ``POST /v1/apps/{app_id}/deploy`` — trigger the build Only ``slug`` and ``meta`` are required. Set ``auth_config.mode`` to control end-user authentication (``public``, ``clerk``, ``password``, ``api_key``, ``jwt``, ``sso_oidc``, ``sso_saml``). Slugs are globally unique across all organizations. **Deprecated fields:** ``template``, ``sections``, ``custom_html``, ``hero``, ``theme``, ``seo``, ``stats``, ``featured_gallery``, ``tabs``, ``password_secret_name`` are accepted for backward compatibility but should not be used for new apps. **Tier limits:** Free = 1 app, Pro = 10, Enterprise = unlimited (``TierLimits._max_apps``). Exceeding your tier\'s limit returns a 400 with the limit + current count in ``error.details``.
|
|
5869
5869
|
* @summary Create an App
|
|
5870
5870
|
* @param {AppsApiCreateAppRequest} requestParameters Request parameters.
|
|
5871
5871
|
* @param {*} [options] Override http request option.
|
|
@@ -6063,7 +6063,7 @@ var AppsApi = class extends BaseAPI {
|
|
|
6063
6063
|
return AppsApiFp(this.configuration).listAppUsers(requestParameters.appId, options).then((request) => request(this.axios, this.basePath));
|
|
6064
6064
|
}
|
|
6065
6065
|
/**
|
|
6066
|
-
* List all Apps for this organization.
|
|
6066
|
+
* List all Apps for this organization. The response includes ``max_apps`` (the tier\'s Canvas App limit, ``null`` = unlimited) so the UI can render usage (\"X of N apps used\") and gate the create action without a second round-trip.
|
|
6067
6067
|
* @summary List Apps
|
|
6068
6068
|
* @param {AppsApiListAppsRequest} requestParameters Request parameters.
|
|
6069
6069
|
* @param {*} [options] Override http request option.
|
|
@@ -6704,6 +6704,34 @@ var BucketBatchesApiAxiosParamCreator = function(configuration) {
|
|
|
6704
6704
|
options: localVarRequestOptions
|
|
6705
6705
|
};
|
|
6706
6706
|
},
|
|
6707
|
+
/**
|
|
6708
|
+
* Pre-flight estimate of the credits a DRAFT batch will consume on submit, plus how many of its objects were already extracted — so a force/replace re-run that re-pays GPU extraction surfaces its cost BEFORE submitting. Read-only: does not consume credits or change the batch.
|
|
6709
|
+
* @summary Estimate Batch Cost (pre-flight, dry-run)
|
|
6710
|
+
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
6711
|
+
* @param {string} batchId The unique identifier of the batch.
|
|
6712
|
+
* @param {*} [options] Override http request option.
|
|
6713
|
+
* @throws {RequiredError}
|
|
6714
|
+
*/
|
|
6715
|
+
estimateBatchCostBucketsBatches: async (bucketIdentifier, batchId, options = {}) => {
|
|
6716
|
+
assertParamExists("estimateBatchCostBucketsBatches", "bucketIdentifier", bucketIdentifier);
|
|
6717
|
+
assertParamExists("estimateBatchCostBucketsBatches", "batchId", batchId);
|
|
6718
|
+
const localVarPath = `/v1/buckets/{bucket_identifier}/batches/{batch_id}/estimate-cost`.replace(`{${"bucket_identifier"}}`, encodeURIComponent(String(bucketIdentifier))).replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)));
|
|
6719
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6720
|
+
let baseOptions;
|
|
6721
|
+
if (configuration) {
|
|
6722
|
+
baseOptions = configuration.baseOptions;
|
|
6723
|
+
}
|
|
6724
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
6725
|
+
const localVarHeaderParameter = {};
|
|
6726
|
+
const localVarQueryParameter = {};
|
|
6727
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6728
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6729
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6730
|
+
return {
|
|
6731
|
+
url: toPathString(localVarUrlObj),
|
|
6732
|
+
options: localVarRequestOptions
|
|
6733
|
+
};
|
|
6734
|
+
},
|
|
6707
6735
|
/**
|
|
6708
6736
|
* Returns the per-tier completion accounting for a batch: how many objects were submitted, how many ended up in the per-object success ledger (processed_objects), how many in the per-object failure ledger (failed_documents), how many were skipped, and how many are \'lost\' (submitted but absent from both per-object ledgers). Phase 1 of INGESTION_RELIABILITY_PLAN.md. ``has_lost_objects=true`` is a smoking gun for the row-failure-swallow class of bug — the tier was marked COMPLETED but rows silently went missing. Compare against ``tier_tasks[].audit`` (persisted at completion) to see the snapshot at the time the callback fired.
|
|
6709
6737
|
* @summary Tier-completion invariant audit
|
|
@@ -7257,6 +7285,20 @@ var BucketBatchesApiFp = function(configuration) {
|
|
|
7257
7285
|
const localVarOperationServerBasePath = operationServerMap["BucketBatchesApi.diagnoseBatchBucketsBatches"]?.[localVarOperationServerIndex]?.url;
|
|
7258
7286
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
7259
7287
|
},
|
|
7288
|
+
/**
|
|
7289
|
+
* Pre-flight estimate of the credits a DRAFT batch will consume on submit, plus how many of its objects were already extracted — so a force/replace re-run that re-pays GPU extraction surfaces its cost BEFORE submitting. Read-only: does not consume credits or change the batch.
|
|
7290
|
+
* @summary Estimate Batch Cost (pre-flight, dry-run)
|
|
7291
|
+
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
7292
|
+
* @param {string} batchId The unique identifier of the batch.
|
|
7293
|
+
* @param {*} [options] Override http request option.
|
|
7294
|
+
* @throws {RequiredError}
|
|
7295
|
+
*/
|
|
7296
|
+
async estimateBatchCostBucketsBatches(bucketIdentifier, batchId, options) {
|
|
7297
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.estimateBatchCostBucketsBatches(bucketIdentifier, batchId, options);
|
|
7298
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7299
|
+
const localVarOperationServerBasePath = operationServerMap["BucketBatchesApi.estimateBatchCostBucketsBatches"]?.[localVarOperationServerIndex]?.url;
|
|
7300
|
+
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
7301
|
+
},
|
|
7260
7302
|
/**
|
|
7261
7303
|
* Returns the per-tier completion accounting for a batch: how many objects were submitted, how many ended up in the per-object success ledger (processed_objects), how many in the per-object failure ledger (failed_documents), how many were skipped, and how many are \'lost\' (submitted but absent from both per-object ledgers). Phase 1 of INGESTION_RELIABILITY_PLAN.md. ``has_lost_objects=true`` is a smoking gun for the row-failure-swallow class of bug — the tier was marked COMPLETED but rows silently went missing. Compare against ``tier_tasks[].audit`` (persisted at completion) to see the snapshot at the time the callback fired.
|
|
7262
7304
|
* @summary Tier-completion invariant audit
|
|
@@ -7555,6 +7597,17 @@ var BucketBatchesApi = class extends BaseAPI {
|
|
|
7555
7597
|
diagnoseBatchBucketsBatches(requestParameters, options) {
|
|
7556
7598
|
return BucketBatchesApiFp(this.configuration).diagnoseBatchBucketsBatches(requestParameters.bucketIdentifier, requestParameters.batchId, options).then((request) => request(this.axios, this.basePath));
|
|
7557
7599
|
}
|
|
7600
|
+
/**
|
|
7601
|
+
* Pre-flight estimate of the credits a DRAFT batch will consume on submit, plus how many of its objects were already extracted — so a force/replace re-run that re-pays GPU extraction surfaces its cost BEFORE submitting. Read-only: does not consume credits or change the batch.
|
|
7602
|
+
* @summary Estimate Batch Cost (pre-flight, dry-run)
|
|
7603
|
+
* @param {BucketBatchesApiEstimateBatchCostBucketsBatchesRequest} requestParameters Request parameters.
|
|
7604
|
+
* @param {*} [options] Override http request option.
|
|
7605
|
+
* @throws {RequiredError}
|
|
7606
|
+
* @memberof BucketBatchesApi
|
|
7607
|
+
*/
|
|
7608
|
+
estimateBatchCostBucketsBatches(requestParameters, options) {
|
|
7609
|
+
return BucketBatchesApiFp(this.configuration).estimateBatchCostBucketsBatches(requestParameters.bucketIdentifier, requestParameters.batchId, options).then((request) => request(this.axios, this.basePath));
|
|
7610
|
+
}
|
|
7558
7611
|
/**
|
|
7559
7612
|
* Returns the per-tier completion accounting for a batch: how many objects were submitted, how many ended up in the per-object success ledger (processed_objects), how many in the per-object failure ledger (failed_documents), how many were skipped, and how many are \'lost\' (submitted but absent from both per-object ledgers). Phase 1 of INGESTION_RELIABILITY_PLAN.md. ``has_lost_objects=true`` is a smoking gun for the row-failure-swallow class of bug — the tier was marked COMPLETED but rows silently went missing. Compare against ``tier_tasks[].audit`` (persisted at completion) to see the snapshot at the time the callback fired.
|
|
7560
7613
|
* @summary Tier-completion invariant audit
|
|
@@ -7862,15 +7915,16 @@ var BucketObjectsApiAxiosParamCreator = function(configuration) {
|
|
|
7862
7915
|
};
|
|
7863
7916
|
},
|
|
7864
7917
|
/**
|
|
7865
|
-
* This endpoint retrieves an object by its ID from the specified bucket. **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs for all blobs with S3 storage (default: false). URLs are added to each blob\'s properties as `presigned_url` and expire after 1 hour.
|
|
7918
|
+
* This endpoint retrieves an object by its ID from the specified bucket. **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs for all blobs with S3 storage (default: false). URLs are added to each blob\'s properties as `presigned_url` and expire after 1 hour. **Document count**: `document_count` (how many documents this object produced, via vector-store lineage) is computed by default. It fans out to the vector partition, which on a cold/serverless partition can be slow — pass `include_document_count=false` to skip it for latency-sensitive, interactive views (e.g. an object-detail modal) that don\'t render the count. Even when requested, the count is best-effort and bounded by a deadline: it returns `null` rather than blocking the response if the partition is cold.
|
|
7866
7919
|
* @summary Get Object
|
|
7867
7920
|
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
7868
7921
|
* @param {string} objectIdentifier The unique identifier of the object.
|
|
7869
7922
|
* @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
|
|
7923
|
+
* @param {boolean} [includeDocumentCount] Compute document_count via vector-store lineage (default true). Pass false to skip the vector fan-out for latency-sensitive views that don\'t render the count.
|
|
7870
7924
|
* @param {*} [options] Override http request option.
|
|
7871
7925
|
* @throws {RequiredError}
|
|
7872
7926
|
*/
|
|
7873
|
-
getObjectBuckets: async (bucketIdentifier, objectIdentifier, returnPresignedUrls, options = {}) => {
|
|
7927
|
+
getObjectBuckets: async (bucketIdentifier, objectIdentifier, returnPresignedUrls, includeDocumentCount, options = {}) => {
|
|
7874
7928
|
assertParamExists("getObjectBuckets", "bucketIdentifier", bucketIdentifier);
|
|
7875
7929
|
assertParamExists("getObjectBuckets", "objectIdentifier", objectIdentifier);
|
|
7876
7930
|
const localVarPath = `/v1/buckets/{bucket_identifier}/objects/{object_identifier}`.replace(`{${"bucket_identifier"}}`, encodeURIComponent(String(bucketIdentifier))).replace(`{${"object_identifier"}}`, encodeURIComponent(String(objectIdentifier)));
|
|
@@ -7885,6 +7939,9 @@ var BucketObjectsApiAxiosParamCreator = function(configuration) {
|
|
|
7885
7939
|
if (returnPresignedUrls !== void 0) {
|
|
7886
7940
|
localVarQueryParameter["return_presigned_urls"] = returnPresignedUrls;
|
|
7887
7941
|
}
|
|
7942
|
+
if (includeDocumentCount !== void 0) {
|
|
7943
|
+
localVarQueryParameter["include_document_count"] = includeDocumentCount;
|
|
7944
|
+
}
|
|
7888
7945
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7889
7946
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7890
7947
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -8139,16 +8196,17 @@ var BucketObjectsApiFp = function(configuration) {
|
|
|
8139
8196
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
8140
8197
|
},
|
|
8141
8198
|
/**
|
|
8142
|
-
* This endpoint retrieves an object by its ID from the specified bucket. **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs for all blobs with S3 storage (default: false). URLs are added to each blob\'s properties as `presigned_url` and expire after 1 hour.
|
|
8199
|
+
* This endpoint retrieves an object by its ID from the specified bucket. **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs for all blobs with S3 storage (default: false). URLs are added to each blob\'s properties as `presigned_url` and expire after 1 hour. **Document count**: `document_count` (how many documents this object produced, via vector-store lineage) is computed by default. It fans out to the vector partition, which on a cold/serverless partition can be slow — pass `include_document_count=false` to skip it for latency-sensitive, interactive views (e.g. an object-detail modal) that don\'t render the count. Even when requested, the count is best-effort and bounded by a deadline: it returns `null` rather than blocking the response if the partition is cold.
|
|
8143
8200
|
* @summary Get Object
|
|
8144
8201
|
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
8145
8202
|
* @param {string} objectIdentifier The unique identifier of the object.
|
|
8146
8203
|
* @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
|
|
8204
|
+
* @param {boolean} [includeDocumentCount] Compute document_count via vector-store lineage (default true). Pass false to skip the vector fan-out for latency-sensitive views that don\'t render the count.
|
|
8147
8205
|
* @param {*} [options] Override http request option.
|
|
8148
8206
|
* @throws {RequiredError}
|
|
8149
8207
|
*/
|
|
8150
|
-
async getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, options) {
|
|
8151
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, options);
|
|
8208
|
+
async getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, includeDocumentCount, options) {
|
|
8209
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, includeDocumentCount, options);
|
|
8152
8210
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8153
8211
|
const localVarOperationServerBasePath = operationServerMap["BucketObjectsApi.getObjectBuckets"]?.[localVarOperationServerIndex]?.url;
|
|
8154
8212
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -8281,7 +8339,7 @@ var BucketObjectsApi = class extends BaseAPI {
|
|
|
8281
8339
|
return BucketObjectsApiFp(this.configuration).deleteObjectBuckets(requestParameters.bucketIdentifier, requestParameters.objectIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
8282
8340
|
}
|
|
8283
8341
|
/**
|
|
8284
|
-
* This endpoint retrieves an object by its ID from the specified bucket. **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs for all blobs with S3 storage (default: false). URLs are added to each blob\'s properties as `presigned_url` and expire after 1 hour.
|
|
8342
|
+
* This endpoint retrieves an object by its ID from the specified bucket. **Presigned URLs**: Set `return_presigned_urls=true` query parameter to generate fresh presigned download URLs for all blobs with S3 storage (default: false). URLs are added to each blob\'s properties as `presigned_url` and expire after 1 hour. **Document count**: `document_count` (how many documents this object produced, via vector-store lineage) is computed by default. It fans out to the vector partition, which on a cold/serverless partition can be slow — pass `include_document_count=false` to skip it for latency-sensitive, interactive views (e.g. an object-detail modal) that don\'t render the count. Even when requested, the count is best-effort and bounded by a deadline: it returns `null` rather than blocking the response if the partition is cold.
|
|
8285
8343
|
* @summary Get Object
|
|
8286
8344
|
* @param {BucketObjectsApiGetObjectBucketsRequest} requestParameters Request parameters.
|
|
8287
8345
|
* @param {*} [options] Override http request option.
|
|
@@ -8289,7 +8347,7 @@ var BucketObjectsApi = class extends BaseAPI {
|
|
|
8289
8347
|
* @memberof BucketObjectsApi
|
|
8290
8348
|
*/
|
|
8291
8349
|
getObjectBuckets(requestParameters, options) {
|
|
8292
|
-
return BucketObjectsApiFp(this.configuration).getObjectBuckets(requestParameters.bucketIdentifier, requestParameters.objectIdentifier, requestParameters.returnPresignedUrls, options).then((request) => request(this.axios, this.basePath));
|
|
8350
|
+
return BucketObjectsApiFp(this.configuration).getObjectBuckets(requestParameters.bucketIdentifier, requestParameters.objectIdentifier, requestParameters.returnPresignedUrls, requestParameters.includeDocumentCount, options).then((request) => request(this.axios, this.basePath));
|
|
8293
8351
|
}
|
|
8294
8352
|
/**
|
|
8295
8353
|
* This endpoint lists objects in a bucket with cursor-based pagination, filtering, and sorting. **Filtering**: Use dot notation for metadata fields - Example: ?metadata.type=video&metadata.status=ready **Sorting**: Specify field and direction - Example: ?sort_field=metadata.created_at&sort_direction=desc - Direction: asc (ascending) or desc (descending), defaults to asc **Pagination**: Cursor-based for efficient deep pagination - First page: ?limit=100 (omit cursor) - Next pages: ?limit=100&cursor={next_cursor} - Use next_cursor from response to navigate - No limit on pagination depth **Total Count**: Optional (expensive operation) - Use ?include_total=true to get total count - Adds 50-200ms to response time - Returns total, page, page_size, total_pages fields in pagination response
|
|
@@ -9650,10 +9708,11 @@ var BucketsApiAxiosParamCreator = function(configuration) {
|
|
|
9650
9708
|
* This endpoint deletes a bucket and all its resources including: - S3 objects and blobs - Running Ray jobs (cancels active batch processing jobs) - Batch processing artifacts - Upload files - Unique key lookups - MongoDB metadata The deletion is performed **asynchronously** via a background task. Returns immediately with a task_id that can be polled via GET /v1/tasks/{task_id}. **Response**: - `task_id`: Use this to poll deletion status via GET /v1/tasks/{task_id} - `status`: Initial status (PENDING) - `bucket_id`: The bucket being deleted - `bucket_name`: Name of the bucket - `object_count`: Number of objects that will be deleted **Polling**: Poll GET /v1/tasks/{task_id} until status is COMPLETED or FAILED. Use exponential backoff (start 1s, max 30s).
|
|
9651
9709
|
* @summary Delete Bucket
|
|
9652
9710
|
* @param {string} bucketIdentifier
|
|
9711
|
+
* @param {boolean} [forceForeclose]
|
|
9653
9712
|
* @param {*} [options] Override http request option.
|
|
9654
9713
|
* @throws {RequiredError}
|
|
9655
9714
|
*/
|
|
9656
|
-
deleteBucket: async (bucketIdentifier, options = {}) => {
|
|
9715
|
+
deleteBucket: async (bucketIdentifier, forceForeclose, options = {}) => {
|
|
9657
9716
|
assertParamExists("deleteBucket", "bucketIdentifier", bucketIdentifier);
|
|
9658
9717
|
const localVarPath = `/v1/buckets/{bucket_identifier}`.replace(`{${"bucket_identifier"}}`, encodeURIComponent(String(bucketIdentifier)));
|
|
9659
9718
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -9664,6 +9723,9 @@ var BucketsApiAxiosParamCreator = function(configuration) {
|
|
|
9664
9723
|
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
9665
9724
|
const localVarHeaderParameter = {};
|
|
9666
9725
|
const localVarQueryParameter = {};
|
|
9726
|
+
if (forceForeclose !== void 0) {
|
|
9727
|
+
localVarQueryParameter["force_foreclose"] = forceForeclose;
|
|
9728
|
+
}
|
|
9667
9729
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9668
9730
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9669
9731
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -9859,11 +9921,12 @@ var BucketsApiFp = function(configuration) {
|
|
|
9859
9921
|
* This endpoint deletes a bucket and all its resources including: - S3 objects and blobs - Running Ray jobs (cancels active batch processing jobs) - Batch processing artifacts - Upload files - Unique key lookups - MongoDB metadata The deletion is performed **asynchronously** via a background task. Returns immediately with a task_id that can be polled via GET /v1/tasks/{task_id}. **Response**: - `task_id`: Use this to poll deletion status via GET /v1/tasks/{task_id} - `status`: Initial status (PENDING) - `bucket_id`: The bucket being deleted - `bucket_name`: Name of the bucket - `object_count`: Number of objects that will be deleted **Polling**: Poll GET /v1/tasks/{task_id} until status is COMPLETED or FAILED. Use exponential backoff (start 1s, max 30s).
|
|
9860
9922
|
* @summary Delete Bucket
|
|
9861
9923
|
* @param {string} bucketIdentifier
|
|
9924
|
+
* @param {boolean} [forceForeclose]
|
|
9862
9925
|
* @param {*} [options] Override http request option.
|
|
9863
9926
|
* @throws {RequiredError}
|
|
9864
9927
|
*/
|
|
9865
|
-
async deleteBucket(bucketIdentifier, options) {
|
|
9866
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBucket(bucketIdentifier, options);
|
|
9928
|
+
async deleteBucket(bucketIdentifier, forceForeclose, options) {
|
|
9929
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBucket(bucketIdentifier, forceForeclose, options);
|
|
9867
9930
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9868
9931
|
const localVarOperationServerBasePath = operationServerMap["BucketsApi.deleteBucket"]?.[localVarOperationServerIndex]?.url;
|
|
9869
9932
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -9964,7 +10027,7 @@ var BucketsApi = class extends BaseAPI {
|
|
|
9964
10027
|
* @memberof BucketsApi
|
|
9965
10028
|
*/
|
|
9966
10029
|
deleteBucket(requestParameters, options) {
|
|
9967
|
-
return BucketsApiFp(this.configuration).deleteBucket(requestParameters.bucketIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
10030
|
+
return BucketsApiFp(this.configuration).deleteBucket(requestParameters.bucketIdentifier, requestParameters.forceForeclose, options).then((request) => request(this.axios, this.basePath));
|
|
9968
10031
|
}
|
|
9969
10032
|
/**
|
|
9970
10033
|
* This endpoint retrieves a bucket by its ID.
|
|
@@ -11002,6 +11065,32 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11002
11065
|
options: localVarRequestOptions
|
|
11003
11066
|
};
|
|
11004
11067
|
},
|
|
11068
|
+
/**
|
|
11069
|
+
* Return the total number of documents in the collection. This is the obvious REST endpoint for a document count; it is declared before the `/{document_id}` route so the literal `count` segment is never matched as a document id (which previously produced a misleading 404).
|
|
11070
|
+
* @summary Count documents in a collection.
|
|
11071
|
+
* @param {string} collectionIdentifier The ID of the collection to count documents in.
|
|
11072
|
+
* @param {*} [options] Override http request option.
|
|
11073
|
+
* @throws {RequiredError}
|
|
11074
|
+
*/
|
|
11075
|
+
countDocuments: async (collectionIdentifier, options = {}) => {
|
|
11076
|
+
assertParamExists("countDocuments", "collectionIdentifier", collectionIdentifier);
|
|
11077
|
+
const localVarPath = `/v1/collections/{collection_identifier}/documents/count`.replace(`{${"collection_identifier"}}`, encodeURIComponent(String(collectionIdentifier)));
|
|
11078
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11079
|
+
let baseOptions;
|
|
11080
|
+
if (configuration) {
|
|
11081
|
+
baseOptions = configuration.baseOptions;
|
|
11082
|
+
}
|
|
11083
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
11084
|
+
const localVarHeaderParameter = {};
|
|
11085
|
+
const localVarQueryParameter = {};
|
|
11086
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11087
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11088
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
11089
|
+
return {
|
|
11090
|
+
url: toPathString(localVarUrlObj),
|
|
11091
|
+
options: localVarRequestOptions
|
|
11092
|
+
};
|
|
11093
|
+
},
|
|
11005
11094
|
/**
|
|
11006
11095
|
* Create a document by ID.
|
|
11007
11096
|
* @summary Create a document.
|
|
@@ -11196,6 +11285,9 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11196
11285
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11197
11286
|
* @param {boolean} [returnPresignedUrls] Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either is true, presigning is enabled.
|
|
11198
11287
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11288
|
+
* @param {string} [filters] URL-encoded JSON filter (LogicalOperator shape: {\"AND\":[{\"field\":\"metadata.status\",\"operator\":\"eq\",\"value\":\"active\"}]}; OR/NOT also supported). Applies to the GET listing. POST /documents/list callers should send `filters` in the JSON body instead — the body wins when both are present. Invalid JSON returns 422 (never silently ignored).
|
|
11289
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11290
|
+
* @param {string} [sort] Sort spec as JSON ({\"field\":\"created_at\",\"direction\":\"desc\"}) or the compact \"field:direction\" form. Body `sort` wins when both are set.
|
|
11199
11291
|
* @param {number} [limit]
|
|
11200
11292
|
* @param {number} [pageSize]
|
|
11201
11293
|
* @param {number} [offset]
|
|
@@ -11206,7 +11298,7 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11206
11298
|
* @param {*} [options] Override http request option.
|
|
11207
11299
|
* @throws {RequiredError}
|
|
11208
11300
|
*/
|
|
11209
|
-
listDocuments: async (collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11301
|
+
listDocuments: async (collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11210
11302
|
assertParamExists("listDocuments", "collectionIdentifier", collectionIdentifier);
|
|
11211
11303
|
const localVarPath = `/v1/collections/{collection_identifier}/documents/list`.replace(`{${"collection_identifier"}}`, encodeURIComponent(String(collectionIdentifier)));
|
|
11212
11304
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11223,6 +11315,15 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11223
11315
|
if (returnVectors !== void 0) {
|
|
11224
11316
|
localVarQueryParameter["return_vectors"] = returnVectors;
|
|
11225
11317
|
}
|
|
11318
|
+
if (filters !== void 0) {
|
|
11319
|
+
localVarQueryParameter["filters"] = filters;
|
|
11320
|
+
}
|
|
11321
|
+
if (search !== void 0) {
|
|
11322
|
+
localVarQueryParameter["search"] = search;
|
|
11323
|
+
}
|
|
11324
|
+
if (sort !== void 0) {
|
|
11325
|
+
localVarQueryParameter["sort"] = sort;
|
|
11326
|
+
}
|
|
11226
11327
|
if (limit !== void 0) {
|
|
11227
11328
|
localVarQueryParameter["limit"] = limit;
|
|
11228
11329
|
}
|
|
@@ -11257,6 +11358,9 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11257
11358
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11258
11359
|
* @param {boolean} [returnPresignedUrls] Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either is true, presigning is enabled.
|
|
11259
11360
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11361
|
+
* @param {string} [filters] URL-encoded JSON filter (LogicalOperator shape: {\"AND\":[{\"field\":\"metadata.status\",\"operator\":\"eq\",\"value\":\"active\"}]}; OR/NOT also supported). Applies to the GET listing. POST /documents/list callers should send `filters` in the JSON body instead — the body wins when both are present. Invalid JSON returns 422 (never silently ignored).
|
|
11362
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11363
|
+
* @param {string} [sort] Sort spec as JSON ({\"field\":\"created_at\",\"direction\":\"desc\"}) or the compact \"field:direction\" form. Body `sort` wins when both are set.
|
|
11260
11364
|
* @param {number} [limit]
|
|
11261
11365
|
* @param {number} [pageSize]
|
|
11262
11366
|
* @param {number} [offset]
|
|
@@ -11267,7 +11371,7 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11267
11371
|
* @param {*} [options] Override http request option.
|
|
11268
11372
|
* @throws {RequiredError}
|
|
11269
11373
|
*/
|
|
11270
|
-
listDocuments_1: async (collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11374
|
+
listDocuments_1: async (collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11271
11375
|
assertParamExists("listDocuments_1", "collectionIdentifier", collectionIdentifier);
|
|
11272
11376
|
const localVarPath = `/v1/collections/{collection_identifier}/documents`.replace(`{${"collection_identifier"}}`, encodeURIComponent(String(collectionIdentifier)));
|
|
11273
11377
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11284,6 +11388,15 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11284
11388
|
if (returnVectors !== void 0) {
|
|
11285
11389
|
localVarQueryParameter["return_vectors"] = returnVectors;
|
|
11286
11390
|
}
|
|
11391
|
+
if (filters !== void 0) {
|
|
11392
|
+
localVarQueryParameter["filters"] = filters;
|
|
11393
|
+
}
|
|
11394
|
+
if (search !== void 0) {
|
|
11395
|
+
localVarQueryParameter["search"] = search;
|
|
11396
|
+
}
|
|
11397
|
+
if (sort !== void 0) {
|
|
11398
|
+
localVarQueryParameter["sort"] = sort;
|
|
11399
|
+
}
|
|
11287
11400
|
if (limit !== void 0) {
|
|
11288
11401
|
localVarQueryParameter["limit"] = limit;
|
|
11289
11402
|
}
|
|
@@ -11499,6 +11612,19 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11499
11612
|
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.bulkUpdate"]?.[localVarOperationServerIndex]?.url;
|
|
11500
11613
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
11501
11614
|
},
|
|
11615
|
+
/**
|
|
11616
|
+
* Return the total number of documents in the collection. This is the obvious REST endpoint for a document count; it is declared before the `/{document_id}` route so the literal `count` segment is never matched as a document id (which previously produced a misleading 404).
|
|
11617
|
+
* @summary Count documents in a collection.
|
|
11618
|
+
* @param {string} collectionIdentifier The ID of the collection to count documents in.
|
|
11619
|
+
* @param {*} [options] Override http request option.
|
|
11620
|
+
* @throws {RequiredError}
|
|
11621
|
+
*/
|
|
11622
|
+
async countDocuments(collectionIdentifier, options) {
|
|
11623
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.countDocuments(collectionIdentifier, options);
|
|
11624
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11625
|
+
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.countDocuments"]?.[localVarOperationServerIndex]?.url;
|
|
11626
|
+
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
11627
|
+
},
|
|
11502
11628
|
/**
|
|
11503
11629
|
* Create a document by ID.
|
|
11504
11630
|
* @summary Create a document.
|
|
@@ -11593,6 +11719,9 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11593
11719
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11594
11720
|
* @param {boolean} [returnPresignedUrls] Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either is true, presigning is enabled.
|
|
11595
11721
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11722
|
+
* @param {string} [filters] URL-encoded JSON filter (LogicalOperator shape: {\"AND\":[{\"field\":\"metadata.status\",\"operator\":\"eq\",\"value\":\"active\"}]}; OR/NOT also supported). Applies to the GET listing. POST /documents/list callers should send `filters` in the JSON body instead — the body wins when both are present. Invalid JSON returns 422 (never silently ignored).
|
|
11723
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11724
|
+
* @param {string} [sort] Sort spec as JSON ({\"field\":\"created_at\",\"direction\":\"desc\"}) or the compact \"field:direction\" form. Body `sort` wins when both are set.
|
|
11596
11725
|
* @param {number} [limit]
|
|
11597
11726
|
* @param {number} [pageSize]
|
|
11598
11727
|
* @param {number} [offset]
|
|
@@ -11603,8 +11732,8 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11603
11732
|
* @param {*} [options] Override http request option.
|
|
11604
11733
|
* @throws {RequiredError}
|
|
11605
11734
|
*/
|
|
11606
|
-
async listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11607
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11735
|
+
async listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11736
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11608
11737
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11609
11738
|
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.listDocuments"]?.[localVarOperationServerIndex]?.url;
|
|
11610
11739
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -11615,6 +11744,9 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11615
11744
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11616
11745
|
* @param {boolean} [returnPresignedUrls] Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either is true, presigning is enabled.
|
|
11617
11746
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11747
|
+
* @param {string} [filters] URL-encoded JSON filter (LogicalOperator shape: {\"AND\":[{\"field\":\"metadata.status\",\"operator\":\"eq\",\"value\":\"active\"}]}; OR/NOT also supported). Applies to the GET listing. POST /documents/list callers should send `filters` in the JSON body instead — the body wins when both are present. Invalid JSON returns 422 (never silently ignored).
|
|
11748
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11749
|
+
* @param {string} [sort] Sort spec as JSON ({\"field\":\"created_at\",\"direction\":\"desc\"}) or the compact \"field:direction\" form. Body `sort` wins when both are set.
|
|
11618
11750
|
* @param {number} [limit]
|
|
11619
11751
|
* @param {number} [pageSize]
|
|
11620
11752
|
* @param {number} [offset]
|
|
@@ -11625,8 +11757,8 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11625
11757
|
* @param {*} [options] Override http request option.
|
|
11626
11758
|
* @throws {RequiredError}
|
|
11627
11759
|
*/
|
|
11628
|
-
async listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11629
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11760
|
+
async listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11761
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11630
11762
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11631
11763
|
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.listDocuments_1"]?.[localVarOperationServerIndex]?.url;
|
|
11632
11764
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -11737,6 +11869,17 @@ var CollectionDocumentsApi = class extends BaseAPI {
|
|
|
11737
11869
|
bulkUpdate(requestParameters, options) {
|
|
11738
11870
|
return CollectionDocumentsApiFp(this.configuration).bulkUpdate(requestParameters.collectionIdentifier, requestParameters.bulkUpdateDocumentsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11739
11871
|
}
|
|
11872
|
+
/**
|
|
11873
|
+
* Return the total number of documents in the collection. This is the obvious REST endpoint for a document count; it is declared before the `/{document_id}` route so the literal `count` segment is never matched as a document id (which previously produced a misleading 404).
|
|
11874
|
+
* @summary Count documents in a collection.
|
|
11875
|
+
* @param {CollectionDocumentsApiCountDocumentsRequest} requestParameters Request parameters.
|
|
11876
|
+
* @param {*} [options] Override http request option.
|
|
11877
|
+
* @throws {RequiredError}
|
|
11878
|
+
* @memberof CollectionDocumentsApi
|
|
11879
|
+
*/
|
|
11880
|
+
countDocuments(requestParameters, options) {
|
|
11881
|
+
return CollectionDocumentsApiFp(this.configuration).countDocuments(requestParameters.collectionIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
11882
|
+
}
|
|
11740
11883
|
/**
|
|
11741
11884
|
* Create a document by ID.
|
|
11742
11885
|
* @summary Create a document.
|
|
@@ -11812,7 +11955,7 @@ var CollectionDocumentsApi = class extends BaseAPI {
|
|
|
11812
11955
|
* @memberof CollectionDocumentsApi
|
|
11813
11956
|
*/
|
|
11814
11957
|
listDocuments(requestParameters, options) {
|
|
11815
|
-
return CollectionDocumentsApiFp(this.configuration).listDocuments(requestParameters.collectionIdentifier, requestParameters.returnPresignedUrls, requestParameters.returnVectors, requestParameters.limit, requestParameters.pageSize, requestParameters.offset, requestParameters.page, requestParameters.cursor, requestParameters.includeTotal, requestParameters.listDocumentsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11958
|
+
return CollectionDocumentsApiFp(this.configuration).listDocuments(requestParameters.collectionIdentifier, requestParameters.returnPresignedUrls, requestParameters.returnVectors, requestParameters.filters, requestParameters.search, requestParameters.sort, requestParameters.limit, requestParameters.pageSize, requestParameters.offset, requestParameters.page, requestParameters.cursor, requestParameters.includeTotal, requestParameters.listDocumentsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11816
11959
|
}
|
|
11817
11960
|
/**
|
|
11818
11961
|
* List documents with optional grouping support. Supports two modes: 1. Regular listing: Returns flat list of documents with pagination 2. Grouped listing: When group_by is specified, returns documents grouped by field value When using group_by: - Requires a payload index on the specified field in Qdrant - Pagination applies to groups, not individual documents - Each group contains all documents sharing the same field value
|
|
@@ -11823,7 +11966,7 @@ var CollectionDocumentsApi = class extends BaseAPI {
|
|
|
11823
11966
|
* @memberof CollectionDocumentsApi
|
|
11824
11967
|
*/
|
|
11825
11968
|
listDocuments_1(requestParameters, options) {
|
|
11826
|
-
return CollectionDocumentsApiFp(this.configuration).listDocuments_1(requestParameters.collectionIdentifier, requestParameters.returnPresignedUrls, requestParameters.returnVectors, requestParameters.limit, requestParameters.pageSize, requestParameters.offset, requestParameters.page, requestParameters.cursor, requestParameters.includeTotal, requestParameters.listDocumentsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11969
|
+
return CollectionDocumentsApiFp(this.configuration).listDocuments_1(requestParameters.collectionIdentifier, requestParameters.returnPresignedUrls, requestParameters.returnVectors, requestParameters.filters, requestParameters.search, requestParameters.sort, requestParameters.limit, requestParameters.pageSize, requestParameters.offset, requestParameters.page, requestParameters.cursor, requestParameters.includeTotal, requestParameters.listDocumentsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11827
11970
|
}
|
|
11828
11971
|
/**
|
|
11829
11972
|
* Partially update a document by ID (PATCH operation).
|
|
@@ -13547,6 +13690,34 @@ var NamespacesApiAxiosParamCreator = function(configuration) {
|
|
|
13547
13690
|
options: localVarRequestOptions
|
|
13548
13691
|
};
|
|
13549
13692
|
},
|
|
13693
|
+
/**
|
|
13694
|
+
* Returns document/bucket/collection/object counts for many namespaces in ONE call. Replaces per-row /stats fan-out on list views. Counts are aggregated in batch and live doc-counts gathered concurrently; namespaces the caller cannot see are omitted.
|
|
13695
|
+
* @summary Get Namespace Stats (Batch)
|
|
13696
|
+
* @param {NamespaceStatsBatchRequest} namespaceStatsBatchRequest
|
|
13697
|
+
* @param {*} [options] Override http request option.
|
|
13698
|
+
* @throws {RequiredError}
|
|
13699
|
+
*/
|
|
13700
|
+
getNamespaceStatsBatch: async (namespaceStatsBatchRequest, options = {}) => {
|
|
13701
|
+
assertParamExists("getNamespaceStatsBatch", "namespaceStatsBatchRequest", namespaceStatsBatchRequest);
|
|
13702
|
+
const localVarPath = `/v1/namespaces/stats/batch`;
|
|
13703
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13704
|
+
let baseOptions;
|
|
13705
|
+
if (configuration) {
|
|
13706
|
+
baseOptions = configuration.baseOptions;
|
|
13707
|
+
}
|
|
13708
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
13709
|
+
const localVarHeaderParameter = {};
|
|
13710
|
+
const localVarQueryParameter = {};
|
|
13711
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
13712
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13713
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13714
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
13715
|
+
localVarRequestOptions.data = serializeDataIfNeeded(namespaceStatsBatchRequest, localVarRequestOptions, configuration);
|
|
13716
|
+
return {
|
|
13717
|
+
url: toPathString(localVarUrlObj),
|
|
13718
|
+
options: localVarRequestOptions
|
|
13719
|
+
};
|
|
13720
|
+
},
|
|
13550
13721
|
/**
|
|
13551
13722
|
* List all namespaces for a user
|
|
13552
13723
|
* @summary List Namespaces
|
|
@@ -13786,6 +13957,19 @@ var NamespacesApiFp = function(configuration) {
|
|
|
13786
13957
|
const localVarOperationServerBasePath = operationServerMap["NamespacesApi.getNamespaceStats"]?.[localVarOperationServerIndex]?.url;
|
|
13787
13958
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
13788
13959
|
},
|
|
13960
|
+
/**
|
|
13961
|
+
* Returns document/bucket/collection/object counts for many namespaces in ONE call. Replaces per-row /stats fan-out on list views. Counts are aggregated in batch and live doc-counts gathered concurrently; namespaces the caller cannot see are omitted.
|
|
13962
|
+
* @summary Get Namespace Stats (Batch)
|
|
13963
|
+
* @param {NamespaceStatsBatchRequest} namespaceStatsBatchRequest
|
|
13964
|
+
* @param {*} [options] Override http request option.
|
|
13965
|
+
* @throws {RequiredError}
|
|
13966
|
+
*/
|
|
13967
|
+
async getNamespaceStatsBatch(namespaceStatsBatchRequest, options) {
|
|
13968
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getNamespaceStatsBatch(namespaceStatsBatchRequest, options);
|
|
13969
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13970
|
+
const localVarOperationServerBasePath = operationServerMap["NamespacesApi.getNamespaceStatsBatch"]?.[localVarOperationServerIndex]?.url;
|
|
13971
|
+
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
13972
|
+
},
|
|
13789
13973
|
/**
|
|
13790
13974
|
* List all namespaces for a user
|
|
13791
13975
|
* @summary List Namespaces
|
|
@@ -13911,6 +14095,17 @@ var NamespacesApi = class extends BaseAPI {
|
|
|
13911
14095
|
getNamespaceStats(requestParameters, options) {
|
|
13912
14096
|
return NamespacesApiFp(this.configuration).getNamespaceStats(requestParameters.namespaceIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
13913
14097
|
}
|
|
14098
|
+
/**
|
|
14099
|
+
* Returns document/bucket/collection/object counts for many namespaces in ONE call. Replaces per-row /stats fan-out on list views. Counts are aggregated in batch and live doc-counts gathered concurrently; namespaces the caller cannot see are omitted.
|
|
14100
|
+
* @summary Get Namespace Stats (Batch)
|
|
14101
|
+
* @param {NamespacesApiGetNamespaceStatsBatchRequest} requestParameters Request parameters.
|
|
14102
|
+
* @param {*} [options] Override http request option.
|
|
14103
|
+
* @throws {RequiredError}
|
|
14104
|
+
* @memberof NamespacesApi
|
|
14105
|
+
*/
|
|
14106
|
+
getNamespaceStatsBatch(requestParameters, options) {
|
|
14107
|
+
return NamespacesApiFp(this.configuration).getNamespaceStatsBatch(requestParameters.namespaceStatsBatchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14108
|
+
}
|
|
13914
14109
|
/**
|
|
13915
14110
|
* List all namespaces for a user
|
|
13916
14111
|
* @summary List Namespaces
|
|
@@ -15321,10 +15516,12 @@ var RetrieversApiAxiosParamCreator = function(configuration) {
|
|
|
15321
15516
|
* @param {ExecuteRetrieverRequest} executeRetrieverRequest
|
|
15322
15517
|
* @param {boolean} [returnPresignedUrls] Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either source is true, presigning is enabled.
|
|
15323
15518
|
* @param {boolean} [returnVectors] Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.
|
|
15519
|
+
* @param {boolean} [explain] Return the inline `explain_plan` (per-stage timings + optimization summary) in the response. Also accepted as a body field — if either source is true, the plan is included.
|
|
15520
|
+
* @param {boolean} [includeLegacyResults] DEPRECATED. Restore the legacy `results` alias (a byte-for-byte copy of `documents`). Off by default — `results` previously duplicated the entire document array in every response (~half the payload). Prefer `documents`; use this only as a temporary migration shim.
|
|
15324
15521
|
* @param {*} [options] Override http request option.
|
|
15325
15522
|
* @throws {RequiredError}
|
|
15326
15523
|
*/
|
|
15327
|
-
executeRetriever: async (retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, options = {}) => {
|
|
15524
|
+
executeRetriever: async (retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, explain, includeLegacyResults, options = {}) => {
|
|
15328
15525
|
assertParamExists("executeRetriever", "retrieverId", retrieverId);
|
|
15329
15526
|
assertParamExists("executeRetriever", "executeRetrieverRequest", executeRetrieverRequest);
|
|
15330
15527
|
const localVarPath = `/v1/retrievers/{retriever_id}/execute`.replace(`{${"retriever_id"}}`, encodeURIComponent(String(retrieverId)));
|
|
@@ -15342,6 +15539,12 @@ var RetrieversApiAxiosParamCreator = function(configuration) {
|
|
|
15342
15539
|
if (returnVectors !== void 0) {
|
|
15343
15540
|
localVarQueryParameter["return_vectors"] = returnVectors;
|
|
15344
15541
|
}
|
|
15542
|
+
if (explain !== void 0) {
|
|
15543
|
+
localVarQueryParameter["explain"] = explain;
|
|
15544
|
+
}
|
|
15545
|
+
if (includeLegacyResults !== void 0) {
|
|
15546
|
+
localVarQueryParameter["include_legacy_results"] = includeLegacyResults;
|
|
15547
|
+
}
|
|
15345
15548
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
15346
15549
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15347
15550
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -15742,11 +15945,13 @@ var RetrieversApiFp = function(configuration) {
|
|
|
15742
15945
|
* @param {ExecuteRetrieverRequest} executeRetrieverRequest
|
|
15743
15946
|
* @param {boolean} [returnPresignedUrls] Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either source is true, presigning is enabled.
|
|
15744
15947
|
* @param {boolean} [returnVectors] Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.
|
|
15948
|
+
* @param {boolean} [explain] Return the inline `explain_plan` (per-stage timings + optimization summary) in the response. Also accepted as a body field — if either source is true, the plan is included.
|
|
15949
|
+
* @param {boolean} [includeLegacyResults] DEPRECATED. Restore the legacy `results` alias (a byte-for-byte copy of `documents`). Off by default — `results` previously duplicated the entire document array in every response (~half the payload). Prefer `documents`; use this only as a temporary migration shim.
|
|
15745
15950
|
* @param {*} [options] Override http request option.
|
|
15746
15951
|
* @throws {RequiredError}
|
|
15747
15952
|
*/
|
|
15748
|
-
async executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, options) {
|
|
15749
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, options);
|
|
15953
|
+
async executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, explain, includeLegacyResults, options) {
|
|
15954
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, explain, includeLegacyResults, options);
|
|
15750
15955
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15751
15956
|
const localVarOperationServerBasePath = operationServerMap["RetrieversApi.executeRetriever"]?.[localVarOperationServerIndex]?.url;
|
|
15752
15957
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -15947,7 +16152,7 @@ var RetrieversApi = class extends BaseAPI {
|
|
|
15947
16152
|
* @memberof RetrieversApi
|
|
15948
16153
|
*/
|
|
15949
16154
|
executeRetriever(requestParameters, options) {
|
|
15950
|
-
return RetrieversApiFp(this.configuration).executeRetriever(requestParameters.retrieverId, requestParameters.executeRetrieverRequest, requestParameters.returnPresignedUrls, requestParameters.returnVectors, options).then((request) => request(this.axios, this.basePath));
|
|
16155
|
+
return RetrieversApiFp(this.configuration).executeRetriever(requestParameters.retrieverId, requestParameters.executeRetrieverRequest, requestParameters.returnPresignedUrls, requestParameters.returnVectors, requestParameters.explain, requestParameters.includeLegacyResults, options).then((request) => request(this.axios, this.basePath));
|
|
15951
16156
|
}
|
|
15952
16157
|
/**
|
|
15953
16158
|
* Get a detailed execution plan for a retriever without actually executing it. Similar to MongoDB\'s explain plan or SQL\'s EXPLAIN command, this endpoint helps you understand performance characteristics, identify bottlenecks, estimate costs, and troubleshoot retrieval issues before running expensive queries. **What This Returns:** - Stage-by-stage execution plan (AFTER automatic optimizations) - Estimated costs (credits + time per stage) - Document flow projections (input/output counts per stage) - Efficiency metrics (selectivity ratios, cache likelihood) - Bottleneck identification (slowest/most expensive stages) - Optimization details (transformations applied by the optimizer) - Performance warnings and improvement suggestions **Key Features:** - **Cost Estimation**: See how many credits and milliseconds each stage will consume - **Bottleneck Detection**: Identify which stages dominate execution time - **Optimization Transparency**: Understand how your pipeline was optimized - **Cache Analysis**: See which stages are likely to hit cache - **Accuracy Troubleshooting**: Analyze stage efficiency and document flow - **Latency Analysis**: Break down estimated duration by stage **Important:** The execution_plan shows OPTIMIZED stages (after automatic transformations like filter push-down, stage fusion, and grouping optimization). Check optimization_details to understand what changed from your original configuration. **Use Cases:** - Debug slow retrievers by identifying bottleneck stages - Estimate costs before running expensive queries - Understand how the optimizer transformed your pipeline - Troubleshoot accuracy issues by analyzing stage selectivity - Compare different retriever configurations - Plan budget allocation for production workloads **Example Response:** ```json { \"retriever_id\": \"ret_abc123\", \"retriever_name\": \"product_search\", \"execution_plan\": [ { \"stage_index\": 0, \"stage_name\": \"attribute_filter\", \"stage_type\": \"filter\", \"estimated_input\": 10000, \"estimated_output\": 5000, \"estimated_efficiency\": 0.5, \"estimated_cost_credits\": 0.01, \"estimated_duration_ms\": 20, \"cache_likely\": true, \"optimization_notes\": [\"Pushed down from stage 2\"], \"warnings\": [] }, { \"stage_index\": 1, \"stage_name\": \"semantic_search\", \"stage_type\": \"filter\", \"estimated_input\": 5000, \"estimated_output\": 100, \"estimated_efficiency\": 0.02, \"estimated_cost_credits\": 0.5, \"estimated_duration_ms\": 200, \"cache_likely\": false, \"optimization_notes\": [], \"warnings\": [\"High cost stage - consider reducing limit\"] } ], \"estimated_cost\": { \"total_credits\": 0.51, \"total_duration_ms\": 220 }, \"bottleneck_stages\": [\"semantic_search\"], \"optimization_applied\": true, \"optimization_details\": { \"original_stage_count\": 3, \"optimized_stage_count\": 2, \"optimization_time_ms\": 8.2, \"stage_reduction_pct\": 33.3, \"decisions\": [ { \"rule_type\": \"push_down_filters\", \"applied\": true, \"reason\": \"Moved attribute_filter before semantic_search to reduce search scope\" } ] }, \"optimization_suggestions\": [ { \"type\": \"reduce_limit\", \"stage\": \"semantic_search\", \"message\": \"Consider reducing limit to improve latency\" } ] } ```
|
|
@@ -16857,7 +17062,7 @@ var WebhooksApiAxiosParamCreator = function(configuration) {
|
|
|
16857
17062
|
*/
|
|
16858
17063
|
createWebhookOrganizations: async (webhookInput, options = {}) => {
|
|
16859
17064
|
assertParamExists("createWebhookOrganizations", "webhookInput", webhookInput);
|
|
16860
|
-
const localVarPath = `/v1/organizations/webhooks
|
|
17065
|
+
const localVarPath = `/v1/organizations/webhooks`;
|
|
16861
17066
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16862
17067
|
let baseOptions;
|
|
16863
17068
|
if (configuration) {
|