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.mjs
CHANGED
|
@@ -92,8 +92,8 @@ var serializeDataIfNeeded = function(value, requestOptions, configuration) {
|
|
|
92
92
|
var toPathString = function(url) {
|
|
93
93
|
return url.pathname + url.search + url.hash;
|
|
94
94
|
};
|
|
95
|
-
var createRequestFunction = function(axiosArgs,
|
|
96
|
-
return (axios2 =
|
|
95
|
+
var createRequestFunction = function(axiosArgs, globalAxios97, BASE_PATH2, configuration) {
|
|
96
|
+
return (axios2 = globalAxios97, basePath = BASE_PATH2) => {
|
|
97
97
|
const axiosRequestArgs = { ...axiosArgs.options, url: (axios2.defaults.baseURL ? "" : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
98
98
|
return axios2.request(axiosRequestArgs);
|
|
99
99
|
};
|
|
@@ -2902,7 +2902,7 @@ var AnalyticsApiAxiosParamCreator = function(configuration) {
|
|
|
2902
2902
|
};
|
|
2903
2903
|
},
|
|
2904
2904
|
/**
|
|
2905
|
-
* Batch error/failure counts for every collection & cluster in the namespace.
|
|
2905
|
+
* 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\" ```
|
|
2906
2906
|
* @summary Get Namespace Errors
|
|
2907
2907
|
* @param {number} [hours] Hours of history to analyze
|
|
2908
2908
|
* @param {*} [options] Override http request option.
|
|
@@ -3731,7 +3731,7 @@ var AnalyticsApiFp = function(configuration) {
|
|
|
3731
3731
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
3732
3732
|
},
|
|
3733
3733
|
/**
|
|
3734
|
-
* Batch error/failure counts for every collection & cluster in the namespace.
|
|
3734
|
+
* 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\" ```
|
|
3735
3735
|
* @summary Get Namespace Errors
|
|
3736
3736
|
* @param {number} [hours] Hours of history to analyze
|
|
3737
3737
|
* @param {*} [options] Override http request option.
|
|
@@ -4229,7 +4229,7 @@ var AnalyticsApi = class extends BaseAPI {
|
|
|
4229
4229
|
return AnalyticsApiFp(this.configuration).getMostQueriedFieldsAnalyticsNamespaces(requestParameters.days, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
|
|
4230
4230
|
}
|
|
4231
4231
|
/**
|
|
4232
|
-
* Batch error/failure counts for every collection & cluster in the namespace.
|
|
4232
|
+
* 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\" ```
|
|
4233
4233
|
* @summary Get Namespace Errors
|
|
4234
4234
|
* @param {AnalyticsApiGetNamespaceErrorsAnalyticsRequest} requestParameters Request parameters.
|
|
4235
4235
|
* @param {*} [options] Override http request option.
|
|
@@ -4424,7 +4424,7 @@ var AppsApiAxiosParamCreator = function(configuration) {
|
|
|
4424
4424
|
};
|
|
4425
4425
|
},
|
|
4426
4426
|
/**
|
|
4427
|
-
* 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.
|
|
4427
|
+
* 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``.
|
|
4428
4428
|
* @summary Create an App
|
|
4429
4429
|
* @param {CreateAppRequest} createAppRequest
|
|
4430
4430
|
* @param {*} [options] Override http request option.
|
|
@@ -4942,7 +4942,7 @@ var AppsApiAxiosParamCreator = function(configuration) {
|
|
|
4942
4942
|
};
|
|
4943
4943
|
},
|
|
4944
4944
|
/**
|
|
4945
|
-
* List all Apps for this organization.
|
|
4945
|
+
* 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.
|
|
4946
4946
|
* @summary List Apps
|
|
4947
4947
|
* @param {number} [limit]
|
|
4948
4948
|
* @param {number} [offset]
|
|
@@ -5388,7 +5388,7 @@ var AppsApiFp = function(configuration) {
|
|
|
5388
5388
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
5389
5389
|
},
|
|
5390
5390
|
/**
|
|
5391
|
-
* 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.
|
|
5391
|
+
* 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``.
|
|
5392
5392
|
* @summary Create an App
|
|
5393
5393
|
* @param {CreateAppRequest} createAppRequest
|
|
5394
5394
|
* @param {*} [options] Override http request option.
|
|
@@ -5637,7 +5637,7 @@ var AppsApiFp = function(configuration) {
|
|
|
5637
5637
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
5638
5638
|
},
|
|
5639
5639
|
/**
|
|
5640
|
-
* List all Apps for this organization.
|
|
5640
|
+
* 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.
|
|
5641
5641
|
* @summary List Apps
|
|
5642
5642
|
* @param {number} [limit]
|
|
5643
5643
|
* @param {number} [offset]
|
|
@@ -5859,7 +5859,7 @@ var AppsApi = class extends BaseAPI {
|
|
|
5859
5859
|
return AppsApiFp(this.configuration).connectRepoApps(requestParameters.appId, requestParameters.connectRepoRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5860
5860
|
}
|
|
5861
5861
|
/**
|
|
5862
|
-
* 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.
|
|
5862
|
+
* 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``.
|
|
5863
5863
|
* @summary Create an App
|
|
5864
5864
|
* @param {AppsApiCreateAppRequest} requestParameters Request parameters.
|
|
5865
5865
|
* @param {*} [options] Override http request option.
|
|
@@ -6057,7 +6057,7 @@ var AppsApi = class extends BaseAPI {
|
|
|
6057
6057
|
return AppsApiFp(this.configuration).listAppUsers(requestParameters.appId, options).then((request) => request(this.axios, this.basePath));
|
|
6058
6058
|
}
|
|
6059
6059
|
/**
|
|
6060
|
-
* List all Apps for this organization.
|
|
6060
|
+
* 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.
|
|
6061
6061
|
* @summary List Apps
|
|
6062
6062
|
* @param {AppsApiListAppsRequest} requestParameters Request parameters.
|
|
6063
6063
|
* @param {*} [options] Override http request option.
|
|
@@ -6698,6 +6698,34 @@ var BucketBatchesApiAxiosParamCreator = function(configuration) {
|
|
|
6698
6698
|
options: localVarRequestOptions
|
|
6699
6699
|
};
|
|
6700
6700
|
},
|
|
6701
|
+
/**
|
|
6702
|
+
* 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.
|
|
6703
|
+
* @summary Estimate Batch Cost (pre-flight, dry-run)
|
|
6704
|
+
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
6705
|
+
* @param {string} batchId The unique identifier of the batch.
|
|
6706
|
+
* @param {*} [options] Override http request option.
|
|
6707
|
+
* @throws {RequiredError}
|
|
6708
|
+
*/
|
|
6709
|
+
estimateBatchCostBucketsBatches: async (bucketIdentifier, batchId, options = {}) => {
|
|
6710
|
+
assertParamExists("estimateBatchCostBucketsBatches", "bucketIdentifier", bucketIdentifier);
|
|
6711
|
+
assertParamExists("estimateBatchCostBucketsBatches", "batchId", batchId);
|
|
6712
|
+
const localVarPath = `/v1/buckets/{bucket_identifier}/batches/{batch_id}/estimate-cost`.replace(`{${"bucket_identifier"}}`, encodeURIComponent(String(bucketIdentifier))).replace(`{${"batch_id"}}`, encodeURIComponent(String(batchId)));
|
|
6713
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6714
|
+
let baseOptions;
|
|
6715
|
+
if (configuration) {
|
|
6716
|
+
baseOptions = configuration.baseOptions;
|
|
6717
|
+
}
|
|
6718
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
6719
|
+
const localVarHeaderParameter = {};
|
|
6720
|
+
const localVarQueryParameter = {};
|
|
6721
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6722
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6723
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
6724
|
+
return {
|
|
6725
|
+
url: toPathString(localVarUrlObj),
|
|
6726
|
+
options: localVarRequestOptions
|
|
6727
|
+
};
|
|
6728
|
+
},
|
|
6701
6729
|
/**
|
|
6702
6730
|
* 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.
|
|
6703
6731
|
* @summary Tier-completion invariant audit
|
|
@@ -7251,6 +7279,20 @@ var BucketBatchesApiFp = function(configuration) {
|
|
|
7251
7279
|
const localVarOperationServerBasePath = operationServerMap["BucketBatchesApi.diagnoseBatchBucketsBatches"]?.[localVarOperationServerIndex]?.url;
|
|
7252
7280
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
7253
7281
|
},
|
|
7282
|
+
/**
|
|
7283
|
+
* 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.
|
|
7284
|
+
* @summary Estimate Batch Cost (pre-flight, dry-run)
|
|
7285
|
+
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
7286
|
+
* @param {string} batchId The unique identifier of the batch.
|
|
7287
|
+
* @param {*} [options] Override http request option.
|
|
7288
|
+
* @throws {RequiredError}
|
|
7289
|
+
*/
|
|
7290
|
+
async estimateBatchCostBucketsBatches(bucketIdentifier, batchId, options) {
|
|
7291
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.estimateBatchCostBucketsBatches(bucketIdentifier, batchId, options);
|
|
7292
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
7293
|
+
const localVarOperationServerBasePath = operationServerMap["BucketBatchesApi.estimateBatchCostBucketsBatches"]?.[localVarOperationServerIndex]?.url;
|
|
7294
|
+
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
7295
|
+
},
|
|
7254
7296
|
/**
|
|
7255
7297
|
* 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.
|
|
7256
7298
|
* @summary Tier-completion invariant audit
|
|
@@ -7549,6 +7591,17 @@ var BucketBatchesApi = class extends BaseAPI {
|
|
|
7549
7591
|
diagnoseBatchBucketsBatches(requestParameters, options) {
|
|
7550
7592
|
return BucketBatchesApiFp(this.configuration).diagnoseBatchBucketsBatches(requestParameters.bucketIdentifier, requestParameters.batchId, options).then((request) => request(this.axios, this.basePath));
|
|
7551
7593
|
}
|
|
7594
|
+
/**
|
|
7595
|
+
* 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.
|
|
7596
|
+
* @summary Estimate Batch Cost (pre-flight, dry-run)
|
|
7597
|
+
* @param {BucketBatchesApiEstimateBatchCostBucketsBatchesRequest} requestParameters Request parameters.
|
|
7598
|
+
* @param {*} [options] Override http request option.
|
|
7599
|
+
* @throws {RequiredError}
|
|
7600
|
+
* @memberof BucketBatchesApi
|
|
7601
|
+
*/
|
|
7602
|
+
estimateBatchCostBucketsBatches(requestParameters, options) {
|
|
7603
|
+
return BucketBatchesApiFp(this.configuration).estimateBatchCostBucketsBatches(requestParameters.bucketIdentifier, requestParameters.batchId, options).then((request) => request(this.axios, this.basePath));
|
|
7604
|
+
}
|
|
7552
7605
|
/**
|
|
7553
7606
|
* 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.
|
|
7554
7607
|
* @summary Tier-completion invariant audit
|
|
@@ -7856,15 +7909,16 @@ var BucketObjectsApiAxiosParamCreator = function(configuration) {
|
|
|
7856
7909
|
};
|
|
7857
7910
|
},
|
|
7858
7911
|
/**
|
|
7859
|
-
* 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.
|
|
7912
|
+
* 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.
|
|
7860
7913
|
* @summary Get Object
|
|
7861
7914
|
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
7862
7915
|
* @param {string} objectIdentifier The unique identifier of the object.
|
|
7863
7916
|
* @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
|
|
7917
|
+
* @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.
|
|
7864
7918
|
* @param {*} [options] Override http request option.
|
|
7865
7919
|
* @throws {RequiredError}
|
|
7866
7920
|
*/
|
|
7867
|
-
getObjectBuckets: async (bucketIdentifier, objectIdentifier, returnPresignedUrls, options = {}) => {
|
|
7921
|
+
getObjectBuckets: async (bucketIdentifier, objectIdentifier, returnPresignedUrls, includeDocumentCount, options = {}) => {
|
|
7868
7922
|
assertParamExists("getObjectBuckets", "bucketIdentifier", bucketIdentifier);
|
|
7869
7923
|
assertParamExists("getObjectBuckets", "objectIdentifier", objectIdentifier);
|
|
7870
7924
|
const localVarPath = `/v1/buckets/{bucket_identifier}/objects/{object_identifier}`.replace(`{${"bucket_identifier"}}`, encodeURIComponent(String(bucketIdentifier))).replace(`{${"object_identifier"}}`, encodeURIComponent(String(objectIdentifier)));
|
|
@@ -7879,6 +7933,9 @@ var BucketObjectsApiAxiosParamCreator = function(configuration) {
|
|
|
7879
7933
|
if (returnPresignedUrls !== void 0) {
|
|
7880
7934
|
localVarQueryParameter["return_presigned_urls"] = returnPresignedUrls;
|
|
7881
7935
|
}
|
|
7936
|
+
if (includeDocumentCount !== void 0) {
|
|
7937
|
+
localVarQueryParameter["include_document_count"] = includeDocumentCount;
|
|
7938
|
+
}
|
|
7882
7939
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7883
7940
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7884
7941
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -8133,16 +8190,17 @@ var BucketObjectsApiFp = function(configuration) {
|
|
|
8133
8190
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
8134
8191
|
},
|
|
8135
8192
|
/**
|
|
8136
|
-
* 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.
|
|
8193
|
+
* 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.
|
|
8137
8194
|
* @summary Get Object
|
|
8138
8195
|
* @param {string} bucketIdentifier The unique identifier of the bucket.
|
|
8139
8196
|
* @param {string} objectIdentifier The unique identifier of the object.
|
|
8140
8197
|
* @param {boolean} [returnPresignedUrls] Generate fresh presigned download URLs for all blobs with S3 storage
|
|
8198
|
+
* @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.
|
|
8141
8199
|
* @param {*} [options] Override http request option.
|
|
8142
8200
|
* @throws {RequiredError}
|
|
8143
8201
|
*/
|
|
8144
|
-
async getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, options) {
|
|
8145
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, options);
|
|
8202
|
+
async getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, includeDocumentCount, options) {
|
|
8203
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getObjectBuckets(bucketIdentifier, objectIdentifier, returnPresignedUrls, includeDocumentCount, options);
|
|
8146
8204
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
8147
8205
|
const localVarOperationServerBasePath = operationServerMap["BucketObjectsApi.getObjectBuckets"]?.[localVarOperationServerIndex]?.url;
|
|
8148
8206
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -8275,7 +8333,7 @@ var BucketObjectsApi = class extends BaseAPI {
|
|
|
8275
8333
|
return BucketObjectsApiFp(this.configuration).deleteObjectBuckets(requestParameters.bucketIdentifier, requestParameters.objectIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
8276
8334
|
}
|
|
8277
8335
|
/**
|
|
8278
|
-
* 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.
|
|
8336
|
+
* 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.
|
|
8279
8337
|
* @summary Get Object
|
|
8280
8338
|
* @param {BucketObjectsApiGetObjectBucketsRequest} requestParameters Request parameters.
|
|
8281
8339
|
* @param {*} [options] Override http request option.
|
|
@@ -8283,7 +8341,7 @@ var BucketObjectsApi = class extends BaseAPI {
|
|
|
8283
8341
|
* @memberof BucketObjectsApi
|
|
8284
8342
|
*/
|
|
8285
8343
|
getObjectBuckets(requestParameters, options) {
|
|
8286
|
-
return BucketObjectsApiFp(this.configuration).getObjectBuckets(requestParameters.bucketIdentifier, requestParameters.objectIdentifier, requestParameters.returnPresignedUrls, options).then((request) => request(this.axios, this.basePath));
|
|
8344
|
+
return BucketObjectsApiFp(this.configuration).getObjectBuckets(requestParameters.bucketIdentifier, requestParameters.objectIdentifier, requestParameters.returnPresignedUrls, requestParameters.includeDocumentCount, options).then((request) => request(this.axios, this.basePath));
|
|
8287
8345
|
}
|
|
8288
8346
|
/**
|
|
8289
8347
|
* 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
|
|
@@ -9644,10 +9702,11 @@ var BucketsApiAxiosParamCreator = function(configuration) {
|
|
|
9644
9702
|
* 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).
|
|
9645
9703
|
* @summary Delete Bucket
|
|
9646
9704
|
* @param {string} bucketIdentifier
|
|
9705
|
+
* @param {boolean} [forceForeclose]
|
|
9647
9706
|
* @param {*} [options] Override http request option.
|
|
9648
9707
|
* @throws {RequiredError}
|
|
9649
9708
|
*/
|
|
9650
|
-
deleteBucket: async (bucketIdentifier, options = {}) => {
|
|
9709
|
+
deleteBucket: async (bucketIdentifier, forceForeclose, options = {}) => {
|
|
9651
9710
|
assertParamExists("deleteBucket", "bucketIdentifier", bucketIdentifier);
|
|
9652
9711
|
const localVarPath = `/v1/buckets/{bucket_identifier}`.replace(`{${"bucket_identifier"}}`, encodeURIComponent(String(bucketIdentifier)));
|
|
9653
9712
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -9658,6 +9717,9 @@ var BucketsApiAxiosParamCreator = function(configuration) {
|
|
|
9658
9717
|
const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
|
|
9659
9718
|
const localVarHeaderParameter = {};
|
|
9660
9719
|
const localVarQueryParameter = {};
|
|
9720
|
+
if (forceForeclose !== void 0) {
|
|
9721
|
+
localVarQueryParameter["force_foreclose"] = forceForeclose;
|
|
9722
|
+
}
|
|
9661
9723
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
9662
9724
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
9663
9725
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -9853,11 +9915,12 @@ var BucketsApiFp = function(configuration) {
|
|
|
9853
9915
|
* 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).
|
|
9854
9916
|
* @summary Delete Bucket
|
|
9855
9917
|
* @param {string} bucketIdentifier
|
|
9918
|
+
* @param {boolean} [forceForeclose]
|
|
9856
9919
|
* @param {*} [options] Override http request option.
|
|
9857
9920
|
* @throws {RequiredError}
|
|
9858
9921
|
*/
|
|
9859
|
-
async deleteBucket(bucketIdentifier, options) {
|
|
9860
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBucket(bucketIdentifier, options);
|
|
9922
|
+
async deleteBucket(bucketIdentifier, forceForeclose, options) {
|
|
9923
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBucket(bucketIdentifier, forceForeclose, options);
|
|
9861
9924
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
9862
9925
|
const localVarOperationServerBasePath = operationServerMap["BucketsApi.deleteBucket"]?.[localVarOperationServerIndex]?.url;
|
|
9863
9926
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -9958,7 +10021,7 @@ var BucketsApi = class extends BaseAPI {
|
|
|
9958
10021
|
* @memberof BucketsApi
|
|
9959
10022
|
*/
|
|
9960
10023
|
deleteBucket(requestParameters, options) {
|
|
9961
|
-
return BucketsApiFp(this.configuration).deleteBucket(requestParameters.bucketIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
10024
|
+
return BucketsApiFp(this.configuration).deleteBucket(requestParameters.bucketIdentifier, requestParameters.forceForeclose, options).then((request) => request(this.axios, this.basePath));
|
|
9962
10025
|
}
|
|
9963
10026
|
/**
|
|
9964
10027
|
* This endpoint retrieves a bucket by its ID.
|
|
@@ -10996,6 +11059,32 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
10996
11059
|
options: localVarRequestOptions
|
|
10997
11060
|
};
|
|
10998
11061
|
},
|
|
11062
|
+
/**
|
|
11063
|
+
* 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).
|
|
11064
|
+
* @summary Count documents in a collection.
|
|
11065
|
+
* @param {string} collectionIdentifier The ID of the collection to count documents in.
|
|
11066
|
+
* @param {*} [options] Override http request option.
|
|
11067
|
+
* @throws {RequiredError}
|
|
11068
|
+
*/
|
|
11069
|
+
countDocuments: async (collectionIdentifier, options = {}) => {
|
|
11070
|
+
assertParamExists("countDocuments", "collectionIdentifier", collectionIdentifier);
|
|
11071
|
+
const localVarPath = `/v1/collections/{collection_identifier}/documents/count`.replace(`{${"collection_identifier"}}`, encodeURIComponent(String(collectionIdentifier)));
|
|
11072
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
11073
|
+
let baseOptions;
|
|
11074
|
+
if (configuration) {
|
|
11075
|
+
baseOptions = configuration.baseOptions;
|
|
11076
|
+
}
|
|
11077
|
+
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
11078
|
+
const localVarHeaderParameter = {};
|
|
11079
|
+
const localVarQueryParameter = {};
|
|
11080
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
11081
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11082
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
11083
|
+
return {
|
|
11084
|
+
url: toPathString(localVarUrlObj),
|
|
11085
|
+
options: localVarRequestOptions
|
|
11086
|
+
};
|
|
11087
|
+
},
|
|
10999
11088
|
/**
|
|
11000
11089
|
* Create a document by ID.
|
|
11001
11090
|
* @summary Create a document.
|
|
@@ -11190,6 +11279,9 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11190
11279
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11191
11280
|
* @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.
|
|
11192
11281
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11282
|
+
* @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).
|
|
11283
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11284
|
+
* @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.
|
|
11193
11285
|
* @param {number} [limit]
|
|
11194
11286
|
* @param {number} [pageSize]
|
|
11195
11287
|
* @param {number} [offset]
|
|
@@ -11200,7 +11292,7 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11200
11292
|
* @param {*} [options] Override http request option.
|
|
11201
11293
|
* @throws {RequiredError}
|
|
11202
11294
|
*/
|
|
11203
|
-
listDocuments: async (collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11295
|
+
listDocuments: async (collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11204
11296
|
assertParamExists("listDocuments", "collectionIdentifier", collectionIdentifier);
|
|
11205
11297
|
const localVarPath = `/v1/collections/{collection_identifier}/documents/list`.replace(`{${"collection_identifier"}}`, encodeURIComponent(String(collectionIdentifier)));
|
|
11206
11298
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11217,6 +11309,15 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11217
11309
|
if (returnVectors !== void 0) {
|
|
11218
11310
|
localVarQueryParameter["return_vectors"] = returnVectors;
|
|
11219
11311
|
}
|
|
11312
|
+
if (filters !== void 0) {
|
|
11313
|
+
localVarQueryParameter["filters"] = filters;
|
|
11314
|
+
}
|
|
11315
|
+
if (search !== void 0) {
|
|
11316
|
+
localVarQueryParameter["search"] = search;
|
|
11317
|
+
}
|
|
11318
|
+
if (sort !== void 0) {
|
|
11319
|
+
localVarQueryParameter["sort"] = sort;
|
|
11320
|
+
}
|
|
11220
11321
|
if (limit !== void 0) {
|
|
11221
11322
|
localVarQueryParameter["limit"] = limit;
|
|
11222
11323
|
}
|
|
@@ -11251,6 +11352,9 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11251
11352
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11252
11353
|
* @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.
|
|
11253
11354
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11355
|
+
* @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).
|
|
11356
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11357
|
+
* @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.
|
|
11254
11358
|
* @param {number} [limit]
|
|
11255
11359
|
* @param {number} [pageSize]
|
|
11256
11360
|
* @param {number} [offset]
|
|
@@ -11261,7 +11365,7 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11261
11365
|
* @param {*} [options] Override http request option.
|
|
11262
11366
|
* @throws {RequiredError}
|
|
11263
11367
|
*/
|
|
11264
|
-
listDocuments_1: async (collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11368
|
+
listDocuments_1: async (collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options = {}) => {
|
|
11265
11369
|
assertParamExists("listDocuments_1", "collectionIdentifier", collectionIdentifier);
|
|
11266
11370
|
const localVarPath = `/v1/collections/{collection_identifier}/documents`.replace(`{${"collection_identifier"}}`, encodeURIComponent(String(collectionIdentifier)));
|
|
11267
11371
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -11278,6 +11382,15 @@ var CollectionDocumentsApiAxiosParamCreator = function(configuration) {
|
|
|
11278
11382
|
if (returnVectors !== void 0) {
|
|
11279
11383
|
localVarQueryParameter["return_vectors"] = returnVectors;
|
|
11280
11384
|
}
|
|
11385
|
+
if (filters !== void 0) {
|
|
11386
|
+
localVarQueryParameter["filters"] = filters;
|
|
11387
|
+
}
|
|
11388
|
+
if (search !== void 0) {
|
|
11389
|
+
localVarQueryParameter["search"] = search;
|
|
11390
|
+
}
|
|
11391
|
+
if (sort !== void 0) {
|
|
11392
|
+
localVarQueryParameter["sort"] = sort;
|
|
11393
|
+
}
|
|
11281
11394
|
if (limit !== void 0) {
|
|
11282
11395
|
localVarQueryParameter["limit"] = limit;
|
|
11283
11396
|
}
|
|
@@ -11493,6 +11606,19 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11493
11606
|
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.bulkUpdate"]?.[localVarOperationServerIndex]?.url;
|
|
11494
11607
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
11495
11608
|
},
|
|
11609
|
+
/**
|
|
11610
|
+
* 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).
|
|
11611
|
+
* @summary Count documents in a collection.
|
|
11612
|
+
* @param {string} collectionIdentifier The ID of the collection to count documents in.
|
|
11613
|
+
* @param {*} [options] Override http request option.
|
|
11614
|
+
* @throws {RequiredError}
|
|
11615
|
+
*/
|
|
11616
|
+
async countDocuments(collectionIdentifier, options) {
|
|
11617
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.countDocuments(collectionIdentifier, options);
|
|
11618
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11619
|
+
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.countDocuments"]?.[localVarOperationServerIndex]?.url;
|
|
11620
|
+
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
11621
|
+
},
|
|
11496
11622
|
/**
|
|
11497
11623
|
* Create a document by ID.
|
|
11498
11624
|
* @summary Create a document.
|
|
@@ -11587,6 +11713,9 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11587
11713
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11588
11714
|
* @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.
|
|
11589
11715
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11716
|
+
* @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).
|
|
11717
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11718
|
+
* @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.
|
|
11590
11719
|
* @param {number} [limit]
|
|
11591
11720
|
* @param {number} [pageSize]
|
|
11592
11721
|
* @param {number} [offset]
|
|
@@ -11597,8 +11726,8 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11597
11726
|
* @param {*} [options] Override http request option.
|
|
11598
11727
|
* @throws {RequiredError}
|
|
11599
11728
|
*/
|
|
11600
|
-
async listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11601
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11729
|
+
async listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11730
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11602
11731
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11603
11732
|
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.listDocuments"]?.[localVarOperationServerIndex]?.url;
|
|
11604
11733
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -11609,6 +11738,9 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11609
11738
|
* @param {string} collectionIdentifier The ID of the collection to list documents from.
|
|
11610
11739
|
* @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.
|
|
11611
11740
|
* @param {boolean} [returnVectors] Include vector embeddings in results. Also accepted as a body field — if either is true, vectors are returned.
|
|
11741
|
+
* @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).
|
|
11742
|
+
* @param {string} [search] Free-text search across common document fields. Body `search` wins when both are set.
|
|
11743
|
+
* @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.
|
|
11612
11744
|
* @param {number} [limit]
|
|
11613
11745
|
* @param {number} [pageSize]
|
|
11614
11746
|
* @param {number} [offset]
|
|
@@ -11619,8 +11751,8 @@ var CollectionDocumentsApiFp = function(configuration) {
|
|
|
11619
11751
|
* @param {*} [options] Override http request option.
|
|
11620
11752
|
* @throws {RequiredError}
|
|
11621
11753
|
*/
|
|
11622
|
-
async listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11623
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11754
|
+
async listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options) {
|
|
11755
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments_1(collectionIdentifier, returnPresignedUrls, returnVectors, filters, search, sort, limit, pageSize, offset, page, cursor, includeTotal, listDocumentsRequest, options);
|
|
11624
11756
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
11625
11757
|
const localVarOperationServerBasePath = operationServerMap["CollectionDocumentsApi.listDocuments_1"]?.[localVarOperationServerIndex]?.url;
|
|
11626
11758
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -11731,6 +11863,17 @@ var CollectionDocumentsApi = class extends BaseAPI {
|
|
|
11731
11863
|
bulkUpdate(requestParameters, options) {
|
|
11732
11864
|
return CollectionDocumentsApiFp(this.configuration).bulkUpdate(requestParameters.collectionIdentifier, requestParameters.bulkUpdateDocumentsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
11733
11865
|
}
|
|
11866
|
+
/**
|
|
11867
|
+
* 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).
|
|
11868
|
+
* @summary Count documents in a collection.
|
|
11869
|
+
* @param {CollectionDocumentsApiCountDocumentsRequest} requestParameters Request parameters.
|
|
11870
|
+
* @param {*} [options] Override http request option.
|
|
11871
|
+
* @throws {RequiredError}
|
|
11872
|
+
* @memberof CollectionDocumentsApi
|
|
11873
|
+
*/
|
|
11874
|
+
countDocuments(requestParameters, options) {
|
|
11875
|
+
return CollectionDocumentsApiFp(this.configuration).countDocuments(requestParameters.collectionIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
11876
|
+
}
|
|
11734
11877
|
/**
|
|
11735
11878
|
* Create a document by ID.
|
|
11736
11879
|
* @summary Create a document.
|
|
@@ -11806,7 +11949,7 @@ var CollectionDocumentsApi = class extends BaseAPI {
|
|
|
11806
11949
|
* @memberof CollectionDocumentsApi
|
|
11807
11950
|
*/
|
|
11808
11951
|
listDocuments(requestParameters, options) {
|
|
11809
|
-
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));
|
|
11952
|
+
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));
|
|
11810
11953
|
}
|
|
11811
11954
|
/**
|
|
11812
11955
|
* 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
|
|
@@ -11817,7 +11960,7 @@ var CollectionDocumentsApi = class extends BaseAPI {
|
|
|
11817
11960
|
* @memberof CollectionDocumentsApi
|
|
11818
11961
|
*/
|
|
11819
11962
|
listDocuments_1(requestParameters, options) {
|
|
11820
|
-
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));
|
|
11963
|
+
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));
|
|
11821
11964
|
}
|
|
11822
11965
|
/**
|
|
11823
11966
|
* Partially update a document by ID (PATCH operation).
|
|
@@ -13541,6 +13684,34 @@ var NamespacesApiAxiosParamCreator = function(configuration) {
|
|
|
13541
13684
|
options: localVarRequestOptions
|
|
13542
13685
|
};
|
|
13543
13686
|
},
|
|
13687
|
+
/**
|
|
13688
|
+
* 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.
|
|
13689
|
+
* @summary Get Namespace Stats (Batch)
|
|
13690
|
+
* @param {NamespaceStatsBatchRequest} namespaceStatsBatchRequest
|
|
13691
|
+
* @param {*} [options] Override http request option.
|
|
13692
|
+
* @throws {RequiredError}
|
|
13693
|
+
*/
|
|
13694
|
+
getNamespaceStatsBatch: async (namespaceStatsBatchRequest, options = {}) => {
|
|
13695
|
+
assertParamExists("getNamespaceStatsBatch", "namespaceStatsBatchRequest", namespaceStatsBatchRequest);
|
|
13696
|
+
const localVarPath = `/v1/namespaces/stats/batch`;
|
|
13697
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
13698
|
+
let baseOptions;
|
|
13699
|
+
if (configuration) {
|
|
13700
|
+
baseOptions = configuration.baseOptions;
|
|
13701
|
+
}
|
|
13702
|
+
const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
|
|
13703
|
+
const localVarHeaderParameter = {};
|
|
13704
|
+
const localVarQueryParameter = {};
|
|
13705
|
+
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
13706
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
13707
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
13708
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
13709
|
+
localVarRequestOptions.data = serializeDataIfNeeded(namespaceStatsBatchRequest, localVarRequestOptions, configuration);
|
|
13710
|
+
return {
|
|
13711
|
+
url: toPathString(localVarUrlObj),
|
|
13712
|
+
options: localVarRequestOptions
|
|
13713
|
+
};
|
|
13714
|
+
},
|
|
13544
13715
|
/**
|
|
13545
13716
|
* List all namespaces for a user
|
|
13546
13717
|
* @summary List Namespaces
|
|
@@ -13780,6 +13951,19 @@ var NamespacesApiFp = function(configuration) {
|
|
|
13780
13951
|
const localVarOperationServerBasePath = operationServerMap["NamespacesApi.getNamespaceStats"]?.[localVarOperationServerIndex]?.url;
|
|
13781
13952
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
13782
13953
|
},
|
|
13954
|
+
/**
|
|
13955
|
+
* 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.
|
|
13956
|
+
* @summary Get Namespace Stats (Batch)
|
|
13957
|
+
* @param {NamespaceStatsBatchRequest} namespaceStatsBatchRequest
|
|
13958
|
+
* @param {*} [options] Override http request option.
|
|
13959
|
+
* @throws {RequiredError}
|
|
13960
|
+
*/
|
|
13961
|
+
async getNamespaceStatsBatch(namespaceStatsBatchRequest, options) {
|
|
13962
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getNamespaceStatsBatch(namespaceStatsBatchRequest, options);
|
|
13963
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
13964
|
+
const localVarOperationServerBasePath = operationServerMap["NamespacesApi.getNamespaceStatsBatch"]?.[localVarOperationServerIndex]?.url;
|
|
13965
|
+
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
13966
|
+
},
|
|
13783
13967
|
/**
|
|
13784
13968
|
* List all namespaces for a user
|
|
13785
13969
|
* @summary List Namespaces
|
|
@@ -13905,6 +14089,17 @@ var NamespacesApi = class extends BaseAPI {
|
|
|
13905
14089
|
getNamespaceStats(requestParameters, options) {
|
|
13906
14090
|
return NamespacesApiFp(this.configuration).getNamespaceStats(requestParameters.namespaceIdentifier, options).then((request) => request(this.axios, this.basePath));
|
|
13907
14091
|
}
|
|
14092
|
+
/**
|
|
14093
|
+
* 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.
|
|
14094
|
+
* @summary Get Namespace Stats (Batch)
|
|
14095
|
+
* @param {NamespacesApiGetNamespaceStatsBatchRequest} requestParameters Request parameters.
|
|
14096
|
+
* @param {*} [options] Override http request option.
|
|
14097
|
+
* @throws {RequiredError}
|
|
14098
|
+
* @memberof NamespacesApi
|
|
14099
|
+
*/
|
|
14100
|
+
getNamespaceStatsBatch(requestParameters, options) {
|
|
14101
|
+
return NamespacesApiFp(this.configuration).getNamespaceStatsBatch(requestParameters.namespaceStatsBatchRequest, options).then((request) => request(this.axios, this.basePath));
|
|
14102
|
+
}
|
|
13908
14103
|
/**
|
|
13909
14104
|
* List all namespaces for a user
|
|
13910
14105
|
* @summary List Namespaces
|
|
@@ -15315,10 +15510,12 @@ var RetrieversApiAxiosParamCreator = function(configuration) {
|
|
|
15315
15510
|
* @param {ExecuteRetrieverRequest} executeRetrieverRequest
|
|
15316
15511
|
* @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.
|
|
15317
15512
|
* @param {boolean} [returnVectors] Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.
|
|
15513
|
+
* @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.
|
|
15514
|
+
* @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.
|
|
15318
15515
|
* @param {*} [options] Override http request option.
|
|
15319
15516
|
* @throws {RequiredError}
|
|
15320
15517
|
*/
|
|
15321
|
-
executeRetriever: async (retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, options = {}) => {
|
|
15518
|
+
executeRetriever: async (retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, explain, includeLegacyResults, options = {}) => {
|
|
15322
15519
|
assertParamExists("executeRetriever", "retrieverId", retrieverId);
|
|
15323
15520
|
assertParamExists("executeRetriever", "executeRetrieverRequest", executeRetrieverRequest);
|
|
15324
15521
|
const localVarPath = `/v1/retrievers/{retriever_id}/execute`.replace(`{${"retriever_id"}}`, encodeURIComponent(String(retrieverId)));
|
|
@@ -15336,6 +15533,12 @@ var RetrieversApiAxiosParamCreator = function(configuration) {
|
|
|
15336
15533
|
if (returnVectors !== void 0) {
|
|
15337
15534
|
localVarQueryParameter["return_vectors"] = returnVectors;
|
|
15338
15535
|
}
|
|
15536
|
+
if (explain !== void 0) {
|
|
15537
|
+
localVarQueryParameter["explain"] = explain;
|
|
15538
|
+
}
|
|
15539
|
+
if (includeLegacyResults !== void 0) {
|
|
15540
|
+
localVarQueryParameter["include_legacy_results"] = includeLegacyResults;
|
|
15541
|
+
}
|
|
15339
15542
|
localVarHeaderParameter["Content-Type"] = "application/json";
|
|
15340
15543
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15341
15544
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -15736,11 +15939,13 @@ var RetrieversApiFp = function(configuration) {
|
|
|
15736
15939
|
* @param {ExecuteRetrieverRequest} executeRetrieverRequest
|
|
15737
15940
|
* @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.
|
|
15738
15941
|
* @param {boolean} [returnVectors] Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.
|
|
15942
|
+
* @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.
|
|
15943
|
+
* @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.
|
|
15739
15944
|
* @param {*} [options] Override http request option.
|
|
15740
15945
|
* @throws {RequiredError}
|
|
15741
15946
|
*/
|
|
15742
|
-
async executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, options) {
|
|
15743
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, options);
|
|
15947
|
+
async executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, explain, includeLegacyResults, options) {
|
|
15948
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.executeRetriever(retrieverId, executeRetrieverRequest, returnPresignedUrls, returnVectors, explain, includeLegacyResults, options);
|
|
15744
15949
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15745
15950
|
const localVarOperationServerBasePath = operationServerMap["RetrieversApi.executeRetriever"]?.[localVarOperationServerIndex]?.url;
|
|
15746
15951
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -15941,7 +16146,7 @@ var RetrieversApi = class extends BaseAPI {
|
|
|
15941
16146
|
* @memberof RetrieversApi
|
|
15942
16147
|
*/
|
|
15943
16148
|
executeRetriever(requestParameters, options) {
|
|
15944
|
-
return RetrieversApiFp(this.configuration).executeRetriever(requestParameters.retrieverId, requestParameters.executeRetrieverRequest, requestParameters.returnPresignedUrls, requestParameters.returnVectors, options).then((request) => request(this.axios, this.basePath));
|
|
16149
|
+
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));
|
|
15945
16150
|
}
|
|
15946
16151
|
/**
|
|
15947
16152
|
* 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\" } ] } ```
|
|
@@ -16851,7 +17056,7 @@ var WebhooksApiAxiosParamCreator = function(configuration) {
|
|
|
16851
17056
|
*/
|
|
16852
17057
|
createWebhookOrganizations: async (webhookInput, options = {}) => {
|
|
16853
17058
|
assertParamExists("createWebhookOrganizations", "webhookInput", webhookInput);
|
|
16854
|
-
const localVarPath = `/v1/organizations/webhooks
|
|
17059
|
+
const localVarPath = `/v1/organizations/webhooks`;
|
|
16855
17060
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16856
17061
|
let baseOptions;
|
|
16857
17062
|
if (configuration) {
|