mixpeek 0.81.33 → 0.81.35
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/public-scaffolds-api.d.ts +47 -0
- package/dist/api/public-scaffolds-api.d.ts.map +1 -1
- package/dist/api/public-templates-apiapi.d.ts +47 -0
- package/dist/api/public-templates-apiapi.d.ts.map +1 -1
- package/dist/api/scaffold-templates-api.d.ts +47 -0
- package/dist/api/scaffold-templates-api.d.ts.map +1 -1
- package/dist/api/taxonomy-analytics-api.d.ts +190 -0
- package/dist/api/taxonomy-analytics-api.d.ts.map +1 -1
- package/dist/models/analysis-type.d.ts +22 -0
- package/dist/models/analysis-type.d.ts.map +1 -0
- package/dist/models/cluster-execution-result.d.ts +6 -0
- package/dist/models/cluster-execution-result.d.ts.map +1 -1
- package/dist/models/create-blob-request.d.ts +1 -1
- package/dist/models/create-object-request.d.ts +7 -0
- package/dist/models/create-object-request.d.ts.map +1 -1
- package/dist/models/edge-model.d.ts +57 -0
- package/dist/models/edge-model.d.ts.map +1 -0
- package/dist/models/execution-detail.d.ts +1 -1
- package/dist/models/generate-from-interactions-request.d.ts +1 -0
- package/dist/models/generate-from-interactions-request.d.ts.map +1 -1
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/input-mapping.d.ts +1 -1
- package/dist/models/object-response.d.ts +7 -0
- package/dist/models/object-response.d.ts.map +1 -1
- package/dist/models/response-rerun-analytics-run-v1-taxonomies-taxonomy-id-analytics-runs-run-id-rerun-post.d.ts +96 -0
- package/dist/models/response-rerun-analytics-run-v1-taxonomies-taxonomy-id-analytics-runs-run-id-rerun-post.d.ts.map +1 -0
- package/dist/models/scaffold-manifest-response.d.ts +45 -0
- package/dist/models/scaffold-manifest-response.d.ts.map +1 -0
- package/dist/models/taxonomy-analytics-run-list-response.d.ts +44 -0
- package/dist/models/taxonomy-analytics-run-list-response.d.ts.map +1 -0
- package/dist/models/taxonomy-analytics-run.d.ts +126 -0
- package/dist/models/taxonomy-analytics-run.d.ts.map +1 -0
- package/package.json +1 -1
|
@@ -13,11 +13,20 @@ import type { Configuration } from '../configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import type { BaseTemplateModel } from '../models';
|
|
16
|
+
import type { ScaffoldManifestResponse } from '../models';
|
|
16
17
|
/**
|
|
17
18
|
* PublicScaffoldsApi - axios parameter creator
|
|
18
19
|
* @export
|
|
19
20
|
*/
|
|
20
21
|
export declare const PublicScaffoldsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
24
|
+
* @summary Get Scaffold Manifest
|
|
25
|
+
* @param {string} templateId Scaffold template ID
|
|
26
|
+
* @param {*} [options] Override http request option.
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
getScaffoldManifestTemplates: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21
30
|
/**
|
|
22
31
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
23
32
|
* @summary Get Scaffold
|
|
@@ -41,6 +50,14 @@ export declare const PublicScaffoldsApiAxiosParamCreator: (configuration?: Confi
|
|
|
41
50
|
* @export
|
|
42
51
|
*/
|
|
43
52
|
export declare const PublicScaffoldsApiFp: (configuration?: Configuration) => {
|
|
53
|
+
/**
|
|
54
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
55
|
+
* @summary Get Scaffold Manifest
|
|
56
|
+
* @param {string} templateId Scaffold template ID
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
*/
|
|
60
|
+
getScaffoldManifestTemplates(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScaffoldManifestResponse>>;
|
|
44
61
|
/**
|
|
45
62
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
46
63
|
* @summary Get Scaffold
|
|
@@ -64,6 +81,14 @@ export declare const PublicScaffoldsApiFp: (configuration?: Configuration) => {
|
|
|
64
81
|
* @export
|
|
65
82
|
*/
|
|
66
83
|
export declare const PublicScaffoldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
84
|
+
/**
|
|
85
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
86
|
+
* @summary Get Scaffold Manifest
|
|
87
|
+
* @param {PublicScaffoldsApiGetScaffoldManifestTemplatesRequest} requestParameters Request parameters.
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
getScaffoldManifestTemplates(requestParameters: PublicScaffoldsApiGetScaffoldManifestTemplatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ScaffoldManifestResponse>;
|
|
67
92
|
/**
|
|
68
93
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
69
94
|
* @summary Get Scaffold
|
|
@@ -81,6 +106,19 @@ export declare const PublicScaffoldsApiFactory: (configuration?: Configuration,
|
|
|
81
106
|
*/
|
|
82
107
|
listScaffoldsTemplates(requestParameters?: PublicScaffoldsApiListScaffoldsTemplatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<BaseTemplateModel>>;
|
|
83
108
|
};
|
|
109
|
+
/**
|
|
110
|
+
* Request parameters for getScaffoldManifestTemplates operation in PublicScaffoldsApi.
|
|
111
|
+
* @export
|
|
112
|
+
* @interface PublicScaffoldsApiGetScaffoldManifestTemplatesRequest
|
|
113
|
+
*/
|
|
114
|
+
export interface PublicScaffoldsApiGetScaffoldManifestTemplatesRequest {
|
|
115
|
+
/**
|
|
116
|
+
* Scaffold template ID
|
|
117
|
+
* @type {string}
|
|
118
|
+
* @memberof PublicScaffoldsApiGetScaffoldManifestTemplates
|
|
119
|
+
*/
|
|
120
|
+
readonly templateId: string;
|
|
121
|
+
}
|
|
84
122
|
/**
|
|
85
123
|
* Request parameters for getScaffoldTemplates operation in PublicScaffoldsApi.
|
|
86
124
|
* @export
|
|
@@ -120,6 +158,15 @@ export interface PublicScaffoldsApiListScaffoldsTemplatesRequest {
|
|
|
120
158
|
* @extends {BaseAPI}
|
|
121
159
|
*/
|
|
122
160
|
export declare class PublicScaffoldsApi extends BaseAPI {
|
|
161
|
+
/**
|
|
162
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
163
|
+
* @summary Get Scaffold Manifest
|
|
164
|
+
* @param {PublicScaffoldsApiGetScaffoldManifestTemplatesRequest} requestParameters Request parameters.
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
* @memberof PublicScaffoldsApi
|
|
168
|
+
*/
|
|
169
|
+
getScaffoldManifestTemplates(requestParameters: PublicScaffoldsApiGetScaffoldManifestTemplatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScaffoldManifestResponse, any, {}>>;
|
|
123
170
|
/**
|
|
124
171
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
125
172
|
* @summary Get Scaffold
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public-scaffolds-api.d.ts","sourceRoot":"","sources":["../../api/public-scaffolds-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,iBAAiB,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"public-scaffolds-api.d.ts","sourceRoot":"","sources":["../../api/public-scaffolds-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,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAMnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAC1D;;;GAGG;AACH,eAAO,MAAM,mCAAmC,GAAa,gBAAgB,aAAa;IAElF;;;;;;OAMG;+CAC8C,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2BnH;;;;;;OAMG;uCACsC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2B3G;;;;;;;OAOG;wCACuC,MAAM,aAAa,OAAO,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CAiCvI,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,GAAY,gBAAgB,aAAa;IAGlE;;;;;;OAMG;6CAC4C,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,wBAAwB,CAAC,CAAC;IAMtL;;;;;;OAMG;qCACoC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAMvK;;;;;;;OAOG;sCACqC,MAAM,aAAa,OAAO,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;CAO1M,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGlH;;;;;;OAMG;oDAC6C,qDAAqD,YAAY,qBAAqB,GAAG,YAAY,CAAC,wBAAwB,CAAC;IAG/K;;;;;;OAMG;4CACqC,6CAA6C,YAAY,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,CAAC;IAGxJ;;;;;;OAMG;+CACuC,+CAA+C,YAAiB,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;CAI/K,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,qDAAqD;IAClE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,6CAA6C;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,+CAA+C;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,OAAO;IAC3C;;;;;;;OAOG;IACI,4BAA4B,CAAC,iBAAiB,EAAE,qDAAqD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7I;;;;;;;OAOG;IACI,oBAAoB,CAAC,iBAAiB,EAAE,6CAA6C,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7H;;;;;;;OAOG;IACI,sBAAsB,CAAC,iBAAiB,GAAE,+CAAoD,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGzI"}
|
|
@@ -13,6 +13,7 @@ import type { Configuration } from '../configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import type { BaseTemplateModel } from '../models';
|
|
16
|
+
import type { ScaffoldManifestResponse } from '../models';
|
|
16
17
|
/**
|
|
17
18
|
* PublicTemplatesAPIApi - axios parameter creator
|
|
18
19
|
* @export
|
|
@@ -34,6 +35,14 @@ export declare const PublicTemplatesAPIApiAxiosParamCreator: (configuration?: Co
|
|
|
34
35
|
* @throws {RequiredError}
|
|
35
36
|
*/
|
|
36
37
|
getRetrieverTemplate: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
40
|
+
* @summary Get Scaffold Manifest
|
|
41
|
+
* @param {string} templateId Scaffold template ID
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
getScaffoldManifestTemplates: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
46
|
/**
|
|
38
47
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
39
48
|
* @summary Get Scaffold
|
|
@@ -89,6 +98,14 @@ export declare const PublicTemplatesAPIApiFp: (configuration?: Configuration) =>
|
|
|
89
98
|
* @throws {RequiredError}
|
|
90
99
|
*/
|
|
91
100
|
getRetrieverTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseTemplateModel>>;
|
|
101
|
+
/**
|
|
102
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
103
|
+
* @summary Get Scaffold Manifest
|
|
104
|
+
* @param {string} templateId Scaffold template ID
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
getScaffoldManifestTemplates(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScaffoldManifestResponse>>;
|
|
92
109
|
/**
|
|
93
110
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
94
111
|
* @summary Get Scaffold
|
|
@@ -144,6 +161,14 @@ export declare const PublicTemplatesAPIApiFactory: (configuration?: Configuratio
|
|
|
144
161
|
* @throws {RequiredError}
|
|
145
162
|
*/
|
|
146
163
|
getRetrieverTemplate(requestParameters: PublicTemplatesAPIApiGetRetrieverTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<BaseTemplateModel>;
|
|
164
|
+
/**
|
|
165
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
166
|
+
* @summary Get Scaffold Manifest
|
|
167
|
+
* @param {PublicTemplatesAPIApiGetScaffoldManifestTemplatesRequest} requestParameters Request parameters.
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
getScaffoldManifestTemplates(requestParameters: PublicTemplatesAPIApiGetScaffoldManifestTemplatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ScaffoldManifestResponse>;
|
|
147
172
|
/**
|
|
148
173
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
149
174
|
* @summary Get Scaffold
|
|
@@ -203,6 +228,19 @@ export interface PublicTemplatesAPIApiGetRetrieverTemplateRequest {
|
|
|
203
228
|
*/
|
|
204
229
|
readonly templateId: string;
|
|
205
230
|
}
|
|
231
|
+
/**
|
|
232
|
+
* Request parameters for getScaffoldManifestTemplates operation in PublicTemplatesAPIApi.
|
|
233
|
+
* @export
|
|
234
|
+
* @interface PublicTemplatesAPIApiGetScaffoldManifestTemplatesRequest
|
|
235
|
+
*/
|
|
236
|
+
export interface PublicTemplatesAPIApiGetScaffoldManifestTemplatesRequest {
|
|
237
|
+
/**
|
|
238
|
+
* Scaffold template ID
|
|
239
|
+
* @type {string}
|
|
240
|
+
* @memberof PublicTemplatesAPIApiGetScaffoldManifestTemplates
|
|
241
|
+
*/
|
|
242
|
+
readonly templateId: string;
|
|
243
|
+
}
|
|
206
244
|
/**
|
|
207
245
|
* Request parameters for getScaffoldTemplates operation in PublicTemplatesAPIApi.
|
|
208
246
|
* @export
|
|
@@ -286,6 +324,15 @@ export declare class PublicTemplatesAPIApi extends BaseAPI {
|
|
|
286
324
|
* @memberof PublicTemplatesAPIApi
|
|
287
325
|
*/
|
|
288
326
|
getRetrieverTemplate(requestParameters: PublicTemplatesAPIApiGetRetrieverTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BaseTemplateModel, any, {}>>;
|
|
327
|
+
/**
|
|
328
|
+
* Render a scaffold template as a Mixpeek manifest (public, no auth). Powers the Studio namespace-templates UI, which shows each template as a declarative manifest tree + copyable YAML (the same IaC format used by `POST /v1/manifest/apply`). Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
329
|
+
* @summary Get Scaffold Manifest
|
|
330
|
+
* @param {PublicTemplatesAPIApiGetScaffoldManifestTemplatesRequest} requestParameters Request parameters.
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
* @memberof PublicTemplatesAPIApi
|
|
334
|
+
*/
|
|
335
|
+
getScaffoldManifestTemplates(requestParameters: PublicTemplatesAPIApiGetScaffoldManifestTemplatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScaffoldManifestResponse, any, {}>>;
|
|
289
336
|
/**
|
|
290
337
|
* Get scaffold template details (public, no auth required). Returns the complete configuration including: - Namespace: feature extractors, payload indexes - Bucket: name, description, schema - Collection: feature extractor config - Retriever: stages, input schema **To instantiate (requires auth):** ``` POST /v1/templates/scaffolds/{template_id}/instantiate {\"namespace_name\": \"my_app\"} ```
|
|
291
338
|
* @summary Get Scaffold
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"public-templates-apiapi.d.ts","sourceRoot":"","sources":["../../api/public-templates-apiapi.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,iBAAiB,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"public-templates-apiapi.d.ts","sourceRoot":"","sources":["../../api/public-templates-apiapi.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,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAMnD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAC1D;;;GAGG;AACH,eAAO,MAAM,sCAAsC,GAAa,gBAAgB,aAAa;IAErF;;;;;;OAMG;uCACsC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2B3G;;;;;;OAMG;uCACsC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2B3G;;;;;;OAMG;+CAC8C,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2BnH;;;;;;OAMG;uCACsC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2B3G;;;;;;OAMG;wCACuC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA4B5G;;;;;;OAMG;wCACuC,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA4B5G;;;;;;;OAOG;wCACuC,MAAM,aAAa,OAAO,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CAiCvI,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAY,gBAAgB,aAAa;IAGrE;;;;;;OAMG;qCACoC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAMvK;;;;;;OAMG;qCACoC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAMvK;;;;;;OAMG;6CAC4C,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,wBAAwB,CAAC,CAAC;IAMtL;;;;;;OAMG;qCACoC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,iBAAiB,CAAC,CAAC;IAMvK;;;;;;OAMG;sCACqC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAM/K;;;;;;OAMG;sCACqC,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAM/K;;;;;;;OAOG;sCACqC,MAAM,aAAa,OAAO,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;CAO1M,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGrH;;;;;;OAMG;4CACqC,gDAAgD,YAAY,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,CAAC;IAG3J;;;;;;OAMG;4CACqC,gDAAgD,YAAY,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,CAAC;IAG3J;;;;;;OAMG;oDAC6C,wDAAwD,YAAY,qBAAqB,GAAG,YAAY,CAAC,wBAAwB,CAAC;IAGlL;;;;;;OAMG;4CACqC,gDAAgD,YAAY,qBAAqB,GAAG,YAAY,CAAC,iBAAiB,CAAC;IAG3J;;;;;;OAMG;+CACuC,kDAAkD,YAAiB,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAG3K;;;;;;OAMG;+CACuC,kDAAkD,YAAiB,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAG3K;;;;;;OAMG;+CACuC,kDAAkD,YAAiB,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;CAIlL,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,gDAAgD;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,gDAAgD;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,wDAAwD;IACrE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,gDAAgD;IAC7D;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,kDAAkD;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kDAAkD;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kDAAkD;IAC/D;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,OAAO;IAC9C;;;;;;;OAOG;IACI,oBAAoB,CAAC,iBAAiB,EAAE,gDAAgD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIhI;;;;;;;OAOG;IACI,oBAAoB,CAAC,iBAAiB,EAAE,gDAAgD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIhI;;;;;;;OAOG;IACI,4BAA4B,CAAC,iBAAiB,EAAE,wDAAwD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIhJ;;;;;;;OAOG;IACI,oBAAoB,CAAC,iBAAiB,EAAE,gDAAgD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIhI;;;;;;;OAOG;IACI,sBAAsB,CAAC,iBAAiB,GAAE,kDAAuD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIzI;;;;;;;OAOG;IACI,sBAAsB,CAAC,iBAAiB,GAAE,kDAAuD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIzI;;;;;;;OAOG;IACI,sBAAsB,CAAC,iBAAiB,GAAE,kDAAuD,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAG5I"}
|
|
@@ -14,6 +14,7 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import type { InstantiateScaffoldRequest } from '../models';
|
|
16
16
|
import type { InstantiatedScaffoldResponse } from '../models';
|
|
17
|
+
import type { ScaffoldManifestResponse } from '../models';
|
|
17
18
|
/**
|
|
18
19
|
* ScaffoldTemplatesApi - axios parameter creator
|
|
19
20
|
* @export
|
|
@@ -26,6 +27,14 @@ export declare const ScaffoldTemplatesApiAxiosParamCreator: (configuration?: Con
|
|
|
26
27
|
* @throws {RequiredError}
|
|
27
28
|
*/
|
|
28
29
|
getOrCreateDefaultNamespaceTemplatesScaffolds: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
|
+
/**
|
|
31
|
+
* Render a scaffold template as a Mixpeek manifest. Converts the scaffold\'s configuration (namespace, bucket, collections, retriever, taxonomies, clusters) into declarative Infrastructure-as-Code YAML — the same format used by `POST /v1/manifest/apply` and `GET /v1/manifest/export`. Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
32
|
+
* @summary Get Scaffold Template Manifest
|
|
33
|
+
* @param {string} templateId Scaffold template ID
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
getScaffoldTemplateManifest: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
38
|
/**
|
|
30
39
|
* Create complete infrastructure from scaffold template. Creates all resources atomically: 1. **Namespace** with configured feature extractors 2. **Bucket** with schema for your data structure 3. **Collection** linked to bucket with feature config 4. **Retriever** with search pipeline stages All resources are empty, ready for data upload. **Next Steps:** 1. Upload data: `POST /v1/buckets/{bucket_id}/objects` 2. Process batch: `POST /v1/collections/{collection_id}/batches` 3. Search: `POST /v1/retrievers/{retriever_id}/retrieve` **Example Request:** ```json { \"namespace_name\": \"my_video_app\", \"namespace_description\": \"Video search application\" } ```
|
|
31
40
|
* @summary Instantiate Scaffold Template
|
|
@@ -48,6 +57,14 @@ export declare const ScaffoldTemplatesApiFp: (configuration?: Configuration) =>
|
|
|
48
57
|
* @throws {RequiredError}
|
|
49
58
|
*/
|
|
50
59
|
getOrCreateDefaultNamespaceTemplatesScaffolds(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InstantiatedScaffoldResponse>>;
|
|
60
|
+
/**
|
|
61
|
+
* Render a scaffold template as a Mixpeek manifest. Converts the scaffold\'s configuration (namespace, bucket, collections, retriever, taxonomies, clusters) into declarative Infrastructure-as-Code YAML — the same format used by `POST /v1/manifest/apply` and `GET /v1/manifest/export`. Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
62
|
+
* @summary Get Scaffold Template Manifest
|
|
63
|
+
* @param {string} templateId Scaffold template ID
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
getScaffoldTemplateManifest(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScaffoldManifestResponse>>;
|
|
51
68
|
/**
|
|
52
69
|
* Create complete infrastructure from scaffold template. Creates all resources atomically: 1. **Namespace** with configured feature extractors 2. **Bucket** with schema for your data structure 3. **Collection** linked to bucket with feature config 4. **Retriever** with search pipeline stages All resources are empty, ready for data upload. **Next Steps:** 1. Upload data: `POST /v1/buckets/{bucket_id}/objects` 2. Process batch: `POST /v1/collections/{collection_id}/batches` 3. Search: `POST /v1/retrievers/{retriever_id}/retrieve` **Example Request:** ```json { \"namespace_name\": \"my_video_app\", \"namespace_description\": \"Video search application\" } ```
|
|
53
70
|
* @summary Instantiate Scaffold Template
|
|
@@ -70,6 +87,14 @@ export declare const ScaffoldTemplatesApiFactory: (configuration?: Configuration
|
|
|
70
87
|
* @throws {RequiredError}
|
|
71
88
|
*/
|
|
72
89
|
getOrCreateDefaultNamespaceTemplatesScaffolds(options?: RawAxiosRequestConfig): AxiosPromise<InstantiatedScaffoldResponse>;
|
|
90
|
+
/**
|
|
91
|
+
* Render a scaffold template as a Mixpeek manifest. Converts the scaffold\'s configuration (namespace, bucket, collections, retriever, taxonomies, clusters) into declarative Infrastructure-as-Code YAML — the same format used by `POST /v1/manifest/apply` and `GET /v1/manifest/export`. Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
92
|
+
* @summary Get Scaffold Template Manifest
|
|
93
|
+
* @param {ScaffoldTemplatesApiGetScaffoldTemplateManifestRequest} requestParameters Request parameters.
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
getScaffoldTemplateManifest(requestParameters: ScaffoldTemplatesApiGetScaffoldTemplateManifestRequest, options?: RawAxiosRequestConfig): AxiosPromise<ScaffoldManifestResponse>;
|
|
73
98
|
/**
|
|
74
99
|
* Create complete infrastructure from scaffold template. Creates all resources atomically: 1. **Namespace** with configured feature extractors 2. **Bucket** with schema for your data structure 3. **Collection** linked to bucket with feature config 4. **Retriever** with search pipeline stages All resources are empty, ready for data upload. **Next Steps:** 1. Upload data: `POST /v1/buckets/{bucket_id}/objects` 2. Process batch: `POST /v1/collections/{collection_id}/batches` 3. Search: `POST /v1/retrievers/{retriever_id}/retrieve` **Example Request:** ```json { \"namespace_name\": \"my_video_app\", \"namespace_description\": \"Video search application\" } ```
|
|
75
100
|
* @summary Instantiate Scaffold Template
|
|
@@ -79,6 +104,19 @@ export declare const ScaffoldTemplatesApiFactory: (configuration?: Configuration
|
|
|
79
104
|
*/
|
|
80
105
|
instantiateScaffoldTemplate(requestParameters: ScaffoldTemplatesApiInstantiateScaffoldTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<InstantiatedScaffoldResponse>;
|
|
81
106
|
};
|
|
107
|
+
/**
|
|
108
|
+
* Request parameters for getScaffoldTemplateManifest operation in ScaffoldTemplatesApi.
|
|
109
|
+
* @export
|
|
110
|
+
* @interface ScaffoldTemplatesApiGetScaffoldTemplateManifestRequest
|
|
111
|
+
*/
|
|
112
|
+
export interface ScaffoldTemplatesApiGetScaffoldTemplateManifestRequest {
|
|
113
|
+
/**
|
|
114
|
+
* Scaffold template ID
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof ScaffoldTemplatesApiGetScaffoldTemplateManifest
|
|
117
|
+
*/
|
|
118
|
+
readonly templateId: string;
|
|
119
|
+
}
|
|
82
120
|
/**
|
|
83
121
|
* Request parameters for instantiateScaffoldTemplate operation in ScaffoldTemplatesApi.
|
|
84
122
|
* @export
|
|
@@ -113,6 +151,15 @@ export declare class ScaffoldTemplatesApi extends BaseAPI {
|
|
|
113
151
|
* @memberof ScaffoldTemplatesApi
|
|
114
152
|
*/
|
|
115
153
|
getOrCreateDefaultNamespaceTemplatesScaffolds(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InstantiatedScaffoldResponse, any, {}>>;
|
|
154
|
+
/**
|
|
155
|
+
* Render a scaffold template as a Mixpeek manifest. Converts the scaffold\'s configuration (namespace, bucket, collections, retriever, taxonomies, clusters) into declarative Infrastructure-as-Code YAML — the same format used by `POST /v1/manifest/apply` and `GET /v1/manifest/export`. Returns both the YAML string (`manifest_yaml`) and the parsed manifest dict (`manifest`).
|
|
156
|
+
* @summary Get Scaffold Template Manifest
|
|
157
|
+
* @param {ScaffoldTemplatesApiGetScaffoldTemplateManifestRequest} requestParameters Request parameters.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
* @memberof ScaffoldTemplatesApi
|
|
161
|
+
*/
|
|
162
|
+
getScaffoldTemplateManifest(requestParameters: ScaffoldTemplatesApiGetScaffoldTemplateManifestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ScaffoldManifestResponse, any, {}>>;
|
|
116
163
|
/**
|
|
117
164
|
* Create complete infrastructure from scaffold template. Creates all resources atomically: 1. **Namespace** with configured feature extractors 2. **Bucket** with schema for your data structure 3. **Collection** linked to bucket with feature config 4. **Retriever** with search pipeline stages All resources are empty, ready for data upload. **Next Steps:** 1. Upload data: `POST /v1/buckets/{bucket_id}/objects` 2. Process batch: `POST /v1/collections/{collection_id}/batches` 3. Search: `POST /v1/retrievers/{retriever_id}/retrieve` **Example Request:** ```json { \"namespace_name\": \"my_video_app\", \"namespace_description\": \"Video search application\" } ```
|
|
118
165
|
* @summary Instantiate Scaffold Template
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold-templates-api.d.ts","sourceRoot":"","sources":["../../api/scaffold-templates-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;AAMtH,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAE5D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"scaffold-templates-api.d.ts","sourceRoot":"","sources":["../../api/scaffold-templates-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;AAMtH,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAE5D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAE9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAC1D;;;GAGG;AACH,eAAO,MAAM,qCAAqC,GAAa,gBAAgB,aAAa;IAEpF;;;;;OAKG;8DAC4D,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAwBhH;;;;;;OAMG;8CAC6C,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2BlH;;;;;;;OAOG;8CAC6C,MAAM,8BAA8B,0BAA0B,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CAiCjL,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAY,gBAAgB,aAAa;IAGpE;;;;;OAKG;4DAC2D,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,4BAA4B,CAAC,CAAC;IAMvL;;;;;;OAMG;4CAC2C,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,wBAAwB,CAAC,CAAC;IAMrL;;;;;;;OAOG;4CAC2C,MAAM,8BAA8B,0BAA0B,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,4BAA4B,CAAC,CAAC;CAOxP,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGpH;;;;;OAKG;4DACqD,qBAAqB,GAAG,YAAY,CAAC,4BAA4B,CAAC;IAG1H;;;;;;OAMG;mDAC4C,sDAAsD,YAAY,qBAAqB,GAAG,YAAY,CAAC,wBAAwB,CAAC;IAG/K;;;;;;OAMG;mDAC4C,sDAAsD,YAAY,qBAAqB,GAAG,YAAY,CAAC,4BAA4B,CAAC;CAI1L,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,sDAAsD;IACnE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,sDAAsD;IACnE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,0BAA0B,EAAE,0BAA0B,CAAA;CAClE;AAED;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,OAAO;IAC7C;;;;;;OAMG;IACI,6CAA6C,CAAC,OAAO,CAAC,EAAE,qBAAqB;IAIpF;;;;;;;OAOG;IACI,2BAA2B,CAAC,iBAAiB,EAAE,sDAAsD,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7I;;;;;;;OAOG;IACI,2BAA2B,CAAC,iBAAiB,EAAE,sDAAsD,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGhJ"}
|
|
@@ -12,11 +12,15 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { AnalysisType } from '../models';
|
|
15
16
|
import type { AvailableStepsResponse } from '../models';
|
|
16
17
|
import type { PathAnalysisRequest } from '../models';
|
|
17
18
|
import type { PathAnalysisResponse } from '../models';
|
|
19
|
+
import type { ResponseRerunAnalyticsRunV1TaxonomiesTaxonomyIdAnalyticsRunsRunIdRerunPost } from '../models';
|
|
18
20
|
import type { StepTransitionRequest } from '../models';
|
|
19
21
|
import type { StepTransitionResponse } from '../models';
|
|
22
|
+
import type { TaxonomyAnalyticsRun } from '../models';
|
|
23
|
+
import type { TaxonomyAnalyticsRunListResponse } from '../models';
|
|
20
24
|
/**
|
|
21
25
|
* TaxonomyAnalyticsApi - axios parameter creator
|
|
22
26
|
* @export
|
|
@@ -40,6 +44,15 @@ export declare const TaxonomyAnalyticsApiAxiosParamCreator: (configuration?: Con
|
|
|
40
44
|
* @throws {RequiredError}
|
|
41
45
|
*/
|
|
42
46
|
computeStepTransitionsTaxonomiesTaxonomyIdAnalytics: (taxonomyId: string, stepTransitionRequest: StepTransitionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
/**
|
|
48
|
+
* Retrieve a single persisted analytics run (its parameters and stored result) so it can be reviewed or re-run.
|
|
49
|
+
* @summary Get a taxonomy analytics run
|
|
50
|
+
* @param {string} taxonomyId
|
|
51
|
+
* @param {string} runId
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
getAnalyticsRunTaxonomiesTaxonomy: (taxonomyId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
56
|
/**
|
|
44
57
|
* Get all available steps for a taxonomy and collection. This endpoint discovers what steps exist in your analytics data by querying the ClickHouse taxonomy_events table. Use this before querying transitions or paths to understand what step values you can use. **Use Cases:** - Discover available steps before querying analytics - Validate step names (avoid typos in from_step/to_step) - See which steps have the most events - Check data freshness (first_seen/last_seen timestamps) **Example Usage:** ```python # 1. Get available steps GET /v1/taxonomies/tax_sales/analytics/available-steps?collection_id=col_emails # Response: { \"taxonomy_id\": \"tax_sales\", \"collection_id\": \"col_emails\", \"total_events\": 5432, \"total_sequences\": 1000, \"steps\": [ {\"step_key\": \"inquiry\", \"event_count\": 1000, ...}, {\"step_key\": \"followup\", \"event_count\": 450, ...}, {\"step_key\": \"closed_won\", \"event_count\": 350, ...} ] } # 2. Use discovered steps in transition query POST /v1/taxonomies/tax_sales/analytics/transitions { \"collection_id\": \"col_emails\", \"from_step\": \"inquiry\", # From available steps \"to_step\": \"closed_won\" # From available steps } ``` Args: request: FastAPI request object (contains tenant context) taxonomy_id: Taxonomy ID to query collection_id: Collection ID for filtering events Returns: AvailableStepsResponse with all steps sorted by event count (descending) Raises: NotFoundError: If taxonomy not found ValidationError: If unable to query ClickHouse
|
|
45
58
|
* @summary Get Available Steps
|
|
@@ -49,6 +62,27 @@ export declare const TaxonomyAnalyticsApiAxiosParamCreator: (configuration?: Con
|
|
|
49
62
|
* @throws {RequiredError}
|
|
50
63
|
*/
|
|
51
64
|
getAvailableStepsTaxonomiesTaxonomyIdAnalytics: (taxonomyId: string, collectionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
|
+
/**
|
|
66
|
+
* List previously executed step-analytics runs (transitions and paths) for a taxonomy, newest-executed first. Runs are de-duplicated by their parameters, so re-running the same analysis updates the existing entry and bumps its run_count instead of creating a duplicate.
|
|
67
|
+
* @summary List taxonomy analytics run history
|
|
68
|
+
* @param {string} taxonomyId
|
|
69
|
+
* @param {AnalysisType} [analysisType] Filter by analysis type (transitions or paths)
|
|
70
|
+
* @param {string} [collectionId] Filter by collection ID
|
|
71
|
+
* @param {number} [page] Page number (1-indexed)
|
|
72
|
+
* @param {number} [pageSize] Items per page
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
listAnalyticsRunsTaxonomiesTaxonomy: (taxonomyId: string, analysisType?: AnalysisType, collectionId?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
+
/**
|
|
78
|
+
* Re-execute a previously persisted analytics run using its stored parameters and return the FRESH result. The stored run is updated in place with the new result (run_count is incremented).
|
|
79
|
+
* @summary Re-run a stored taxonomy analytics run
|
|
80
|
+
* @param {string} taxonomyId
|
|
81
|
+
* @param {string} runId
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
rerunAnalyticsRunTaxonomiesTaxonomy: (taxonomyId: string, runId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
86
|
};
|
|
53
87
|
/**
|
|
54
88
|
* TaxonomyAnalyticsApi - functional programming interface
|
|
@@ -73,6 +107,15 @@ export declare const TaxonomyAnalyticsApiFp: (configuration?: Configuration) =>
|
|
|
73
107
|
* @throws {RequiredError}
|
|
74
108
|
*/
|
|
75
109
|
computeStepTransitionsTaxonomiesTaxonomyIdAnalytics(taxonomyId: string, stepTransitionRequest: StepTransitionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StepTransitionResponse>>;
|
|
110
|
+
/**
|
|
111
|
+
* Retrieve a single persisted analytics run (its parameters and stored result) so it can be reviewed or re-run.
|
|
112
|
+
* @summary Get a taxonomy analytics run
|
|
113
|
+
* @param {string} taxonomyId
|
|
114
|
+
* @param {string} runId
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
getAnalyticsRunTaxonomiesTaxonomy(taxonomyId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxonomyAnalyticsRun>>;
|
|
76
119
|
/**
|
|
77
120
|
* Get all available steps for a taxonomy and collection. This endpoint discovers what steps exist in your analytics data by querying the ClickHouse taxonomy_events table. Use this before querying transitions or paths to understand what step values you can use. **Use Cases:** - Discover available steps before querying analytics - Validate step names (avoid typos in from_step/to_step) - See which steps have the most events - Check data freshness (first_seen/last_seen timestamps) **Example Usage:** ```python # 1. Get available steps GET /v1/taxonomies/tax_sales/analytics/available-steps?collection_id=col_emails # Response: { \"taxonomy_id\": \"tax_sales\", \"collection_id\": \"col_emails\", \"total_events\": 5432, \"total_sequences\": 1000, \"steps\": [ {\"step_key\": \"inquiry\", \"event_count\": 1000, ...}, {\"step_key\": \"followup\", \"event_count\": 450, ...}, {\"step_key\": \"closed_won\", \"event_count\": 350, ...} ] } # 2. Use discovered steps in transition query POST /v1/taxonomies/tax_sales/analytics/transitions { \"collection_id\": \"col_emails\", \"from_step\": \"inquiry\", # From available steps \"to_step\": \"closed_won\" # From available steps } ``` Args: request: FastAPI request object (contains tenant context) taxonomy_id: Taxonomy ID to query collection_id: Collection ID for filtering events Returns: AvailableStepsResponse with all steps sorted by event count (descending) Raises: NotFoundError: If taxonomy not found ValidationError: If unable to query ClickHouse
|
|
78
121
|
* @summary Get Available Steps
|
|
@@ -82,6 +125,27 @@ export declare const TaxonomyAnalyticsApiFp: (configuration?: Configuration) =>
|
|
|
82
125
|
* @throws {RequiredError}
|
|
83
126
|
*/
|
|
84
127
|
getAvailableStepsTaxonomiesTaxonomyIdAnalytics(taxonomyId: string, collectionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AvailableStepsResponse>>;
|
|
128
|
+
/**
|
|
129
|
+
* List previously executed step-analytics runs (transitions and paths) for a taxonomy, newest-executed first. Runs are de-duplicated by their parameters, so re-running the same analysis updates the existing entry and bumps its run_count instead of creating a duplicate.
|
|
130
|
+
* @summary List taxonomy analytics run history
|
|
131
|
+
* @param {string} taxonomyId
|
|
132
|
+
* @param {AnalysisType} [analysisType] Filter by analysis type (transitions or paths)
|
|
133
|
+
* @param {string} [collectionId] Filter by collection ID
|
|
134
|
+
* @param {number} [page] Page number (1-indexed)
|
|
135
|
+
* @param {number} [pageSize] Items per page
|
|
136
|
+
* @param {*} [options] Override http request option.
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
listAnalyticsRunsTaxonomiesTaxonomy(taxonomyId: string, analysisType?: AnalysisType, collectionId?: string, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaxonomyAnalyticsRunListResponse>>;
|
|
140
|
+
/**
|
|
141
|
+
* Re-execute a previously persisted analytics run using its stored parameters and return the FRESH result. The stored run is updated in place with the new result (run_count is incremented).
|
|
142
|
+
* @summary Re-run a stored taxonomy analytics run
|
|
143
|
+
* @param {string} taxonomyId
|
|
144
|
+
* @param {string} runId
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
rerunAnalyticsRunTaxonomiesTaxonomy(taxonomyId: string, runId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseRerunAnalyticsRunV1TaxonomiesTaxonomyIdAnalyticsRunsRunIdRerunPost>>;
|
|
85
149
|
};
|
|
86
150
|
/**
|
|
87
151
|
* TaxonomyAnalyticsApi - factory interface
|
|
@@ -104,6 +168,14 @@ export declare const TaxonomyAnalyticsApiFactory: (configuration?: Configuration
|
|
|
104
168
|
* @throws {RequiredError}
|
|
105
169
|
*/
|
|
106
170
|
computeStepTransitionsTaxonomiesTaxonomyIdAnalytics(requestParameters: TaxonomyAnalyticsApiComputeStepTransitionsTaxonomiesTaxonomyIdAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<StepTransitionResponse>;
|
|
171
|
+
/**
|
|
172
|
+
* Retrieve a single persisted analytics run (its parameters and stored result) so it can be reviewed or re-run.
|
|
173
|
+
* @summary Get a taxonomy analytics run
|
|
174
|
+
* @param {TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomyRequest} requestParameters Request parameters.
|
|
175
|
+
* @param {*} [options] Override http request option.
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
*/
|
|
178
|
+
getAnalyticsRunTaxonomiesTaxonomy(requestParameters: TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomyRequest, options?: RawAxiosRequestConfig): AxiosPromise<TaxonomyAnalyticsRun>;
|
|
107
179
|
/**
|
|
108
180
|
* Get all available steps for a taxonomy and collection. This endpoint discovers what steps exist in your analytics data by querying the ClickHouse taxonomy_events table. Use this before querying transitions or paths to understand what step values you can use. **Use Cases:** - Discover available steps before querying analytics - Validate step names (avoid typos in from_step/to_step) - See which steps have the most events - Check data freshness (first_seen/last_seen timestamps) **Example Usage:** ```python # 1. Get available steps GET /v1/taxonomies/tax_sales/analytics/available-steps?collection_id=col_emails # Response: { \"taxonomy_id\": \"tax_sales\", \"collection_id\": \"col_emails\", \"total_events\": 5432, \"total_sequences\": 1000, \"steps\": [ {\"step_key\": \"inquiry\", \"event_count\": 1000, ...}, {\"step_key\": \"followup\", \"event_count\": 450, ...}, {\"step_key\": \"closed_won\", \"event_count\": 350, ...} ] } # 2. Use discovered steps in transition query POST /v1/taxonomies/tax_sales/analytics/transitions { \"collection_id\": \"col_emails\", \"from_step\": \"inquiry\", # From available steps \"to_step\": \"closed_won\" # From available steps } ``` Args: request: FastAPI request object (contains tenant context) taxonomy_id: Taxonomy ID to query collection_id: Collection ID for filtering events Returns: AvailableStepsResponse with all steps sorted by event count (descending) Raises: NotFoundError: If taxonomy not found ValidationError: If unable to query ClickHouse
|
|
109
181
|
* @summary Get Available Steps
|
|
@@ -112,6 +184,22 @@ export declare const TaxonomyAnalyticsApiFactory: (configuration?: Configuration
|
|
|
112
184
|
* @throws {RequiredError}
|
|
113
185
|
*/
|
|
114
186
|
getAvailableStepsTaxonomiesTaxonomyIdAnalytics(requestParameters: TaxonomyAnalyticsApiGetAvailableStepsTaxonomiesTaxonomyIdAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<AvailableStepsResponse>;
|
|
187
|
+
/**
|
|
188
|
+
* List previously executed step-analytics runs (transitions and paths) for a taxonomy, newest-executed first. Runs are de-duplicated by their parameters, so re-running the same analysis updates the existing entry and bumps its run_count instead of creating a duplicate.
|
|
189
|
+
* @summary List taxonomy analytics run history
|
|
190
|
+
* @param {TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomyRequest} requestParameters Request parameters.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
listAnalyticsRunsTaxonomiesTaxonomy(requestParameters: TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomyRequest, options?: RawAxiosRequestConfig): AxiosPromise<TaxonomyAnalyticsRunListResponse>;
|
|
195
|
+
/**
|
|
196
|
+
* Re-execute a previously persisted analytics run using its stored parameters and return the FRESH result. The stored run is updated in place with the new result (run_count is incremented).
|
|
197
|
+
* @summary Re-run a stored taxonomy analytics run
|
|
198
|
+
* @param {TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomyRequest} requestParameters Request parameters.
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
*/
|
|
202
|
+
rerunAnalyticsRunTaxonomiesTaxonomy(requestParameters: TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomyRequest, options?: RawAxiosRequestConfig): AxiosPromise<ResponseRerunAnalyticsRunV1TaxonomiesTaxonomyIdAnalyticsRunsRunIdRerunPost>;
|
|
115
203
|
};
|
|
116
204
|
/**
|
|
117
205
|
* Request parameters for analyzeTransitionPathsTaxonomiesTaxonomyIdAnalytics operation in TaxonomyAnalyticsApi.
|
|
@@ -151,6 +239,25 @@ export interface TaxonomyAnalyticsApiComputeStepTransitionsTaxonomiesTaxonomyIdA
|
|
|
151
239
|
*/
|
|
152
240
|
readonly stepTransitionRequest: StepTransitionRequest;
|
|
153
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* Request parameters for getAnalyticsRunTaxonomiesTaxonomy operation in TaxonomyAnalyticsApi.
|
|
244
|
+
* @export
|
|
245
|
+
* @interface TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomyRequest
|
|
246
|
+
*/
|
|
247
|
+
export interface TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomyRequest {
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomy
|
|
252
|
+
*/
|
|
253
|
+
readonly taxonomyId: string;
|
|
254
|
+
/**
|
|
255
|
+
*
|
|
256
|
+
* @type {string}
|
|
257
|
+
* @memberof TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomy
|
|
258
|
+
*/
|
|
259
|
+
readonly runId: string;
|
|
260
|
+
}
|
|
154
261
|
/**
|
|
155
262
|
* Request parameters for getAvailableStepsTaxonomiesTaxonomyIdAnalytics operation in TaxonomyAnalyticsApi.
|
|
156
263
|
* @export
|
|
@@ -170,6 +277,62 @@ export interface TaxonomyAnalyticsApiGetAvailableStepsTaxonomiesTaxonomyIdAnalyt
|
|
|
170
277
|
*/
|
|
171
278
|
readonly collectionId: string;
|
|
172
279
|
}
|
|
280
|
+
/**
|
|
281
|
+
* Request parameters for listAnalyticsRunsTaxonomiesTaxonomy operation in TaxonomyAnalyticsApi.
|
|
282
|
+
* @export
|
|
283
|
+
* @interface TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomyRequest
|
|
284
|
+
*/
|
|
285
|
+
export interface TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomyRequest {
|
|
286
|
+
/**
|
|
287
|
+
*
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomy
|
|
290
|
+
*/
|
|
291
|
+
readonly taxonomyId: string;
|
|
292
|
+
/**
|
|
293
|
+
* Filter by analysis type (transitions or paths)
|
|
294
|
+
* @type {AnalysisType}
|
|
295
|
+
* @memberof TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomy
|
|
296
|
+
*/
|
|
297
|
+
readonly analysisType?: AnalysisType;
|
|
298
|
+
/**
|
|
299
|
+
* Filter by collection ID
|
|
300
|
+
* @type {string}
|
|
301
|
+
* @memberof TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomy
|
|
302
|
+
*/
|
|
303
|
+
readonly collectionId?: string;
|
|
304
|
+
/**
|
|
305
|
+
* Page number (1-indexed)
|
|
306
|
+
* @type {number}
|
|
307
|
+
* @memberof TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomy
|
|
308
|
+
*/
|
|
309
|
+
readonly page?: number;
|
|
310
|
+
/**
|
|
311
|
+
* Items per page
|
|
312
|
+
* @type {number}
|
|
313
|
+
* @memberof TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomy
|
|
314
|
+
*/
|
|
315
|
+
readonly pageSize?: number;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* Request parameters for rerunAnalyticsRunTaxonomiesTaxonomy operation in TaxonomyAnalyticsApi.
|
|
319
|
+
* @export
|
|
320
|
+
* @interface TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomyRequest
|
|
321
|
+
*/
|
|
322
|
+
export interface TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomyRequest {
|
|
323
|
+
/**
|
|
324
|
+
*
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomy
|
|
327
|
+
*/
|
|
328
|
+
readonly taxonomyId: string;
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @type {string}
|
|
332
|
+
* @memberof TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomy
|
|
333
|
+
*/
|
|
334
|
+
readonly runId: string;
|
|
335
|
+
}
|
|
173
336
|
/**
|
|
174
337
|
* TaxonomyAnalyticsApi - object-oriented interface
|
|
175
338
|
* @export
|
|
@@ -195,6 +358,15 @@ export declare class TaxonomyAnalyticsApi extends BaseAPI {
|
|
|
195
358
|
* @memberof TaxonomyAnalyticsApi
|
|
196
359
|
*/
|
|
197
360
|
computeStepTransitionsTaxonomiesTaxonomyIdAnalytics(requestParameters: TaxonomyAnalyticsApiComputeStepTransitionsTaxonomiesTaxonomyIdAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StepTransitionResponse, any, {}>>;
|
|
361
|
+
/**
|
|
362
|
+
* Retrieve a single persisted analytics run (its parameters and stored result) so it can be reviewed or re-run.
|
|
363
|
+
* @summary Get a taxonomy analytics run
|
|
364
|
+
* @param {TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomyRequest} requestParameters Request parameters.
|
|
365
|
+
* @param {*} [options] Override http request option.
|
|
366
|
+
* @throws {RequiredError}
|
|
367
|
+
* @memberof TaxonomyAnalyticsApi
|
|
368
|
+
*/
|
|
369
|
+
getAnalyticsRunTaxonomiesTaxonomy(requestParameters: TaxonomyAnalyticsApiGetAnalyticsRunTaxonomiesTaxonomyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaxonomyAnalyticsRun, any, {}>>;
|
|
198
370
|
/**
|
|
199
371
|
* Get all available steps for a taxonomy and collection. This endpoint discovers what steps exist in your analytics data by querying the ClickHouse taxonomy_events table. Use this before querying transitions or paths to understand what step values you can use. **Use Cases:** - Discover available steps before querying analytics - Validate step names (avoid typos in from_step/to_step) - See which steps have the most events - Check data freshness (first_seen/last_seen timestamps) **Example Usage:** ```python # 1. Get available steps GET /v1/taxonomies/tax_sales/analytics/available-steps?collection_id=col_emails # Response: { \"taxonomy_id\": \"tax_sales\", \"collection_id\": \"col_emails\", \"total_events\": 5432, \"total_sequences\": 1000, \"steps\": [ {\"step_key\": \"inquiry\", \"event_count\": 1000, ...}, {\"step_key\": \"followup\", \"event_count\": 450, ...}, {\"step_key\": \"closed_won\", \"event_count\": 350, ...} ] } # 2. Use discovered steps in transition query POST /v1/taxonomies/tax_sales/analytics/transitions { \"collection_id\": \"col_emails\", \"from_step\": \"inquiry\", # From available steps \"to_step\": \"closed_won\" # From available steps } ``` Args: request: FastAPI request object (contains tenant context) taxonomy_id: Taxonomy ID to query collection_id: Collection ID for filtering events Returns: AvailableStepsResponse with all steps sorted by event count (descending) Raises: NotFoundError: If taxonomy not found ValidationError: If unable to query ClickHouse
|
|
200
372
|
* @summary Get Available Steps
|
|
@@ -204,5 +376,23 @@ export declare class TaxonomyAnalyticsApi extends BaseAPI {
|
|
|
204
376
|
* @memberof TaxonomyAnalyticsApi
|
|
205
377
|
*/
|
|
206
378
|
getAvailableStepsTaxonomiesTaxonomyIdAnalytics(requestParameters: TaxonomyAnalyticsApiGetAvailableStepsTaxonomiesTaxonomyIdAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AvailableStepsResponse, any, {}>>;
|
|
379
|
+
/**
|
|
380
|
+
* List previously executed step-analytics runs (transitions and paths) for a taxonomy, newest-executed first. Runs are de-duplicated by their parameters, so re-running the same analysis updates the existing entry and bumps its run_count instead of creating a duplicate.
|
|
381
|
+
* @summary List taxonomy analytics run history
|
|
382
|
+
* @param {TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomyRequest} requestParameters Request parameters.
|
|
383
|
+
* @param {*} [options] Override http request option.
|
|
384
|
+
* @throws {RequiredError}
|
|
385
|
+
* @memberof TaxonomyAnalyticsApi
|
|
386
|
+
*/
|
|
387
|
+
listAnalyticsRunsTaxonomiesTaxonomy(requestParameters: TaxonomyAnalyticsApiListAnalyticsRunsTaxonomiesTaxonomyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TaxonomyAnalyticsRunListResponse, any, {}>>;
|
|
388
|
+
/**
|
|
389
|
+
* Re-execute a previously persisted analytics run using its stored parameters and return the FRESH result. The stored run is updated in place with the new result (run_count is incremented).
|
|
390
|
+
* @summary Re-run a stored taxonomy analytics run
|
|
391
|
+
* @param {TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomyRequest} requestParameters Request parameters.
|
|
392
|
+
* @param {*} [options] Override http request option.
|
|
393
|
+
* @throws {RequiredError}
|
|
394
|
+
* @memberof TaxonomyAnalyticsApi
|
|
395
|
+
*/
|
|
396
|
+
rerunAnalyticsRunTaxonomiesTaxonomy(requestParameters: TaxonomyAnalyticsApiRerunAnalyticsRunTaxonomiesTaxonomyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseRerunAnalyticsRunV1TaxonomiesTaxonomyIdAnalyticsRunsRunIdRerunPost, any, {}>>;
|
|
207
397
|
}
|
|
208
398
|
//# sourceMappingURL=taxonomy-analytics-api.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"taxonomy-analytics-api.d.ts","sourceRoot":"","sources":["../../api/taxonomy-analytics-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,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAErD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAEtD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"taxonomy-analytics-api.d.ts","sourceRoot":"","sources":["../../api/taxonomy-analytics-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,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAMxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAErD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAEtD,OAAO,KAAK,EAAE,0EAA0E,EAAE,MAAM,WAAW,CAAC;AAE5G,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAExD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAEtD,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,WAAW,CAAC;AAClE;;;GAGG;AACH,eAAO,MAAM,qCAAqC,GAAa,gBAAgB,aAAa;IAEpF;;;;;;;OAOG;sEACqE,MAAM,uBAAuB,mBAAmB,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAgCpL;;;;;;;OAOG;sEACqE,MAAM,yBAAyB,qBAAqB,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAgCxL;;;;;;;OAOG;oDACmD,MAAM,SAAS,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA8BvI;;;;;;;OAOG;iEACgE,MAAM,gBAAgB,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IAiC3J;;;;;;;;;;OAUG;sDACqD,MAAM,iBAAiB,YAAY,iBAAiB,MAAM,SAAS,MAAM,aAAa,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;IA2ChN;;;;;;;OAOG;sDACqD,MAAM,SAAS,MAAM,YAAW,qBAAqB,KAAQ,OAAO,CAAC,WAAW,CAAC;CA+BhJ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAY,gBAAgB,aAAa;IAGpE;;;;;;;OAOG;oEACmE,MAAM,uBAAuB,mBAAmB,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAMnP;;;;;;;OAOG;oEACmE,MAAM,yBAAyB,qBAAqB,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAMzP;;;;;;;OAOG;kDACiD,MAAM,SAAS,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAMtM;;;;;;;OAOG;+DAC8D,MAAM,gBAAgB,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,sBAAsB,CAAC,CAAC;IAM5N;;;;;;;;;;OAUG;oDACmD,MAAM,iBAAiB,YAAY,iBAAiB,MAAM,SAAS,MAAM,aAAa,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,gCAAgC,CAAC,CAAC;IAM3R;;;;;;;OAOG;oDACmD,MAAM,SAAS,MAAM,YAAY,qBAAqB,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,YAAY,CAAC,0EAA0E,CAAC,CAAC;CAOrQ,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GAAa,gBAAgB,aAAa,EAAE,WAAW,MAAM,EAAE,QAAQ,aAAa;IAGpH;;;;;;OAMG;2EACoE,8EAA8E,YAAY,qBAAqB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IAG3N;;;;;;OAMG;2EACoE,8EAA8E,YAAY,qBAAqB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAG7N;;;;;;OAMG;yDACkD,4DAA4D,YAAY,qBAAqB,GAAG,YAAY,CAAC,oBAAoB,CAAC;IAGvL;;;;;;OAMG;sEAC+D,yEAAyE,YAAY,qBAAqB,GAAG,YAAY,CAAC,sBAAsB,CAAC;IAGnN;;;;;;OAMG;2DACoD,8DAA8D,YAAY,qBAAqB,GAAG,YAAY,CAAC,gCAAgC,CAAC;IAGvM;;;;;;OAMG;2DACoD,8DAA8D,YAAY,qBAAqB,GAAG,YAAY,CAAC,0EAA0E,CAAC;CAIxP,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,8EAA8E;IAC3F;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAA;CACpD;AAED;;;;GAIG;AACH,MAAM,WAAW,8EAA8E;IAC3F;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB,CAAA;CACxD;AAED;;;;GAIG;AACH,MAAM,WAAW,4DAA4D;IACzE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,yEAAyE;IACtF;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,8DAA8D;IAC3E;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,8DAA8D;IAC3E;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED;;;;;GAKG;AACH,qBAAa,oBAAqB,SAAQ,OAAO;IAC7C;;;;;;;OAOG;IACI,mDAAmD,CAAC,iBAAiB,EAAE,8EAA8E,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7L;;;;;;;OAOG;IACI,mDAAmD,CAAC,iBAAiB,EAAE,8EAA8E,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7L;;;;;;;OAOG;IACI,iCAAiC,CAAC,iBAAiB,EAAE,4DAA4D,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAIzJ;;;;;;;OAOG;IACI,8CAA8C,CAAC,iBAAiB,EAAE,yEAAyE,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAInL;;;;;;;OAOG;IACI,mCAAmC,CAAC,iBAAiB,EAAE,8DAA8D,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAI7J;;;;;;;OAOG;IACI,mCAAmC,CAAC,iBAAiB,EAAE,8DAA8D,EAAE,OAAO,CAAC,EAAE,qBAAqB;CAGhK"}
|