mixpeek 0.81.41 → 0.81.43
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/cluster-executions-api.d.ts +20 -4
- package/dist/api/cluster-executions-api.d.ts.map +1 -1
- package/dist/index.js +18 -8
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +18 -8
- package/dist/index.mjs.map +1 -1
- package/dist/models/cluster-execution-centroid.d.ts +6 -0
- package/dist/models/cluster-execution-centroid.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -33,19 +33,21 @@ export declare const ClusterExecutionsApiAxiosParamCreator: (configuration?: Con
|
|
|
33
33
|
* Get the most recent execution results for a cluster. Returns execution metadata including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Centroid information with labels and summaries - Execution timestamps Useful for: - Displaying cluster statistics in dashboards - Showing cluster quality metrics to users - Rendering cluster labels and summaries in the UI - Tracking execution status and errors
|
|
34
34
|
* @summary Get Latest Cluster Execution
|
|
35
35
|
* @param {string} clusterId Cluster ID
|
|
36
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in: vectors are large (~120KB for 15x1024-dim centroids), so they are omitted from the response entirely unless this is true. Lets clients run vector-input searches with a centroid as the query even when the centroid document is no longer in the vector store.
|
|
36
37
|
* @param {*} [options] Override http request option.
|
|
37
38
|
* @throws {RequiredError}
|
|
38
39
|
*/
|
|
39
|
-
getClusterExecution: (clusterId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
getClusterExecution: (clusterId: string, includeVectors?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
41
|
/**
|
|
41
42
|
* Get a specific execution by run ID. Returns detailed execution information for a particular clustering run, allowing you to review historical executions and compare results over time.
|
|
42
43
|
* @summary Get Specific Cluster Execution
|
|
43
44
|
* @param {string} clusterId Cluster ID
|
|
44
45
|
* @param {string} runId Run ID
|
|
46
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in; see GET /{cluster_id}/executions for details.
|
|
45
47
|
* @param {*} [options] Override http request option.
|
|
46
48
|
* @throws {RequiredError}
|
|
47
49
|
*/
|
|
48
|
-
getClusterExecutionByRun: (clusterId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
getClusterExecutionByRun: (clusterId: string, runId: string, includeVectors?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
51
|
/**
|
|
50
52
|
* List execution history for a cluster with pagination, filtering, sorting, and search. Returns all historical executions for the specified cluster, including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Execution timestamps and duration - Centroid information Supports: - **Filtering**: Filter by status, date range, metrics, etc. - **Sorting**: Sort by created_at, execution time, metrics - **Search**: Full-text search across execution metadata - **Pagination**: Limit and offset for large result sets Use cases: - View all past executions for a cluster - Compare metrics across runs - Track execution history over time - Debug failed executions - Analyze clustering performance trends
|
|
51
53
|
* @summary List Cluster Execution History
|
|
@@ -80,19 +82,21 @@ export declare const ClusterExecutionsApiFp: (configuration?: Configuration) =>
|
|
|
80
82
|
* Get the most recent execution results for a cluster. Returns execution metadata including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Centroid information with labels and summaries - Execution timestamps Useful for: - Displaying cluster statistics in dashboards - Showing cluster quality metrics to users - Rendering cluster labels and summaries in the UI - Tracking execution status and errors
|
|
81
83
|
* @summary Get Latest Cluster Execution
|
|
82
84
|
* @param {string} clusterId Cluster ID
|
|
85
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in: vectors are large (~120KB for 15x1024-dim centroids), so they are omitted from the response entirely unless this is true. Lets clients run vector-input searches with a centroid as the query even when the centroid document is no longer in the vector store.
|
|
83
86
|
* @param {*} [options] Override http request option.
|
|
84
87
|
* @throws {RequiredError}
|
|
85
88
|
*/
|
|
86
|
-
getClusterExecution(clusterId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionResult>>;
|
|
89
|
+
getClusterExecution(clusterId: string, includeVectors?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionResult>>;
|
|
87
90
|
/**
|
|
88
91
|
* Get a specific execution by run ID. Returns detailed execution information for a particular clustering run, allowing you to review historical executions and compare results over time.
|
|
89
92
|
* @summary Get Specific Cluster Execution
|
|
90
93
|
* @param {string} clusterId Cluster ID
|
|
91
94
|
* @param {string} runId Run ID
|
|
95
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in; see GET /{cluster_id}/executions for details.
|
|
92
96
|
* @param {*} [options] Override http request option.
|
|
93
97
|
* @throws {RequiredError}
|
|
94
98
|
*/
|
|
95
|
-
getClusterExecutionByRun(clusterId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionResult>>;
|
|
99
|
+
getClusterExecutionByRun(clusterId: string, runId: string, includeVectors?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionResult>>;
|
|
96
100
|
/**
|
|
97
101
|
* List execution history for a cluster with pagination, filtering, sorting, and search. Returns all historical executions for the specified cluster, including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Execution timestamps and duration - Centroid information Supports: - **Filtering**: Filter by status, date range, metrics, etc. - **Sorting**: Sort by created_at, execution time, metrics - **Search**: Full-text search across execution metadata - **Pagination**: Limit and offset for large result sets Use cases: - View all past executions for a cluster - Compare metrics across runs - Track execution history over time - Debug failed executions - Analyze clustering performance trends
|
|
98
102
|
* @summary List Cluster Execution History
|
|
@@ -178,6 +182,12 @@ export interface ClusterExecutionsApiGetClusterExecutionRequest {
|
|
|
178
182
|
* @memberof ClusterExecutionsApiGetClusterExecution
|
|
179
183
|
*/
|
|
180
184
|
readonly clusterId: string;
|
|
185
|
+
/**
|
|
186
|
+
* Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in: vectors are large (~120KB for 15x1024-dim centroids), so they are omitted from the response entirely unless this is true. Lets clients run vector-input searches with a centroid as the query even when the centroid document is no longer in the vector store.
|
|
187
|
+
* @type {boolean}
|
|
188
|
+
* @memberof ClusterExecutionsApiGetClusterExecution
|
|
189
|
+
*/
|
|
190
|
+
readonly includeVectors?: boolean;
|
|
181
191
|
}
|
|
182
192
|
/**
|
|
183
193
|
* Request parameters for getClusterExecutionByRun operation in ClusterExecutionsApi.
|
|
@@ -197,6 +207,12 @@ export interface ClusterExecutionsApiGetClusterExecutionByRunRequest {
|
|
|
197
207
|
* @memberof ClusterExecutionsApiGetClusterExecutionByRun
|
|
198
208
|
*/
|
|
199
209
|
readonly runId: string;
|
|
210
|
+
/**
|
|
211
|
+
* Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in; see GET /{cluster_id}/executions for details.
|
|
212
|
+
* @type {boolean}
|
|
213
|
+
* @memberof ClusterExecutionsApiGetClusterExecutionByRun
|
|
214
|
+
*/
|
|
215
|
+
readonly includeVectors?: boolean;
|
|
200
216
|
}
|
|
201
217
|
/**
|
|
202
218
|
* Request parameters for listClusterExecutions operation in ClusterExecutionsApi.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cluster-executions-api.d.ts","sourceRoot":"","sources":["../../api/cluster-executions-api.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAMhF,OAAO,EAAiC,KAAK,WAAW,EAAE,OAAO,EAAqC,MAAM,SAAS,CAAC;AAEtH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAMxD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAE9D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC/D;;;GAGG;AACH,eAAO,MAAM,qCAAqC,GAAa,gBAAgB,aAAa;IAEpF;;;;;;;OAOG;8CAC6C,MAAM,SAAS,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA8BjI
|
|
1
|
+
{"version":3,"file":"cluster-executions-api.d.ts","sourceRoot":"","sources":["../../api/cluster-executions-api.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,OAAO,CAAC;AAMhF,OAAO,EAAiC,KAAK,WAAW,EAAE,OAAO,EAAqC,MAAM,SAAS,CAAC;AAEtH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAMxD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAE9D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC/D;;;GAGG;AACH,eAAO,MAAM,qCAAqC,GAAa,gBAAgB,aAAa;IAEpF;;;;;;;OAOG;8CAC6C,MAAM,SAAS,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA8BjI;;;;;;;OAOG;qCACoC,MAAM,mBAAmB,OAAO,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA+BnI;;;;;;;;OAQG;0CACyC,MAAM,SAAS,MAAM,mBAAmB,OAAO,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAkCvJ;;;;;;;;;;;;;OAaG;uCACsC,MAAM,UAAU,MAAM,aAAa,MAAM,WAAW,MAAM,SAAS,MAAM,WAAW,MAAM,iBAAiB,OAAO,iCAAiC,4BAA4B,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CAuD3R,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAY,gBAAgB,aAAa;IAGpE;;;;;;;OAOG;4CAC2C,MAAM,SAAS,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,GAAG,CAAC,CAAC;IAM/K;;;;;;;OAOG;mCACkC,MAAM,mBAAmB,OAAO,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAMpM;;;;;;;;OAQG;wCACuC,MAAM,SAAS,MAAM,mBAAmB,OAAO,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAMxN;;;;;;;;;;;;;OAaG;qCACoC,MAAM,UAAU,MAAM,aAAa,MAAM,WAAW,MAAM,SAAS,MAAM,WAAW,MAAM,iBAAiB,OAAO,iCAAiC,4BAA4B,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,6BAA6B,CAAC,CAAC;CAOnW,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGpH;;;;;;OAMG;oDAC6C,uDAAuD,YAAY,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC;IAG5J;;;;;;OAMG;2CACoC,8CAA8C,YAAY,qBAAqB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAG7J;;;;;;OAMG;gDACyC,mDAAmD,YAAY,qBAAqB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAGvK;;;;;;OAMG;6CACsC,gDAAgD,YAAY,qBAAqB,GAAG,YAAY,CAAC,6BAA6B,CAAC;CAI/K,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,uDAAuD;IACpE;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,8CAA8C;IAC3D;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,mDAAmD;IAChE;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,gDAAgD;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,4BAA4B,CAAC,EAAE,4BAA4B,CAAA;CACvE;AAED;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,OAAO;IAC7C;;;;;;;OAOG;IACI,4BAA4B,CAAC,iBAAiB,EAAE,uDAAuD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI/I;;;;;;;OAOG;IACI,mBAAmB,CAAC,iBAAiB,EAAE,8CAA8C,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7H;;;;;;;OAOG;IACI,wBAAwB,CAAC,iBAAiB,EAAE,mDAAmD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIvI;;;;;;;OAOG;IACI,qBAAqB,CAAC,iBAAiB,EAAE,gDAAgD,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGpI"}
|
package/dist/index.js
CHANGED
|
@@ -10171,10 +10171,11 @@ var ClusterExecutionsApiAxiosParamCreator = function(configuration) {
|
|
|
10171
10171
|
* Get the most recent execution results for a cluster. Returns execution metadata including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Centroid information with labels and summaries - Execution timestamps Useful for: - Displaying cluster statistics in dashboards - Showing cluster quality metrics to users - Rendering cluster labels and summaries in the UI - Tracking execution status and errors
|
|
10172
10172
|
* @summary Get Latest Cluster Execution
|
|
10173
10173
|
* @param {string} clusterId Cluster ID
|
|
10174
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in: vectors are large (~120KB for 15x1024-dim centroids), so they are omitted from the response entirely unless this is true. Lets clients run vector-input searches with a centroid as the query even when the centroid document is no longer in the vector store.
|
|
10174
10175
|
* @param {*} [options] Override http request option.
|
|
10175
10176
|
* @throws {RequiredError}
|
|
10176
10177
|
*/
|
|
10177
|
-
getClusterExecution: async (clusterId, options = {}) => {
|
|
10178
|
+
getClusterExecution: async (clusterId, includeVectors, options = {}) => {
|
|
10178
10179
|
assertParamExists("getClusterExecution", "clusterId", clusterId);
|
|
10179
10180
|
const localVarPath = `/v1/clusters/{cluster_id}/executions`.replace(`{${"cluster_id"}}`, encodeURIComponent(String(clusterId)));
|
|
10180
10181
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -10185,6 +10186,9 @@ var ClusterExecutionsApiAxiosParamCreator = function(configuration) {
|
|
|
10185
10186
|
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
10186
10187
|
const localVarHeaderParameter = {};
|
|
10187
10188
|
const localVarQueryParameter = {};
|
|
10189
|
+
if (includeVectors !== void 0) {
|
|
10190
|
+
localVarQueryParameter["include_vectors"] = includeVectors;
|
|
10191
|
+
}
|
|
10188
10192
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10189
10193
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10190
10194
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -10198,10 +10202,11 @@ var ClusterExecutionsApiAxiosParamCreator = function(configuration) {
|
|
|
10198
10202
|
* @summary Get Specific Cluster Execution
|
|
10199
10203
|
* @param {string} clusterId Cluster ID
|
|
10200
10204
|
* @param {string} runId Run ID
|
|
10205
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in; see GET /{cluster_id}/executions for details.
|
|
10201
10206
|
* @param {*} [options] Override http request option.
|
|
10202
10207
|
* @throws {RequiredError}
|
|
10203
10208
|
*/
|
|
10204
|
-
getClusterExecutionByRun: async (clusterId, runId, options = {}) => {
|
|
10209
|
+
getClusterExecutionByRun: async (clusterId, runId, includeVectors, options = {}) => {
|
|
10205
10210
|
assertParamExists("getClusterExecutionByRun", "clusterId", clusterId);
|
|
10206
10211
|
assertParamExists("getClusterExecutionByRun", "runId", runId);
|
|
10207
10212
|
const localVarPath = `/v1/clusters/{cluster_id}/executions/{run_id}`.replace(`{${"cluster_id"}}`, encodeURIComponent(String(clusterId))).replace(`{${"run_id"}}`, encodeURIComponent(String(runId)));
|
|
@@ -10213,6 +10218,9 @@ var ClusterExecutionsApiAxiosParamCreator = function(configuration) {
|
|
|
10213
10218
|
const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
|
|
10214
10219
|
const localVarHeaderParameter = {};
|
|
10215
10220
|
const localVarQueryParameter = {};
|
|
10221
|
+
if (includeVectors !== void 0) {
|
|
10222
|
+
localVarQueryParameter["include_vectors"] = includeVectors;
|
|
10223
|
+
}
|
|
10216
10224
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10217
10225
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10218
10226
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -10297,11 +10305,12 @@ var ClusterExecutionsApiFp = function(configuration) {
|
|
|
10297
10305
|
* Get the most recent execution results for a cluster. Returns execution metadata including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Centroid information with labels and summaries - Execution timestamps Useful for: - Displaying cluster statistics in dashboards - Showing cluster quality metrics to users - Rendering cluster labels and summaries in the UI - Tracking execution status and errors
|
|
10298
10306
|
* @summary Get Latest Cluster Execution
|
|
10299
10307
|
* @param {string} clusterId Cluster ID
|
|
10308
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in: vectors are large (~120KB for 15x1024-dim centroids), so they are omitted from the response entirely unless this is true. Lets clients run vector-input searches with a centroid as the query even when the centroid document is no longer in the vector store.
|
|
10300
10309
|
* @param {*} [options] Override http request option.
|
|
10301
10310
|
* @throws {RequiredError}
|
|
10302
10311
|
*/
|
|
10303
|
-
async getClusterExecution(clusterId, options) {
|
|
10304
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterExecution(clusterId, options);
|
|
10312
|
+
async getClusterExecution(clusterId, includeVectors, options) {
|
|
10313
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterExecution(clusterId, includeVectors, options);
|
|
10305
10314
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10306
10315
|
const localVarOperationServerBasePath = operationServerMap["ClusterExecutionsApi.getClusterExecution"]?.[localVarOperationServerIndex]?.url;
|
|
10307
10316
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -10311,11 +10320,12 @@ var ClusterExecutionsApiFp = function(configuration) {
|
|
|
10311
10320
|
* @summary Get Specific Cluster Execution
|
|
10312
10321
|
* @param {string} clusterId Cluster ID
|
|
10313
10322
|
* @param {string} runId Run ID
|
|
10323
|
+
* @param {boolean} [includeVectors] Include each centroid\'s embedding vector (centroids[].centroid_vector). Opt-in; see GET /{cluster_id}/executions for details.
|
|
10314
10324
|
* @param {*} [options] Override http request option.
|
|
10315
10325
|
* @throws {RequiredError}
|
|
10316
10326
|
*/
|
|
10317
|
-
async getClusterExecutionByRun(clusterId, runId, options) {
|
|
10318
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterExecutionByRun(clusterId, runId, options);
|
|
10327
|
+
async getClusterExecutionByRun(clusterId, runId, includeVectors, options) {
|
|
10328
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterExecutionByRun(clusterId, runId, includeVectors, options);
|
|
10319
10329
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10320
10330
|
const localVarOperationServerBasePath = operationServerMap["ClusterExecutionsApi.getClusterExecutionByRun"]?.[localVarOperationServerIndex]?.url;
|
|
10321
10331
|
return (axios2, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios5__default.default, BASE_PATH, configuration)(axios2, localVarOperationServerBasePath || basePath);
|
|
@@ -10363,7 +10373,7 @@ var ClusterExecutionsApi = class extends BaseAPI {
|
|
|
10363
10373
|
* @memberof ClusterExecutionsApi
|
|
10364
10374
|
*/
|
|
10365
10375
|
getClusterExecution(requestParameters, options) {
|
|
10366
|
-
return ClusterExecutionsApiFp(this.configuration).getClusterExecution(requestParameters.clusterId, options).then((request) => request(this.axios, this.basePath));
|
|
10376
|
+
return ClusterExecutionsApiFp(this.configuration).getClusterExecution(requestParameters.clusterId, requestParameters.includeVectors, options).then((request) => request(this.axios, this.basePath));
|
|
10367
10377
|
}
|
|
10368
10378
|
/**
|
|
10369
10379
|
* Get a specific execution by run ID. Returns detailed execution information for a particular clustering run, allowing you to review historical executions and compare results over time.
|
|
@@ -10374,7 +10384,7 @@ var ClusterExecutionsApi = class extends BaseAPI {
|
|
|
10374
10384
|
* @memberof ClusterExecutionsApi
|
|
10375
10385
|
*/
|
|
10376
10386
|
getClusterExecutionByRun(requestParameters, options) {
|
|
10377
|
-
return ClusterExecutionsApiFp(this.configuration).getClusterExecutionByRun(requestParameters.clusterId, requestParameters.runId, options).then((request) => request(this.axios, this.basePath));
|
|
10387
|
+
return ClusterExecutionsApiFp(this.configuration).getClusterExecutionByRun(requestParameters.clusterId, requestParameters.runId, requestParameters.includeVectors, options).then((request) => request(this.axios, this.basePath));
|
|
10378
10388
|
}
|
|
10379
10389
|
/**
|
|
10380
10390
|
* List execution history for a cluster with pagination, filtering, sorting, and search. Returns all historical executions for the specified cluster, including: - Execution status (pending, processing, completed, failed) - Clustering metrics (silhouette score, Davies-Bouldin index, etc.) - Number of clusters found and documents processed - Execution timestamps and duration - Centroid information Supports: - **Filtering**: Filter by status, date range, metrics, etc. - **Sorting**: Sort by created_at, execution time, metrics - **Search**: Full-text search across execution metadata - **Pagination**: Limit and offset for large result sets Use cases: - View all past executions for a cluster - Compare metrics across runs - Track execution history over time - Debug failed executions - Analyze clustering performance trends
|