@chatbotkit/sdk 1.21.10 → 1.23.0
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/cjs/partner/user/v1.d.ts +1 -0
- package/dist/cjs/platform/content/index.cjs +2 -0
- package/dist/cjs/platform/content/index.d.ts +2 -0
- package/dist/cjs/platform/content/tutorial/index.cjs +21 -0
- package/dist/cjs/platform/content/tutorial/index.d.ts +8 -0
- package/dist/cjs/platform/content/tutorial/v1.cjs +26 -0
- package/dist/cjs/platform/content/tutorial/v1.d.ts +19 -0
- package/dist/cjs/report/index.cjs +4 -4
- package/dist/cjs/report/index.d.ts +2 -2
- package/dist/cjs/report/v1.cjs +6 -6
- package/dist/cjs/report/v1.d.ts +5 -5
- package/dist/cjs/types/api/v1.d.ts +289 -3
- package/dist/esm/partner/user/v1.d.ts +1 -0
- package/dist/esm/platform/content/index.d.ts +2 -0
- package/dist/esm/platform/content/index.js +2 -0
- package/dist/esm/platform/content/tutorial/index.d.ts +8 -0
- package/dist/esm/platform/content/tutorial/index.js +17 -0
- package/dist/esm/platform/content/tutorial/v1.d.ts +19 -0
- package/dist/esm/platform/content/tutorial/v1.js +21 -0
- package/dist/esm/report/index.d.ts +2 -2
- package/dist/esm/report/index.js +5 -5
- package/dist/esm/report/v1.d.ts +5 -5
- package/dist/esm/report/v1.js +4 -4
- package/dist/esm/types/api/v1.d.ts +289 -3
- package/package.json +52 -2
|
@@ -10,6 +10,7 @@ export type PartnerUserListRequest = {
|
|
|
10
10
|
order?: "desc" | "asc";
|
|
11
11
|
take?: number;
|
|
12
12
|
meta?: Record<string, string>;
|
|
13
|
+
email?: string;
|
|
13
14
|
};
|
|
14
15
|
export type PartnerUserListResponse = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/json"];
|
|
15
16
|
export type PartnerUserListStreamType = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/jsonl"];
|
|
@@ -4,11 +4,13 @@ exports.PlatformContentClient = void 0;
|
|
|
4
4
|
const client_js_1 = require("../../client.cjs");
|
|
5
5
|
const index_js_1 = require("./doc/index.cjs");
|
|
6
6
|
const index_js_2 = require("./manual/index.cjs");
|
|
7
|
+
const index_js_3 = require("./tutorial/index.cjs");
|
|
7
8
|
class PlatformContentClient extends client_js_1.ChatBotKitClient {
|
|
8
9
|
constructor(options) {
|
|
9
10
|
super(options);
|
|
10
11
|
this.doc = new index_js_1.PlatformContentDocClient(options);
|
|
11
12
|
this.manual = new index_js_2.PlatformContentManualClient(options);
|
|
13
|
+
this.tutorial = new index_js_3.PlatformContentTutorialClient(options);
|
|
12
14
|
}
|
|
13
15
|
}
|
|
14
16
|
exports.PlatformContentClient = PlatformContentClient;
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
export class PlatformContentClient extends ChatBotKitClient {
|
|
2
2
|
doc: PlatformContentDocClient;
|
|
3
3
|
manual: PlatformContentManualClient;
|
|
4
|
+
tutorial: PlatformContentTutorialClient;
|
|
4
5
|
}
|
|
5
6
|
export default PlatformContentClient;
|
|
6
7
|
import { ChatBotKitClient } from '../../client.cjs';
|
|
7
8
|
import { PlatformContentDocClient } from './doc/index.cjs';
|
|
8
9
|
import { PlatformContentManualClient } from './manual/index.cjs';
|
|
10
|
+
import { PlatformContentTutorialClient } from './tutorial/index.cjs';
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PlatformContentTutorialClient = void 0;
|
|
4
|
+
const client_js_1 = require("../../../client.cjs");
|
|
5
|
+
const v1_js_1 = require("./v1.cjs");
|
|
6
|
+
class PlatformContentTutorialClient extends client_js_1.ChatBotKitClient {
|
|
7
|
+
constructor(options) {
|
|
8
|
+
super(options);
|
|
9
|
+
}
|
|
10
|
+
list(request) {
|
|
11
|
+
return (0, v1_js_1.listPlatformContentTutorials)(this, request);
|
|
12
|
+
}
|
|
13
|
+
search(request) {
|
|
14
|
+
return (0, v1_js_1.searchPlatformContentTutorials)(this, request);
|
|
15
|
+
}
|
|
16
|
+
fetch(tutorialId) {
|
|
17
|
+
return (0, v1_js_1.fetchPlatformContentTutorial)(this, tutorialId);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.PlatformContentTutorialClient = PlatformContentTutorialClient;
|
|
21
|
+
exports.default = PlatformContentTutorialClient;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export class PlatformContentTutorialClient extends ChatBotKitClient {
|
|
2
|
+
list(request?: import("./v1.js").PlatformContentTutorialListRequest): ResponsePromise<import("./v1.js").PlatformContentTutorialListResponse, import("./v1.js").PlatformContentTutorialListStreamType>;
|
|
3
|
+
search(request: import("./v1.js").PlatformContentTutorialSearchRequest): Promise<import("./v1.js").PlatformContentTutorialSearchResponse>;
|
|
4
|
+
fetch(tutorialId: string): ResponsePromise<import("./v1.js").PlatformContentTutorialFetchResponse, never>;
|
|
5
|
+
}
|
|
6
|
+
export default PlatformContentTutorialClient;
|
|
7
|
+
export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
|
|
8
|
+
import { ChatBotKitClient } from '../../../client.cjs';
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.listPlatformContentTutorials = listPlatformContentTutorials;
|
|
4
|
+
exports.searchPlatformContentTutorials = searchPlatformContentTutorials;
|
|
5
|
+
exports.fetchPlatformContentTutorial = fetchPlatformContentTutorial;
|
|
6
|
+
function listPlatformContentTutorials(client, request) {
|
|
7
|
+
let url = `/api/v1/platform/content/tutorial/list`;
|
|
8
|
+
const response = client.clientFetch(url, { query: request });
|
|
9
|
+
return response;
|
|
10
|
+
}
|
|
11
|
+
async function searchPlatformContentTutorials(client, request) {
|
|
12
|
+
const url = `/api/v1/platform/content/tutorial/search`;
|
|
13
|
+
const response = await client.clientFetch(url, {
|
|
14
|
+
record: {
|
|
15
|
+
...request,
|
|
16
|
+
},
|
|
17
|
+
});
|
|
18
|
+
return response;
|
|
19
|
+
}
|
|
20
|
+
function fetchPlatformContentTutorial(client, tutorialId) {
|
|
21
|
+
const url = `/api/v1/platform/content/tutorial/${tutorialId}/fetch`;
|
|
22
|
+
const response = client.clientFetch(url, {
|
|
23
|
+
endpoint: '/api/v1/platform/content/tutorial/{tutorialId}/fetch',
|
|
24
|
+
});
|
|
25
|
+
return response;
|
|
26
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export function listPlatformContentTutorials(client: ChatBotKitClient, request?: PlatformContentTutorialListRequest): ResponsePromise<PlatformContentTutorialListResponse, PlatformContentTutorialListStreamType>;
|
|
2
|
+
export function searchPlatformContentTutorials(client: ChatBotKitClient, request: PlatformContentTutorialSearchRequest): Promise<PlatformContentTutorialSearchResponse>;
|
|
3
|
+
export function fetchPlatformContentTutorial(client: ChatBotKitClient, tutorialId: string): ResponsePromise<PlatformContentTutorialFetchResponse, never>;
|
|
4
|
+
export type ChatBotKitClient = import("../../../client.js").ChatBotKitClient;
|
|
5
|
+
export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
|
|
6
|
+
export type PlatformContentTutorialListRequest = {
|
|
7
|
+
cursor?: string;
|
|
8
|
+
order?: "desc" | "asc";
|
|
9
|
+
take?: number;
|
|
10
|
+
meta?: Record<string, string>;
|
|
11
|
+
};
|
|
12
|
+
export type PlatformContentTutorialListResponse = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
|
|
13
|
+
export type PlatformContentTutorialListItem = PlatformContentTutorialListResponse["items"][number];
|
|
14
|
+
export type PlatformContentTutorialListStreamType = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/jsonl"];
|
|
15
|
+
export type PlatformContentTutorialSearchRequestBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["requestBody"]["content"]["application/json"];
|
|
16
|
+
export type PlatformContentTutorialSearchRequest = PlatformContentTutorialSearchRequestBody;
|
|
17
|
+
export type PlatformContentTutorialSearchResponseBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
|
|
18
|
+
export type PlatformContentTutorialSearchResponse = PlatformContentTutorialSearchResponseBody;
|
|
19
|
+
export type PlatformContentTutorialFetchResponse = import("../../../types/api/v1.js").operations["fetchPlatformContentTutorial"]["responses"]["200"]["content"]["application/json"];
|
|
@@ -7,11 +7,11 @@ class ReportClient extends client_js_1.ChatBotKitClient {
|
|
|
7
7
|
constructor(options) {
|
|
8
8
|
super(options);
|
|
9
9
|
}
|
|
10
|
-
|
|
11
|
-
return (0, v1_js_1.
|
|
10
|
+
generate(reportId, request) {
|
|
11
|
+
return (0, v1_js_1.generateReport)(this, reportId, request);
|
|
12
12
|
}
|
|
13
|
-
|
|
14
|
-
return (0, v1_js_1.
|
|
13
|
+
generateTyped(reportId, request) {
|
|
14
|
+
return (0, v1_js_1.generateTypedReport)(this, reportId, request);
|
|
15
15
|
}
|
|
16
16
|
}
|
|
17
17
|
exports.ReportClient = ReportClient;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export class ReportClient extends ChatBotKitClient {
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
generate(reportId: string, request: import("./v1.js").ReportGenerateRequest): Promise<import("./v1.js").ReportGenerateResponse>;
|
|
3
|
+
generateTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
|
|
4
4
|
}
|
|
5
5
|
export default ReportClient;
|
|
6
6
|
import { ChatBotKitClient } from '../client.cjs';
|
package/dist/cjs/report/v1.cjs
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
4
|
-
exports.
|
|
5
|
-
async function
|
|
6
|
-
const url = `/api/v1/report/${reportId}/
|
|
3
|
+
exports.generateReport = generateReport;
|
|
4
|
+
exports.generateTypedReport = generateTypedReport;
|
|
5
|
+
async function generateReport(client, reportId, request) {
|
|
6
|
+
const url = `/api/v1/report/${reportId}/generate`;
|
|
7
7
|
const response = await client.clientFetch(url, {
|
|
8
8
|
record: {
|
|
9
9
|
...request,
|
|
@@ -11,8 +11,8 @@ async function fetchReport(client, reportId, request) {
|
|
|
11
11
|
});
|
|
12
12
|
return response;
|
|
13
13
|
}
|
|
14
|
-
async function
|
|
15
|
-
const url = `/api/v1/report/${reportId}/
|
|
14
|
+
async function generateTypedReport(client, reportId, request) {
|
|
15
|
+
const url = `/api/v1/report/${reportId}/generate`;
|
|
16
16
|
const response = await client.clientFetch(url, {
|
|
17
17
|
record: {
|
|
18
18
|
...request,
|
package/dist/cjs/report/v1.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
export function
|
|
2
|
-
export function
|
|
1
|
+
export function generateReport(client: ChatBotKitClient, reportId: string, request: ReportGenerateRequest): Promise<ReportGenerateResponse>;
|
|
2
|
+
export function generateTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
|
|
3
3
|
export type ChatBotKitClient = import("../client.js").ChatBotKitClient;
|
|
4
|
-
export type
|
|
5
|
-
export type
|
|
6
|
-
export type
|
|
4
|
+
export type ReportGenerateRequestBody = import("../types/api/v1.js").operations["generateReport"]["requestBody"]["content"]["application/json"];
|
|
5
|
+
export type ReportGenerateRequest = ReportGenerateRequestBody;
|
|
6
|
+
export type ReportGenerateResponse = import("../types/api/v1.js").operations["generateReport"]["responses"]["200"]["content"]["application/json"];
|
|
7
7
|
export type ReportId = import("../types/report.js").ReportId;
|
|
8
8
|
export type ReportInputTypes = import("../types/report.js").ReportInputTypes;
|
|
9
9
|
export type ReportOutputTypes = import("../types/report.js").ReportOutputTypes;
|
|
@@ -38,7 +38,7 @@ export interface paths {
|
|
|
38
38
|
patch?: never;
|
|
39
39
|
trace?: never;
|
|
40
40
|
};
|
|
41
|
-
"/report/{reportId}/
|
|
41
|
+
"/report/{reportId}/generate": {
|
|
42
42
|
parameters: {
|
|
43
43
|
query?: never;
|
|
44
44
|
header?: never;
|
|
@@ -53,7 +53,7 @@ export interface paths {
|
|
|
53
53
|
* parameters.
|
|
54
54
|
*
|
|
55
55
|
*/
|
|
56
|
-
post: operations["
|
|
56
|
+
post: operations["generateReport"];
|
|
57
57
|
delete?: never;
|
|
58
58
|
options?: never;
|
|
59
59
|
head?: never;
|
|
@@ -3412,6 +3412,66 @@ export interface paths {
|
|
|
3412
3412
|
patch?: never;
|
|
3413
3413
|
trace?: never;
|
|
3414
3414
|
};
|
|
3415
|
+
"/platform/content/tutorial/{tutorialId}/fetch": {
|
|
3416
|
+
parameters: {
|
|
3417
|
+
query?: never;
|
|
3418
|
+
header?: never;
|
|
3419
|
+
path?: never;
|
|
3420
|
+
cookie?: never;
|
|
3421
|
+
};
|
|
3422
|
+
/**
|
|
3423
|
+
* Fetch a specific platform tutorial
|
|
3424
|
+
* @description Retrieves the complete content and metadata of a specific tutorial. This
|
|
3425
|
+
* includes the markdown content and all associated frontmatter.
|
|
3426
|
+
*
|
|
3427
|
+
*/
|
|
3428
|
+
get: operations["fetchPlatformContentTutorial"];
|
|
3429
|
+
put?: never;
|
|
3430
|
+
post?: never;
|
|
3431
|
+
delete?: never;
|
|
3432
|
+
options?: never;
|
|
3433
|
+
head?: never;
|
|
3434
|
+
patch?: never;
|
|
3435
|
+
trace?: never;
|
|
3436
|
+
};
|
|
3437
|
+
"/platform/content/tutorial/list": {
|
|
3438
|
+
parameters: {
|
|
3439
|
+
query?: never;
|
|
3440
|
+
header?: never;
|
|
3441
|
+
path?: never;
|
|
3442
|
+
cookie?: never;
|
|
3443
|
+
};
|
|
3444
|
+
/**
|
|
3445
|
+
* Retrieve a list of platform tutorials
|
|
3446
|
+
* @description Returns a list of available tutorials with their metadata.
|
|
3447
|
+
*
|
|
3448
|
+
*/
|
|
3449
|
+
get: operations["listPlatformContentTutorials"];
|
|
3450
|
+
put?: never;
|
|
3451
|
+
post?: never;
|
|
3452
|
+
delete?: never;
|
|
3453
|
+
options?: never;
|
|
3454
|
+
head?: never;
|
|
3455
|
+
patch?: never;
|
|
3456
|
+
trace?: never;
|
|
3457
|
+
};
|
|
3458
|
+
"/platform/content/tutorial/search": {
|
|
3459
|
+
parameters: {
|
|
3460
|
+
query?: never;
|
|
3461
|
+
header?: never;
|
|
3462
|
+
path?: never;
|
|
3463
|
+
cookie?: never;
|
|
3464
|
+
};
|
|
3465
|
+
get?: never;
|
|
3466
|
+
put?: never;
|
|
3467
|
+
/** Search platform tutorials using semantic similarity */
|
|
3468
|
+
post: operations["searchPlatformContentTutorials"];
|
|
3469
|
+
delete?: never;
|
|
3470
|
+
options?: never;
|
|
3471
|
+
head?: never;
|
|
3472
|
+
patch?: never;
|
|
3473
|
+
trace?: never;
|
|
3474
|
+
};
|
|
3415
3475
|
"/platform/example/{exampleId}/clone": {
|
|
3416
3476
|
parameters: {
|
|
3417
3477
|
query?: never;
|
|
@@ -4854,7 +4914,7 @@ export interface operations {
|
|
|
4854
4914
|
};
|
|
4855
4915
|
};
|
|
4856
4916
|
};
|
|
4857
|
-
|
|
4917
|
+
generateReport: {
|
|
4858
4918
|
parameters: {
|
|
4859
4919
|
query?: never;
|
|
4860
4920
|
header?: never;
|
|
@@ -17717,6 +17777,232 @@ export interface operations {
|
|
|
17717
17777
|
};
|
|
17718
17778
|
};
|
|
17719
17779
|
};
|
|
17780
|
+
fetchPlatformContentTutorial: {
|
|
17781
|
+
parameters: {
|
|
17782
|
+
query?: never;
|
|
17783
|
+
header?: never;
|
|
17784
|
+
path: {
|
|
17785
|
+
tutorialId: string;
|
|
17786
|
+
};
|
|
17787
|
+
cookie?: never;
|
|
17788
|
+
};
|
|
17789
|
+
requestBody?: never;
|
|
17790
|
+
responses: {
|
|
17791
|
+
/** @description The tutorial was retrieved successfully */
|
|
17792
|
+
200: {
|
|
17793
|
+
headers: {
|
|
17794
|
+
[name: string]: unknown;
|
|
17795
|
+
};
|
|
17796
|
+
content: {
|
|
17797
|
+
"application/json": {
|
|
17798
|
+
/** @description The associated name */
|
|
17799
|
+
name: string;
|
|
17800
|
+
/** @description The associated description */
|
|
17801
|
+
description?: string;
|
|
17802
|
+
/** @description Meta data information */
|
|
17803
|
+
meta?: {
|
|
17804
|
+
[key: string]: unknown;
|
|
17805
|
+
};
|
|
17806
|
+
/** @description The instance ID */
|
|
17807
|
+
id: string;
|
|
17808
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17809
|
+
createdAt: number;
|
|
17810
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17811
|
+
updatedAt: number;
|
|
17812
|
+
/** @description The category of the tutorial */
|
|
17813
|
+
category?: string;
|
|
17814
|
+
/** @description Tags associated with the tutorial */
|
|
17815
|
+
tags?: string[];
|
|
17816
|
+
/** @description The display order index */
|
|
17817
|
+
index?: number;
|
|
17818
|
+
/** @description The markdown content of the tutorial */
|
|
17819
|
+
content: string;
|
|
17820
|
+
/** @description The URL to the official tutorial page */
|
|
17821
|
+
url?: string;
|
|
17822
|
+
};
|
|
17823
|
+
};
|
|
17824
|
+
};
|
|
17825
|
+
/** @description Tutorial not found */
|
|
17826
|
+
404: {
|
|
17827
|
+
headers: {
|
|
17828
|
+
[name: string]: unknown;
|
|
17829
|
+
};
|
|
17830
|
+
content?: never;
|
|
17831
|
+
};
|
|
17832
|
+
/** @description An error response */
|
|
17833
|
+
default: {
|
|
17834
|
+
headers: {
|
|
17835
|
+
[name: string]: unknown;
|
|
17836
|
+
};
|
|
17837
|
+
content: {
|
|
17838
|
+
"application/json": unknown;
|
|
17839
|
+
};
|
|
17840
|
+
};
|
|
17841
|
+
};
|
|
17842
|
+
};
|
|
17843
|
+
listPlatformContentTutorials: {
|
|
17844
|
+
parameters: {
|
|
17845
|
+
query?: {
|
|
17846
|
+
cursor?: string;
|
|
17847
|
+
order?: "asc" | "desc";
|
|
17848
|
+
take?: number;
|
|
17849
|
+
meta?: {
|
|
17850
|
+
[key: string]: string;
|
|
17851
|
+
};
|
|
17852
|
+
};
|
|
17853
|
+
header?: never;
|
|
17854
|
+
path?: never;
|
|
17855
|
+
cookie?: never;
|
|
17856
|
+
};
|
|
17857
|
+
requestBody?: never;
|
|
17858
|
+
responses: {
|
|
17859
|
+
/** @description The list of tutorials was retrieved successfully */
|
|
17860
|
+
200: {
|
|
17861
|
+
headers: {
|
|
17862
|
+
[name: string]: unknown;
|
|
17863
|
+
};
|
|
17864
|
+
content: {
|
|
17865
|
+
"application/json": {
|
|
17866
|
+
items: {
|
|
17867
|
+
/** @description The associated name */
|
|
17868
|
+
name: string;
|
|
17869
|
+
/** @description The associated description */
|
|
17870
|
+
description?: string;
|
|
17871
|
+
/** @description Meta data information */
|
|
17872
|
+
meta?: {
|
|
17873
|
+
[key: string]: unknown;
|
|
17874
|
+
};
|
|
17875
|
+
/** @description The instance ID */
|
|
17876
|
+
id: string;
|
|
17877
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17878
|
+
createdAt: number;
|
|
17879
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17880
|
+
updatedAt: number;
|
|
17881
|
+
/** @description The category of the tutorial */
|
|
17882
|
+
category?: string;
|
|
17883
|
+
/** @description Tags associated with the tutorial */
|
|
17884
|
+
tags?: string[];
|
|
17885
|
+
/** @description The display order index */
|
|
17886
|
+
index?: number;
|
|
17887
|
+
/** @description The URL to the official tutorial page */
|
|
17888
|
+
url?: string;
|
|
17889
|
+
}[];
|
|
17890
|
+
};
|
|
17891
|
+
"application/jsonl": {
|
|
17892
|
+
/**
|
|
17893
|
+
* @description The type of event
|
|
17894
|
+
* @enum {string}
|
|
17895
|
+
*/
|
|
17896
|
+
type: "item";
|
|
17897
|
+
/** @description Instance list properties */
|
|
17898
|
+
data: {
|
|
17899
|
+
/** @description The associated name */
|
|
17900
|
+
name: string;
|
|
17901
|
+
/** @description The associated description */
|
|
17902
|
+
description?: string;
|
|
17903
|
+
/** @description Meta data information */
|
|
17904
|
+
meta?: {
|
|
17905
|
+
[key: string]: unknown;
|
|
17906
|
+
};
|
|
17907
|
+
/** @description The instance ID */
|
|
17908
|
+
id: string;
|
|
17909
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17910
|
+
createdAt: number;
|
|
17911
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17912
|
+
updatedAt: number;
|
|
17913
|
+
/** @description The category of the tutorial */
|
|
17914
|
+
category?: string;
|
|
17915
|
+
/** @description Tags associated with the tutorial */
|
|
17916
|
+
tags?: string[];
|
|
17917
|
+
/** @description The display order index */
|
|
17918
|
+
index?: number;
|
|
17919
|
+
/** @description The URL to the official tutorial page */
|
|
17920
|
+
url?: string;
|
|
17921
|
+
};
|
|
17922
|
+
};
|
|
17923
|
+
};
|
|
17924
|
+
};
|
|
17925
|
+
/** @description An error response */
|
|
17926
|
+
default: {
|
|
17927
|
+
headers: {
|
|
17928
|
+
[name: string]: unknown;
|
|
17929
|
+
};
|
|
17930
|
+
content: {
|
|
17931
|
+
"application/json": unknown;
|
|
17932
|
+
};
|
|
17933
|
+
};
|
|
17934
|
+
};
|
|
17935
|
+
};
|
|
17936
|
+
searchPlatformContentTutorials: {
|
|
17937
|
+
parameters: {
|
|
17938
|
+
query?: never;
|
|
17939
|
+
header?: never;
|
|
17940
|
+
path?: never;
|
|
17941
|
+
cookie?: never;
|
|
17942
|
+
};
|
|
17943
|
+
requestBody: {
|
|
17944
|
+
content: {
|
|
17945
|
+
"application/json": {
|
|
17946
|
+
/** @description The search query to find relevant tutorials */
|
|
17947
|
+
search: string;
|
|
17948
|
+
/**
|
|
17949
|
+
* @description The maximum number of results to return (1-100, default 10)
|
|
17950
|
+
* @default 10
|
|
17951
|
+
*/
|
|
17952
|
+
take?: number;
|
|
17953
|
+
};
|
|
17954
|
+
};
|
|
17955
|
+
};
|
|
17956
|
+
responses: {
|
|
17957
|
+
/** @description The search was successful */
|
|
17958
|
+
200: {
|
|
17959
|
+
headers: {
|
|
17960
|
+
[name: string]: unknown;
|
|
17961
|
+
};
|
|
17962
|
+
content: {
|
|
17963
|
+
"application/json": {
|
|
17964
|
+
items: {
|
|
17965
|
+
/** @description The associated name */
|
|
17966
|
+
name: string;
|
|
17967
|
+
/** @description The associated description */
|
|
17968
|
+
description: string;
|
|
17969
|
+
/** @description Meta data information */
|
|
17970
|
+
meta?: {
|
|
17971
|
+
[key: string]: unknown;
|
|
17972
|
+
};
|
|
17973
|
+
/** @description The instance ID */
|
|
17974
|
+
id: string;
|
|
17975
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17976
|
+
createdAt: number;
|
|
17977
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17978
|
+
updatedAt: number;
|
|
17979
|
+
/** @description The category of the tutorial */
|
|
17980
|
+
category?: string;
|
|
17981
|
+
/** @description Tags associated with the tutorial */
|
|
17982
|
+
tags: string[];
|
|
17983
|
+
/** @description The display order index */
|
|
17984
|
+
index: number;
|
|
17985
|
+
/** @description The similarity score of the search result */
|
|
17986
|
+
score: number;
|
|
17987
|
+
/** @description An excerpt from the most relevant part of the tutorial */
|
|
17988
|
+
excerpt: string;
|
|
17989
|
+
/** @description The URL to the official tutorial page */
|
|
17990
|
+
url: string;
|
|
17991
|
+
}[];
|
|
17992
|
+
};
|
|
17993
|
+
};
|
|
17994
|
+
};
|
|
17995
|
+
/** @description An error response */
|
|
17996
|
+
default: {
|
|
17997
|
+
headers: {
|
|
17998
|
+
[name: string]: unknown;
|
|
17999
|
+
};
|
|
18000
|
+
content: {
|
|
18001
|
+
"application/json": unknown;
|
|
18002
|
+
};
|
|
18003
|
+
};
|
|
18004
|
+
};
|
|
18005
|
+
};
|
|
17720
18006
|
clonePlatformExample: {
|
|
17721
18007
|
parameters: {
|
|
17722
18008
|
query?: never;
|
|
@@ -10,6 +10,7 @@ export type PartnerUserListRequest = {
|
|
|
10
10
|
order?: "desc" | "asc";
|
|
11
11
|
take?: number;
|
|
12
12
|
meta?: Record<string, string>;
|
|
13
|
+
email?: string;
|
|
13
14
|
};
|
|
14
15
|
export type PartnerUserListResponse = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/json"];
|
|
15
16
|
export type PartnerUserListStreamType = import("../../types/api/v1.js").operations["listPartnerUsers"]["responses"]["200"]["content"]["application/jsonl"];
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
export class PlatformContentClient extends ChatBotKitClient {
|
|
2
2
|
doc: PlatformContentDocClient;
|
|
3
3
|
manual: PlatformContentManualClient;
|
|
4
|
+
tutorial: PlatformContentTutorialClient;
|
|
4
5
|
}
|
|
5
6
|
export default PlatformContentClient;
|
|
6
7
|
import { ChatBotKitClient } from '../../client.js';
|
|
7
8
|
import { PlatformContentDocClient } from './doc/index.js';
|
|
8
9
|
import { PlatformContentManualClient } from './manual/index.js';
|
|
10
|
+
import { PlatformContentTutorialClient } from './tutorial/index.js';
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { ChatBotKitClient } from '../../client.js';
|
|
2
2
|
import { PlatformContentDocClient } from './doc/index.js';
|
|
3
3
|
import { PlatformContentManualClient } from './manual/index.js';
|
|
4
|
+
import { PlatformContentTutorialClient } from './tutorial/index.js';
|
|
4
5
|
export class PlatformContentClient extends ChatBotKitClient {
|
|
5
6
|
constructor(options) {
|
|
6
7
|
super(options);
|
|
7
8
|
this.doc = new PlatformContentDocClient(options);
|
|
8
9
|
this.manual = new PlatformContentManualClient(options);
|
|
10
|
+
this.tutorial = new PlatformContentTutorialClient(options);
|
|
9
11
|
}
|
|
10
12
|
}
|
|
11
13
|
export default PlatformContentClient;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export class PlatformContentTutorialClient extends ChatBotKitClient {
|
|
2
|
+
list(request?: import("./v1.js").PlatformContentTutorialListRequest): ResponsePromise<import("./v1.js").PlatformContentTutorialListResponse, import("./v1.js").PlatformContentTutorialListStreamType>;
|
|
3
|
+
search(request: import("./v1.js").PlatformContentTutorialSearchRequest): Promise<import("./v1.js").PlatformContentTutorialSearchResponse>;
|
|
4
|
+
fetch(tutorialId: string): ResponsePromise<import("./v1.js").PlatformContentTutorialFetchResponse, never>;
|
|
5
|
+
}
|
|
6
|
+
export default PlatformContentTutorialClient;
|
|
7
|
+
export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
|
|
8
|
+
import { ChatBotKitClient } from '../../../client.js';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { ChatBotKitClient } from '../../../client.js';
|
|
2
|
+
import { fetchPlatformContentTutorial, listPlatformContentTutorials, searchPlatformContentTutorials, } from './v1.js';
|
|
3
|
+
export class PlatformContentTutorialClient extends ChatBotKitClient {
|
|
4
|
+
constructor(options) {
|
|
5
|
+
super(options);
|
|
6
|
+
}
|
|
7
|
+
list(request) {
|
|
8
|
+
return listPlatformContentTutorials(this, request);
|
|
9
|
+
}
|
|
10
|
+
search(request) {
|
|
11
|
+
return searchPlatformContentTutorials(this, request);
|
|
12
|
+
}
|
|
13
|
+
fetch(tutorialId) {
|
|
14
|
+
return fetchPlatformContentTutorial(this, tutorialId);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
export default PlatformContentTutorialClient;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export function listPlatformContentTutorials(client: ChatBotKitClient, request?: PlatformContentTutorialListRequest): ResponsePromise<PlatformContentTutorialListResponse, PlatformContentTutorialListStreamType>;
|
|
2
|
+
export function searchPlatformContentTutorials(client: ChatBotKitClient, request: PlatformContentTutorialSearchRequest): Promise<PlatformContentTutorialSearchResponse>;
|
|
3
|
+
export function fetchPlatformContentTutorial(client: ChatBotKitClient, tutorialId: string): ResponsePromise<PlatformContentTutorialFetchResponse, never>;
|
|
4
|
+
export type ChatBotKitClient = import("../../../client.js").ChatBotKitClient;
|
|
5
|
+
export type ResponsePromise<T, U> = import("../../../client.js").ResponsePromise<T, U>;
|
|
6
|
+
export type PlatformContentTutorialListRequest = {
|
|
7
|
+
cursor?: string;
|
|
8
|
+
order?: "desc" | "asc";
|
|
9
|
+
take?: number;
|
|
10
|
+
meta?: Record<string, string>;
|
|
11
|
+
};
|
|
12
|
+
export type PlatformContentTutorialListResponse = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
|
|
13
|
+
export type PlatformContentTutorialListItem = PlatformContentTutorialListResponse["items"][number];
|
|
14
|
+
export type PlatformContentTutorialListStreamType = import("../../../types/api/v1.js").operations["listPlatformContentTutorials"]["responses"]["200"]["content"]["application/jsonl"];
|
|
15
|
+
export type PlatformContentTutorialSearchRequestBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["requestBody"]["content"]["application/json"];
|
|
16
|
+
export type PlatformContentTutorialSearchRequest = PlatformContentTutorialSearchRequestBody;
|
|
17
|
+
export type PlatformContentTutorialSearchResponseBody = import("../../../types/api/v1.js").operations["searchPlatformContentTutorials"]["responses"]["200"]["content"]["application/json"];
|
|
18
|
+
export type PlatformContentTutorialSearchResponse = PlatformContentTutorialSearchResponseBody;
|
|
19
|
+
export type PlatformContentTutorialFetchResponse = import("../../../types/api/v1.js").operations["fetchPlatformContentTutorial"]["responses"]["200"]["content"]["application/json"];
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
export function listPlatformContentTutorials(client, request) {
|
|
2
|
+
let url = `/api/v1/platform/content/tutorial/list`;
|
|
3
|
+
const response = client.clientFetch(url, { query: request });
|
|
4
|
+
return response;
|
|
5
|
+
}
|
|
6
|
+
export async function searchPlatformContentTutorials(client, request) {
|
|
7
|
+
const url = `/api/v1/platform/content/tutorial/search`;
|
|
8
|
+
const response = await client.clientFetch(url, {
|
|
9
|
+
record: {
|
|
10
|
+
...request,
|
|
11
|
+
},
|
|
12
|
+
});
|
|
13
|
+
return response;
|
|
14
|
+
}
|
|
15
|
+
export function fetchPlatformContentTutorial(client, tutorialId) {
|
|
16
|
+
const url = `/api/v1/platform/content/tutorial/${tutorialId}/fetch`;
|
|
17
|
+
const response = client.clientFetch(url, {
|
|
18
|
+
endpoint: '/api/v1/platform/content/tutorial/{tutorialId}/fetch',
|
|
19
|
+
});
|
|
20
|
+
return response;
|
|
21
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export class ReportClient extends ChatBotKitClient {
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
generate(reportId: string, request: import("./v1.js").ReportGenerateRequest): Promise<import("./v1.js").ReportGenerateResponse>;
|
|
3
|
+
generateTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
|
|
4
4
|
}
|
|
5
5
|
export default ReportClient;
|
|
6
6
|
import { ChatBotKitClient } from '../client.js';
|
package/dist/esm/report/index.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { ChatBotKitClient } from '../client.js';
|
|
2
|
-
import {
|
|
2
|
+
import { generateReport, generateTypedReport } from './v1.js';
|
|
3
3
|
export class ReportClient extends ChatBotKitClient {
|
|
4
4
|
constructor(options) {
|
|
5
5
|
super(options);
|
|
6
6
|
}
|
|
7
|
-
|
|
8
|
-
return
|
|
7
|
+
generate(reportId, request) {
|
|
8
|
+
return generateReport(this, reportId, request);
|
|
9
9
|
}
|
|
10
|
-
|
|
11
|
-
return
|
|
10
|
+
generateTyped(reportId, request) {
|
|
11
|
+
return generateTypedReport(this, reportId, request);
|
|
12
12
|
}
|
|
13
13
|
}
|
|
14
14
|
export default ReportClient;
|
package/dist/esm/report/v1.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
export function
|
|
2
|
-
export function
|
|
1
|
+
export function generateReport(client: ChatBotKitClient, reportId: string, request: ReportGenerateRequest): Promise<ReportGenerateResponse>;
|
|
2
|
+
export function generateTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
|
|
3
3
|
export type ChatBotKitClient = import("../client.js").ChatBotKitClient;
|
|
4
|
-
export type
|
|
5
|
-
export type
|
|
6
|
-
export type
|
|
4
|
+
export type ReportGenerateRequestBody = import("../types/api/v1.js").operations["generateReport"]["requestBody"]["content"]["application/json"];
|
|
5
|
+
export type ReportGenerateRequest = ReportGenerateRequestBody;
|
|
6
|
+
export type ReportGenerateResponse = import("../types/api/v1.js").operations["generateReport"]["responses"]["200"]["content"]["application/json"];
|
|
7
7
|
export type ReportId = import("../types/report.js").ReportId;
|
|
8
8
|
export type ReportInputTypes = import("../types/report.js").ReportInputTypes;
|
|
9
9
|
export type ReportOutputTypes = import("../types/report.js").ReportOutputTypes;
|
package/dist/esm/report/v1.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export async function
|
|
2
|
-
const url = `/api/v1/report/${reportId}/
|
|
1
|
+
export async function generateReport(client, reportId, request) {
|
|
2
|
+
const url = `/api/v1/report/${reportId}/generate`;
|
|
3
3
|
const response = await client.clientFetch(url, {
|
|
4
4
|
record: {
|
|
5
5
|
...request,
|
|
@@ -7,8 +7,8 @@ export async function fetchReport(client, reportId, request) {
|
|
|
7
7
|
});
|
|
8
8
|
return response;
|
|
9
9
|
}
|
|
10
|
-
export async function
|
|
11
|
-
const url = `/api/v1/report/${reportId}/
|
|
10
|
+
export async function generateTypedReport(client, reportId, request) {
|
|
11
|
+
const url = `/api/v1/report/${reportId}/generate`;
|
|
12
12
|
const response = await client.clientFetch(url, {
|
|
13
13
|
record: {
|
|
14
14
|
...request,
|
|
@@ -38,7 +38,7 @@ export interface paths {
|
|
|
38
38
|
patch?: never;
|
|
39
39
|
trace?: never;
|
|
40
40
|
};
|
|
41
|
-
"/report/{reportId}/
|
|
41
|
+
"/report/{reportId}/generate": {
|
|
42
42
|
parameters: {
|
|
43
43
|
query?: never;
|
|
44
44
|
header?: never;
|
|
@@ -53,7 +53,7 @@ export interface paths {
|
|
|
53
53
|
* parameters.
|
|
54
54
|
*
|
|
55
55
|
*/
|
|
56
|
-
post: operations["
|
|
56
|
+
post: operations["generateReport"];
|
|
57
57
|
delete?: never;
|
|
58
58
|
options?: never;
|
|
59
59
|
head?: never;
|
|
@@ -3412,6 +3412,66 @@ export interface paths {
|
|
|
3412
3412
|
patch?: never;
|
|
3413
3413
|
trace?: never;
|
|
3414
3414
|
};
|
|
3415
|
+
"/platform/content/tutorial/{tutorialId}/fetch": {
|
|
3416
|
+
parameters: {
|
|
3417
|
+
query?: never;
|
|
3418
|
+
header?: never;
|
|
3419
|
+
path?: never;
|
|
3420
|
+
cookie?: never;
|
|
3421
|
+
};
|
|
3422
|
+
/**
|
|
3423
|
+
* Fetch a specific platform tutorial
|
|
3424
|
+
* @description Retrieves the complete content and metadata of a specific tutorial. This
|
|
3425
|
+
* includes the markdown content and all associated frontmatter.
|
|
3426
|
+
*
|
|
3427
|
+
*/
|
|
3428
|
+
get: operations["fetchPlatformContentTutorial"];
|
|
3429
|
+
put?: never;
|
|
3430
|
+
post?: never;
|
|
3431
|
+
delete?: never;
|
|
3432
|
+
options?: never;
|
|
3433
|
+
head?: never;
|
|
3434
|
+
patch?: never;
|
|
3435
|
+
trace?: never;
|
|
3436
|
+
};
|
|
3437
|
+
"/platform/content/tutorial/list": {
|
|
3438
|
+
parameters: {
|
|
3439
|
+
query?: never;
|
|
3440
|
+
header?: never;
|
|
3441
|
+
path?: never;
|
|
3442
|
+
cookie?: never;
|
|
3443
|
+
};
|
|
3444
|
+
/**
|
|
3445
|
+
* Retrieve a list of platform tutorials
|
|
3446
|
+
* @description Returns a list of available tutorials with their metadata.
|
|
3447
|
+
*
|
|
3448
|
+
*/
|
|
3449
|
+
get: operations["listPlatformContentTutorials"];
|
|
3450
|
+
put?: never;
|
|
3451
|
+
post?: never;
|
|
3452
|
+
delete?: never;
|
|
3453
|
+
options?: never;
|
|
3454
|
+
head?: never;
|
|
3455
|
+
patch?: never;
|
|
3456
|
+
trace?: never;
|
|
3457
|
+
};
|
|
3458
|
+
"/platform/content/tutorial/search": {
|
|
3459
|
+
parameters: {
|
|
3460
|
+
query?: never;
|
|
3461
|
+
header?: never;
|
|
3462
|
+
path?: never;
|
|
3463
|
+
cookie?: never;
|
|
3464
|
+
};
|
|
3465
|
+
get?: never;
|
|
3466
|
+
put?: never;
|
|
3467
|
+
/** Search platform tutorials using semantic similarity */
|
|
3468
|
+
post: operations["searchPlatformContentTutorials"];
|
|
3469
|
+
delete?: never;
|
|
3470
|
+
options?: never;
|
|
3471
|
+
head?: never;
|
|
3472
|
+
patch?: never;
|
|
3473
|
+
trace?: never;
|
|
3474
|
+
};
|
|
3415
3475
|
"/platform/example/{exampleId}/clone": {
|
|
3416
3476
|
parameters: {
|
|
3417
3477
|
query?: never;
|
|
@@ -4854,7 +4914,7 @@ export interface operations {
|
|
|
4854
4914
|
};
|
|
4855
4915
|
};
|
|
4856
4916
|
};
|
|
4857
|
-
|
|
4917
|
+
generateReport: {
|
|
4858
4918
|
parameters: {
|
|
4859
4919
|
query?: never;
|
|
4860
4920
|
header?: never;
|
|
@@ -17717,6 +17777,232 @@ export interface operations {
|
|
|
17717
17777
|
};
|
|
17718
17778
|
};
|
|
17719
17779
|
};
|
|
17780
|
+
fetchPlatformContentTutorial: {
|
|
17781
|
+
parameters: {
|
|
17782
|
+
query?: never;
|
|
17783
|
+
header?: never;
|
|
17784
|
+
path: {
|
|
17785
|
+
tutorialId: string;
|
|
17786
|
+
};
|
|
17787
|
+
cookie?: never;
|
|
17788
|
+
};
|
|
17789
|
+
requestBody?: never;
|
|
17790
|
+
responses: {
|
|
17791
|
+
/** @description The tutorial was retrieved successfully */
|
|
17792
|
+
200: {
|
|
17793
|
+
headers: {
|
|
17794
|
+
[name: string]: unknown;
|
|
17795
|
+
};
|
|
17796
|
+
content: {
|
|
17797
|
+
"application/json": {
|
|
17798
|
+
/** @description The associated name */
|
|
17799
|
+
name: string;
|
|
17800
|
+
/** @description The associated description */
|
|
17801
|
+
description?: string;
|
|
17802
|
+
/** @description Meta data information */
|
|
17803
|
+
meta?: {
|
|
17804
|
+
[key: string]: unknown;
|
|
17805
|
+
};
|
|
17806
|
+
/** @description The instance ID */
|
|
17807
|
+
id: string;
|
|
17808
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17809
|
+
createdAt: number;
|
|
17810
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17811
|
+
updatedAt: number;
|
|
17812
|
+
/** @description The category of the tutorial */
|
|
17813
|
+
category?: string;
|
|
17814
|
+
/** @description Tags associated with the tutorial */
|
|
17815
|
+
tags?: string[];
|
|
17816
|
+
/** @description The display order index */
|
|
17817
|
+
index?: number;
|
|
17818
|
+
/** @description The markdown content of the tutorial */
|
|
17819
|
+
content: string;
|
|
17820
|
+
/** @description The URL to the official tutorial page */
|
|
17821
|
+
url?: string;
|
|
17822
|
+
};
|
|
17823
|
+
};
|
|
17824
|
+
};
|
|
17825
|
+
/** @description Tutorial not found */
|
|
17826
|
+
404: {
|
|
17827
|
+
headers: {
|
|
17828
|
+
[name: string]: unknown;
|
|
17829
|
+
};
|
|
17830
|
+
content?: never;
|
|
17831
|
+
};
|
|
17832
|
+
/** @description An error response */
|
|
17833
|
+
default: {
|
|
17834
|
+
headers: {
|
|
17835
|
+
[name: string]: unknown;
|
|
17836
|
+
};
|
|
17837
|
+
content: {
|
|
17838
|
+
"application/json": unknown;
|
|
17839
|
+
};
|
|
17840
|
+
};
|
|
17841
|
+
};
|
|
17842
|
+
};
|
|
17843
|
+
listPlatformContentTutorials: {
|
|
17844
|
+
parameters: {
|
|
17845
|
+
query?: {
|
|
17846
|
+
cursor?: string;
|
|
17847
|
+
order?: "asc" | "desc";
|
|
17848
|
+
take?: number;
|
|
17849
|
+
meta?: {
|
|
17850
|
+
[key: string]: string;
|
|
17851
|
+
};
|
|
17852
|
+
};
|
|
17853
|
+
header?: never;
|
|
17854
|
+
path?: never;
|
|
17855
|
+
cookie?: never;
|
|
17856
|
+
};
|
|
17857
|
+
requestBody?: never;
|
|
17858
|
+
responses: {
|
|
17859
|
+
/** @description The list of tutorials was retrieved successfully */
|
|
17860
|
+
200: {
|
|
17861
|
+
headers: {
|
|
17862
|
+
[name: string]: unknown;
|
|
17863
|
+
};
|
|
17864
|
+
content: {
|
|
17865
|
+
"application/json": {
|
|
17866
|
+
items: {
|
|
17867
|
+
/** @description The associated name */
|
|
17868
|
+
name: string;
|
|
17869
|
+
/** @description The associated description */
|
|
17870
|
+
description?: string;
|
|
17871
|
+
/** @description Meta data information */
|
|
17872
|
+
meta?: {
|
|
17873
|
+
[key: string]: unknown;
|
|
17874
|
+
};
|
|
17875
|
+
/** @description The instance ID */
|
|
17876
|
+
id: string;
|
|
17877
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17878
|
+
createdAt: number;
|
|
17879
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17880
|
+
updatedAt: number;
|
|
17881
|
+
/** @description The category of the tutorial */
|
|
17882
|
+
category?: string;
|
|
17883
|
+
/** @description Tags associated with the tutorial */
|
|
17884
|
+
tags?: string[];
|
|
17885
|
+
/** @description The display order index */
|
|
17886
|
+
index?: number;
|
|
17887
|
+
/** @description The URL to the official tutorial page */
|
|
17888
|
+
url?: string;
|
|
17889
|
+
}[];
|
|
17890
|
+
};
|
|
17891
|
+
"application/jsonl": {
|
|
17892
|
+
/**
|
|
17893
|
+
* @description The type of event
|
|
17894
|
+
* @enum {string}
|
|
17895
|
+
*/
|
|
17896
|
+
type: "item";
|
|
17897
|
+
/** @description Instance list properties */
|
|
17898
|
+
data: {
|
|
17899
|
+
/** @description The associated name */
|
|
17900
|
+
name: string;
|
|
17901
|
+
/** @description The associated description */
|
|
17902
|
+
description?: string;
|
|
17903
|
+
/** @description Meta data information */
|
|
17904
|
+
meta?: {
|
|
17905
|
+
[key: string]: unknown;
|
|
17906
|
+
};
|
|
17907
|
+
/** @description The instance ID */
|
|
17908
|
+
id: string;
|
|
17909
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17910
|
+
createdAt: number;
|
|
17911
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17912
|
+
updatedAt: number;
|
|
17913
|
+
/** @description The category of the tutorial */
|
|
17914
|
+
category?: string;
|
|
17915
|
+
/** @description Tags associated with the tutorial */
|
|
17916
|
+
tags?: string[];
|
|
17917
|
+
/** @description The display order index */
|
|
17918
|
+
index?: number;
|
|
17919
|
+
/** @description The URL to the official tutorial page */
|
|
17920
|
+
url?: string;
|
|
17921
|
+
};
|
|
17922
|
+
};
|
|
17923
|
+
};
|
|
17924
|
+
};
|
|
17925
|
+
/** @description An error response */
|
|
17926
|
+
default: {
|
|
17927
|
+
headers: {
|
|
17928
|
+
[name: string]: unknown;
|
|
17929
|
+
};
|
|
17930
|
+
content: {
|
|
17931
|
+
"application/json": unknown;
|
|
17932
|
+
};
|
|
17933
|
+
};
|
|
17934
|
+
};
|
|
17935
|
+
};
|
|
17936
|
+
searchPlatformContentTutorials: {
|
|
17937
|
+
parameters: {
|
|
17938
|
+
query?: never;
|
|
17939
|
+
header?: never;
|
|
17940
|
+
path?: never;
|
|
17941
|
+
cookie?: never;
|
|
17942
|
+
};
|
|
17943
|
+
requestBody: {
|
|
17944
|
+
content: {
|
|
17945
|
+
"application/json": {
|
|
17946
|
+
/** @description The search query to find relevant tutorials */
|
|
17947
|
+
search: string;
|
|
17948
|
+
/**
|
|
17949
|
+
* @description The maximum number of results to return (1-100, default 10)
|
|
17950
|
+
* @default 10
|
|
17951
|
+
*/
|
|
17952
|
+
take?: number;
|
|
17953
|
+
};
|
|
17954
|
+
};
|
|
17955
|
+
};
|
|
17956
|
+
responses: {
|
|
17957
|
+
/** @description The search was successful */
|
|
17958
|
+
200: {
|
|
17959
|
+
headers: {
|
|
17960
|
+
[name: string]: unknown;
|
|
17961
|
+
};
|
|
17962
|
+
content: {
|
|
17963
|
+
"application/json": {
|
|
17964
|
+
items: {
|
|
17965
|
+
/** @description The associated name */
|
|
17966
|
+
name: string;
|
|
17967
|
+
/** @description The associated description */
|
|
17968
|
+
description: string;
|
|
17969
|
+
/** @description Meta data information */
|
|
17970
|
+
meta?: {
|
|
17971
|
+
[key: string]: unknown;
|
|
17972
|
+
};
|
|
17973
|
+
/** @description The instance ID */
|
|
17974
|
+
id: string;
|
|
17975
|
+
/** @description The timestamp (ms) when the instance was created */
|
|
17976
|
+
createdAt: number;
|
|
17977
|
+
/** @description The timestamp (ms) when the instance was updated */
|
|
17978
|
+
updatedAt: number;
|
|
17979
|
+
/** @description The category of the tutorial */
|
|
17980
|
+
category?: string;
|
|
17981
|
+
/** @description Tags associated with the tutorial */
|
|
17982
|
+
tags: string[];
|
|
17983
|
+
/** @description The display order index */
|
|
17984
|
+
index: number;
|
|
17985
|
+
/** @description The similarity score of the search result */
|
|
17986
|
+
score: number;
|
|
17987
|
+
/** @description An excerpt from the most relevant part of the tutorial */
|
|
17988
|
+
excerpt: string;
|
|
17989
|
+
/** @description The URL to the official tutorial page */
|
|
17990
|
+
url: string;
|
|
17991
|
+
}[];
|
|
17992
|
+
};
|
|
17993
|
+
};
|
|
17994
|
+
};
|
|
17995
|
+
/** @description An error response */
|
|
17996
|
+
default: {
|
|
17997
|
+
headers: {
|
|
17998
|
+
[name: string]: unknown;
|
|
17999
|
+
};
|
|
18000
|
+
content: {
|
|
18001
|
+
"application/json": unknown;
|
|
18002
|
+
};
|
|
18003
|
+
};
|
|
18004
|
+
};
|
|
18005
|
+
};
|
|
17720
18006
|
clonePlatformExample: {
|
|
17721
18007
|
parameters: {
|
|
17722
18008
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chatbotkit/sdk",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.23.0",
|
|
4
4
|
"description": "The fastest way to build advanced AI chat bots",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"engines": {
|
|
@@ -2248,6 +2248,56 @@
|
|
|
2248
2248
|
"default": "./dist/cjs/platform/content/manual/v1.cjs"
|
|
2249
2249
|
}
|
|
2250
2250
|
},
|
|
2251
|
+
"./platform/content/tutorial": {
|
|
2252
|
+
"import": {
|
|
2253
|
+
"types": "./dist/esm/platform/content/tutorial/index.d.ts",
|
|
2254
|
+
"default": "./dist/esm/platform/content/tutorial/index.js"
|
|
2255
|
+
},
|
|
2256
|
+
"require": {
|
|
2257
|
+
"types": "./dist/cjs/platform/content/tutorial/index.d.ts",
|
|
2258
|
+
"default": "./dist/cjs/platform/content/tutorial/index.cjs"
|
|
2259
|
+
}
|
|
2260
|
+
},
|
|
2261
|
+
"./platform/content/tutorial/index": {
|
|
2262
|
+
"import": {
|
|
2263
|
+
"types": "./dist/esm/platform/content/tutorial/index.d.ts",
|
|
2264
|
+
"default": "./dist/esm/platform/content/tutorial/index.js"
|
|
2265
|
+
},
|
|
2266
|
+
"require": {
|
|
2267
|
+
"types": "./dist/cjs/platform/content/tutorial/index.d.ts",
|
|
2268
|
+
"default": "./dist/cjs/platform/content/tutorial/index.cjs"
|
|
2269
|
+
}
|
|
2270
|
+
},
|
|
2271
|
+
"./platform/content/tutorial/index.js": {
|
|
2272
|
+
"import": {
|
|
2273
|
+
"types": "./dist/esm/platform/content/tutorial/index.d.ts",
|
|
2274
|
+
"default": "./dist/esm/platform/content/tutorial/index.js"
|
|
2275
|
+
},
|
|
2276
|
+
"require": {
|
|
2277
|
+
"types": "./dist/cjs/platform/content/tutorial/index.d.ts",
|
|
2278
|
+
"default": "./dist/cjs/platform/content/tutorial/index.cjs"
|
|
2279
|
+
}
|
|
2280
|
+
},
|
|
2281
|
+
"./platform/content/tutorial/v1": {
|
|
2282
|
+
"import": {
|
|
2283
|
+
"types": "./dist/esm/platform/content/tutorial/v1.d.ts",
|
|
2284
|
+
"default": "./dist/esm/platform/content/tutorial/v1.js"
|
|
2285
|
+
},
|
|
2286
|
+
"require": {
|
|
2287
|
+
"types": "./dist/cjs/platform/content/tutorial/v1.d.ts",
|
|
2288
|
+
"default": "./dist/cjs/platform/content/tutorial/v1.cjs"
|
|
2289
|
+
}
|
|
2290
|
+
},
|
|
2291
|
+
"./platform/content/tutorial/v1.js": {
|
|
2292
|
+
"import": {
|
|
2293
|
+
"types": "./dist/esm/platform/content/tutorial/v1.d.ts",
|
|
2294
|
+
"default": "./dist/esm/platform/content/tutorial/v1.js"
|
|
2295
|
+
},
|
|
2296
|
+
"require": {
|
|
2297
|
+
"types": "./dist/cjs/platform/content/tutorial/v1.d.ts",
|
|
2298
|
+
"default": "./dist/cjs/platform/content/tutorial/v1.cjs"
|
|
2299
|
+
}
|
|
2300
|
+
},
|
|
2251
2301
|
"./platform/example": {
|
|
2252
2302
|
"import": {
|
|
2253
2303
|
"types": "./dist/esm/platform/example/index.d.ts",
|
|
@@ -3093,7 +3143,7 @@
|
|
|
3093
3143
|
"types": "./dist/cjs/index.d.ts",
|
|
3094
3144
|
"dependencies": {
|
|
3095
3145
|
"tslib": "^2.6.2",
|
|
3096
|
-
"@chatbotkit/fetch": "1.
|
|
3146
|
+
"@chatbotkit/fetch": "1.23.0"
|
|
3097
3147
|
},
|
|
3098
3148
|
"devDependencies": {
|
|
3099
3149
|
"npm-run-all": "^4.1.5",
|