mavenagi 1.2.7 → 1.2.8
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/Client.js +2 -2
- package/README.md +21 -1
- package/api/resources/commons/types/EntityIdBase.d.ts +12 -1
- package/api/resources/commons/types/InboxItem.d.ts +24 -1
- package/api/resources/commons/types/InboxItemCustom.d.ts +5 -0
- package/api/resources/commons/types/InboxItemCustom.js +3 -0
- package/api/resources/commons/types/index.d.ts +1 -0
- package/api/resources/commons/types/index.js +1 -0
- package/api/resources/conversation/client/Client.d.ts +12 -12
- package/api/resources/conversation/client/Client.js +12 -12
- package/api/resources/events/client/Client.d.ts +2 -2
- package/api/resources/events/client/Client.js +2 -2
- package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +5 -2
- package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +4 -0
- package/api/resources/knowledge/types/KnowledgeDocumentStatus.d.ts +6 -0
- package/api/resources/knowledge/types/KnowledgeDocumentStatus.js +9 -0
- package/api/resources/knowledge/types/index.d.ts +1 -0
- package/api/resources/knowledge/types/index.js +1 -0
- package/api/resources/users/types/AgentUserFilter.d.ts +5 -0
- package/dist/Client.js +2 -2
- package/dist/api/resources/commons/types/EntityIdBase.d.ts +12 -1
- package/dist/api/resources/commons/types/InboxItem.d.ts +24 -1
- package/dist/api/resources/commons/types/InboxItemCustom.d.ts +5 -0
- package/dist/api/resources/commons/types/InboxItemCustom.js +3 -0
- package/dist/api/resources/commons/types/index.d.ts +1 -0
- package/dist/api/resources/commons/types/index.js +1 -0
- package/dist/api/resources/conversation/client/Client.d.ts +12 -12
- package/dist/api/resources/conversation/client/Client.js +12 -12
- package/dist/api/resources/events/client/Client.d.ts +2 -2
- package/dist/api/resources/events/client/Client.js +2 -2
- package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +5 -2
- package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +4 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentStatus.d.ts +6 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentStatus.js +9 -0
- package/dist/api/resources/knowledge/types/index.d.ts +1 -0
- package/dist/api/resources/knowledge/types/index.js +1 -0
- package/dist/api/resources/users/types/AgentUserFilter.d.ts +5 -0
- package/dist/serialization/resources/commons/types/InboxItem.d.ts +5 -1
- package/dist/serialization/resources/commons/types/InboxItem.js +2 -0
- package/dist/serialization/resources/commons/types/InboxItemCustom.d.ts +10 -0
- package/dist/serialization/resources/commons/types/InboxItemCustom.js +44 -0
- package/dist/serialization/resources/commons/types/index.d.ts +1 -0
- package/dist/serialization/resources/commons/types/index.js +1 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +2 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +2 -1
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +4 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +4 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentStatus.d.ts +7 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentStatus.js +39 -0
- package/dist/serialization/resources/knowledge/types/index.d.ts +1 -0
- package/dist/serialization/resources/knowledge/types/index.js +1 -0
- package/dist/serialization/resources/users/types/AgentUserFilter.d.ts +1 -0
- package/dist/serialization/resources/users/types/AgentUserFilter.js +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +16 -16
- package/serialization/resources/commons/types/InboxItem.d.ts +5 -1
- package/serialization/resources/commons/types/InboxItem.js +2 -0
- package/serialization/resources/commons/types/InboxItemCustom.d.ts +10 -0
- package/serialization/resources/commons/types/InboxItemCustom.js +44 -0
- package/serialization/resources/commons/types/index.d.ts +1 -0
- package/serialization/resources/commons/types/index.js +1 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +2 -1
- package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +2 -1
- package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.d.ts +4 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentResponse.js +4 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentStatus.d.ts +7 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentStatus.js +39 -0
- package/serialization/resources/knowledge/types/index.d.ts +1 -0
- package/serialization/resources/knowledge/types/index.js +1 -0
- package/serialization/resources/users/types/AgentUserFilter.d.ts +1 -0
- package/serialization/resources/users/types/AgentUserFilter.js +1 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -68,12 +68,12 @@ class Events {
|
|
|
68
68
|
* await client.events.create({
|
|
69
69
|
* eventType: "userEvent",
|
|
70
70
|
* id: {
|
|
71
|
-
* referenceId: "
|
|
71
|
+
* referenceId: "x"
|
|
72
72
|
* },
|
|
73
73
|
* eventName: "BUTTON_CLICKED",
|
|
74
74
|
* userInfo: {
|
|
75
75
|
* id: {
|
|
76
|
-
* referenceId: "
|
|
76
|
+
* referenceId: "x"
|
|
77
77
|
* }
|
|
78
78
|
* }
|
|
79
79
|
* })
|
|
@@ -23,11 +23,14 @@ export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument
|
|
|
23
23
|
knowledgeDocumentId: MavenAGI.EntityIdBase;
|
|
24
24
|
/** ID that uniquely identifies which knowledge base version to create the document in. If not provided will use the most recent version of the knowledge base. */
|
|
25
25
|
versionId?: MavenAGI.EntityIdWithoutAgent;
|
|
26
|
+
/** Type of knowledge document content, if content is provided. This does not need to be set if content is not provided */
|
|
26
27
|
contentType: MavenAGI.KnowledgeDocumentContentType;
|
|
27
28
|
/** The title of the document. Will be shown as part of answers. */
|
|
28
29
|
title: string;
|
|
29
|
-
/**
|
|
30
|
-
|
|
30
|
+
/** ID of the asset associated with this document. Either this or content is required, but not both */
|
|
31
|
+
assetId?: MavenAGI.EntityIdBase;
|
|
32
|
+
/** The content of the document. Not shown directly to users. May be provided in HTML or markdown. HTML will be converted to markdown automatically. Images are not currently supported and will be ignored. Either this or assetId is required, but not both */
|
|
33
|
+
content?: string;
|
|
31
34
|
/** Metadata for the knowledge document. */
|
|
32
35
|
metadata?: Record<string, string>;
|
|
33
36
|
/** The time at which this document was created. */
|
|
@@ -27,8 +27,12 @@ import * as MavenAGI from "../../../index";
|
|
|
27
27
|
* }
|
|
28
28
|
*/
|
|
29
29
|
export interface KnowledgeDocumentResponse extends MavenAGI.KnowledgeDocumentSearchResponse {
|
|
30
|
+
/** The current processing status of the knowledge document */
|
|
31
|
+
processingStatus?: MavenAGI.KnowledgeDocumentStatus;
|
|
30
32
|
/** The content of the document in markdown format. Not shown directly to users. */
|
|
31
33
|
content: string;
|
|
34
|
+
/** If the document is associated with an asset, this will contain the asset metadata */
|
|
35
|
+
asset?: MavenAGI.AttachmentResponse;
|
|
32
36
|
/** Metadata for the knowledge document. */
|
|
33
37
|
metadata: Record<string, string>;
|
|
34
38
|
}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/** The current processing status of the knowledge document */
|
|
2
|
+
export declare const KnowledgeDocumentStatus: {
|
|
3
|
+
readonly Succeeded: "SUCCEEDED";
|
|
4
|
+
readonly InProgress: "IN_PROGRESS";
|
|
5
|
+
};
|
|
6
|
+
export type KnowledgeDocumentStatus = (typeof KnowledgeDocumentStatus)[keyof typeof KnowledgeDocumentStatus];
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.KnowledgeDocumentStatus = void 0;
|
|
5
|
+
/** The current processing status of the knowledge document */
|
|
6
|
+
exports.KnowledgeDocumentStatus = {
|
|
7
|
+
Succeeded: "SUCCEEDED",
|
|
8
|
+
InProgress: "IN_PROGRESS",
|
|
9
|
+
};
|
|
@@ -14,6 +14,7 @@ export * from "./KnowledgeDocumentContentType";
|
|
|
14
14
|
export * from "./KnowledgeDeleteRequest";
|
|
15
15
|
export * from "./KnowledgeDocumentRequest";
|
|
16
16
|
export * from "./KnowledgeDocumentResponse";
|
|
17
|
+
export * from "./KnowledgeDocumentStatus";
|
|
17
18
|
export * from "./KnowledgeBaseField";
|
|
18
19
|
export * from "./KnowledgeDocumentField";
|
|
19
20
|
export * from "./KnowledgeBaseFilter";
|
|
@@ -30,6 +30,7 @@ __exportStar(require("./KnowledgeDocumentContentType"), exports);
|
|
|
30
30
|
__exportStar(require("./KnowledgeDeleteRequest"), exports);
|
|
31
31
|
__exportStar(require("./KnowledgeDocumentRequest"), exports);
|
|
32
32
|
__exportStar(require("./KnowledgeDocumentResponse"), exports);
|
|
33
|
+
__exportStar(require("./KnowledgeDocumentStatus"), exports);
|
|
33
34
|
__exportStar(require("./KnowledgeBaseField"), exports);
|
|
34
35
|
__exportStar(require("./KnowledgeDocumentField"), exports);
|
|
35
36
|
__exportStar(require("./KnowledgeBaseFilter"), exports);
|
|
@@ -6,6 +6,11 @@ export interface AgentUserFilter {
|
|
|
6
6
|
search?: string;
|
|
7
7
|
/** Filter by identifiers */
|
|
8
8
|
identifiers?: string[];
|
|
9
|
+
/**
|
|
10
|
+
* Full-text search query for matching agent users by display name.
|
|
11
|
+
* When you search with this parameter, you're performing a full-text search across the user display names.
|
|
12
|
+
*/
|
|
13
|
+
displayName?: string;
|
|
9
14
|
/**
|
|
10
15
|
* Filter by anonymous users. When true, only anonymous users are returned.
|
|
11
16
|
* When false, only non-anonymous users are returned. An anonymous user is one without any identifiers or name data.
|
|
@@ -3,13 +3,17 @@ import * as MavenAGI from "../../../../api/index";
|
|
|
3
3
|
import * as core from "../../../../core";
|
|
4
4
|
import { InboxItemDuplicateDocuments } from "./InboxItemDuplicateDocuments";
|
|
5
5
|
import { InboxItemMissingKnowledge } from "./InboxItemMissingKnowledge";
|
|
6
|
+
import { InboxItemCustom } from "./InboxItemCustom";
|
|
6
7
|
export declare const InboxItem: core.serialization.Schema<serializers.InboxItem.Raw, MavenAGI.InboxItem>;
|
|
7
8
|
export declare namespace InboxItem {
|
|
8
|
-
type Raw = InboxItem.DuplicateDocuments | InboxItem.MissingKnowledge;
|
|
9
|
+
type Raw = InboxItem.DuplicateDocuments | InboxItem.MissingKnowledge | InboxItem.Custom;
|
|
9
10
|
interface DuplicateDocuments extends InboxItemDuplicateDocuments.Raw {
|
|
10
11
|
type: "duplicateDocuments";
|
|
11
12
|
}
|
|
12
13
|
interface MissingKnowledge extends InboxItemMissingKnowledge.Raw {
|
|
13
14
|
type: "missingKnowledge";
|
|
14
15
|
}
|
|
16
|
+
interface Custom extends InboxItemCustom.Raw {
|
|
17
|
+
type: "custom";
|
|
18
|
+
}
|
|
15
19
|
}
|
|
@@ -38,10 +38,12 @@ exports.InboxItem = void 0;
|
|
|
38
38
|
const core = __importStar(require("../../../../core"));
|
|
39
39
|
const InboxItemDuplicateDocuments_1 = require("./InboxItemDuplicateDocuments");
|
|
40
40
|
const InboxItemMissingKnowledge_1 = require("./InboxItemMissingKnowledge");
|
|
41
|
+
const InboxItemCustom_1 = require("./InboxItemCustom");
|
|
41
42
|
exports.InboxItem = core.serialization
|
|
42
43
|
.union("type", {
|
|
43
44
|
duplicateDocuments: InboxItemDuplicateDocuments_1.InboxItemDuplicateDocuments,
|
|
44
45
|
missingKnowledge: InboxItemMissingKnowledge_1.InboxItemMissingKnowledge,
|
|
46
|
+
custom: InboxItemCustom_1.InboxItemCustom,
|
|
45
47
|
})
|
|
46
48
|
.transform({
|
|
47
49
|
transform: (value) => value,
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as serializers from "../../../index";
|
|
2
|
+
import * as MavenAGI from "../../../../api/index";
|
|
3
|
+
import * as core from "../../../../core";
|
|
4
|
+
import { InboxItemBase } from "./InboxItemBase";
|
|
5
|
+
export declare const InboxItemCustom: core.serialization.ObjectSchema<serializers.InboxItemCustom.Raw, MavenAGI.InboxItemCustom>;
|
|
6
|
+
export declare namespace InboxItemCustom {
|
|
7
|
+
interface Raw extends InboxItemBase.Raw {
|
|
8
|
+
metadata: Record<string, string>;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.InboxItemCustom = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core"));
|
|
39
|
+
const InboxItemBase_1 = require("./InboxItemBase");
|
|
40
|
+
exports.InboxItemCustom = core.serialization
|
|
41
|
+
.object({
|
|
42
|
+
metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
|
|
43
|
+
})
|
|
44
|
+
.extend(InboxItemBase_1.InboxItemBase);
|
|
@@ -125,6 +125,7 @@ export * from "./InboxItemType";
|
|
|
125
125
|
export * from "./InboxItemSeverity";
|
|
126
126
|
export * from "./InboxItem";
|
|
127
127
|
export * from "./InboxItemBase";
|
|
128
|
+
export * from "./InboxItemCustom";
|
|
128
129
|
export * from "./InboxItemDuplicateDocuments";
|
|
129
130
|
export * from "./InboxItemMissingKnowledge";
|
|
130
131
|
export * from "./InboxItemFix";
|
|
@@ -141,6 +141,7 @@ __exportStar(require("./InboxItemType"), exports);
|
|
|
141
141
|
__exportStar(require("./InboxItemSeverity"), exports);
|
|
142
142
|
__exportStar(require("./InboxItem"), exports);
|
|
143
143
|
__exportStar(require("./InboxItemBase"), exports);
|
|
144
|
+
__exportStar(require("./InboxItemCustom"), exports);
|
|
144
145
|
__exportStar(require("./InboxItemDuplicateDocuments"), exports);
|
|
145
146
|
__exportStar(require("./InboxItemMissingKnowledge"), exports);
|
|
146
147
|
__exportStar(require("./InboxItemFix"), exports);
|
|
@@ -12,7 +12,8 @@ export declare namespace KnowledgeDocumentRequest {
|
|
|
12
12
|
versionId?: EntityIdWithoutAgent.Raw | null;
|
|
13
13
|
contentType: KnowledgeDocumentContentType.Raw;
|
|
14
14
|
title: string;
|
|
15
|
-
|
|
15
|
+
assetId?: EntityIdBase.Raw | null;
|
|
16
|
+
content?: string | null;
|
|
16
17
|
metadata?: Record<string, string> | null;
|
|
17
18
|
createdAt?: string | null;
|
|
18
19
|
updatedAt?: string | null;
|
|
@@ -46,7 +46,8 @@ exports.KnowledgeDocumentRequest = core.serialization
|
|
|
46
46
|
versionId: EntityIdWithoutAgent_1.EntityIdWithoutAgent.optional(),
|
|
47
47
|
contentType: KnowledgeDocumentContentType_1.KnowledgeDocumentContentType,
|
|
48
48
|
title: core.serialization.string(),
|
|
49
|
-
|
|
49
|
+
assetId: EntityIdBase_1.EntityIdBase.optional(),
|
|
50
|
+
content: core.serialization.string().optional(),
|
|
50
51
|
metadata: core.serialization.record(core.serialization.string(), core.serialization.string()).optional(),
|
|
51
52
|
createdAt: core.serialization.date().optional(),
|
|
52
53
|
updatedAt: core.serialization.date().optional(),
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import * as serializers from "../../../index";
|
|
2
2
|
import * as MavenAGI from "../../../../api/index";
|
|
3
3
|
import * as core from "../../../../core";
|
|
4
|
+
import { KnowledgeDocumentStatus } from "./KnowledgeDocumentStatus";
|
|
5
|
+
import { AttachmentResponse } from "../../commons/types/AttachmentResponse";
|
|
4
6
|
import { KnowledgeDocumentSearchResponse } from "./KnowledgeDocumentSearchResponse";
|
|
5
7
|
export declare const KnowledgeDocumentResponse: core.serialization.ObjectSchema<serializers.KnowledgeDocumentResponse.Raw, MavenAGI.KnowledgeDocumentResponse>;
|
|
6
8
|
export declare namespace KnowledgeDocumentResponse {
|
|
7
9
|
interface Raw extends KnowledgeDocumentSearchResponse.Raw {
|
|
10
|
+
processingStatus?: KnowledgeDocumentStatus.Raw | null;
|
|
8
11
|
content: string;
|
|
12
|
+
asset?: AttachmentResponse.Raw | null;
|
|
9
13
|
metadata: Record<string, string>;
|
|
10
14
|
}
|
|
11
15
|
}
|
|
@@ -36,10 +36,14 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
37
|
exports.KnowledgeDocumentResponse = void 0;
|
|
38
38
|
const core = __importStar(require("../../../../core"));
|
|
39
|
+
const KnowledgeDocumentStatus_1 = require("./KnowledgeDocumentStatus");
|
|
40
|
+
const AttachmentResponse_1 = require("../../commons/types/AttachmentResponse");
|
|
39
41
|
const KnowledgeDocumentSearchResponse_1 = require("./KnowledgeDocumentSearchResponse");
|
|
40
42
|
exports.KnowledgeDocumentResponse = core.serialization
|
|
41
43
|
.object({
|
|
44
|
+
processingStatus: KnowledgeDocumentStatus_1.KnowledgeDocumentStatus.optional(),
|
|
42
45
|
content: core.serialization.string(),
|
|
46
|
+
asset: AttachmentResponse_1.AttachmentResponse.optional(),
|
|
43
47
|
metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
|
|
44
48
|
})
|
|
45
49
|
.extend(KnowledgeDocumentSearchResponse_1.KnowledgeDocumentSearchResponse);
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import * as serializers from "../../../index";
|
|
2
|
+
import * as MavenAGI from "../../../../api/index";
|
|
3
|
+
import * as core from "../../../../core";
|
|
4
|
+
export declare const KnowledgeDocumentStatus: core.serialization.Schema<serializers.KnowledgeDocumentStatus.Raw, MavenAGI.KnowledgeDocumentStatus>;
|
|
5
|
+
export declare namespace KnowledgeDocumentStatus {
|
|
6
|
+
type Raw = "SUCCEEDED" | "IN_PROGRESS";
|
|
7
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.KnowledgeDocumentStatus = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core"));
|
|
39
|
+
exports.KnowledgeDocumentStatus = core.serialization.enum_(["SUCCEEDED", "IN_PROGRESS"]);
|
|
@@ -14,6 +14,7 @@ export * from "./KnowledgeDocumentContentType";
|
|
|
14
14
|
export * from "./KnowledgeDeleteRequest";
|
|
15
15
|
export * from "./KnowledgeDocumentRequest";
|
|
16
16
|
export * from "./KnowledgeDocumentResponse";
|
|
17
|
+
export * from "./KnowledgeDocumentStatus";
|
|
17
18
|
export * from "./KnowledgeBaseField";
|
|
18
19
|
export * from "./KnowledgeDocumentField";
|
|
19
20
|
export * from "./KnowledgeBaseFilter";
|
|
@@ -30,6 +30,7 @@ __exportStar(require("./KnowledgeDocumentContentType"), exports);
|
|
|
30
30
|
__exportStar(require("./KnowledgeDeleteRequest"), exports);
|
|
31
31
|
__exportStar(require("./KnowledgeDocumentRequest"), exports);
|
|
32
32
|
__exportStar(require("./KnowledgeDocumentResponse"), exports);
|
|
33
|
+
__exportStar(require("./KnowledgeDocumentStatus"), exports);
|
|
33
34
|
__exportStar(require("./KnowledgeBaseField"), exports);
|
|
34
35
|
__exportStar(require("./KnowledgeDocumentField"), exports);
|
|
35
36
|
__exportStar(require("./KnowledgeBaseFilter"), exports);
|
|
@@ -39,5 +39,6 @@ const core = __importStar(require("../../../../core"));
|
|
|
39
39
|
exports.AgentUserFilter = core.serialization.object({
|
|
40
40
|
search: core.serialization.string().optional(),
|
|
41
41
|
identifiers: core.serialization.list(core.serialization.string()).optional(),
|
|
42
|
+
displayName: core.serialization.string().optional(),
|
|
42
43
|
isAnonymous: core.serialization.boolean().optional(),
|
|
43
44
|
});
|
package/dist/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.2.
|
|
1
|
+
export declare const SDK_VERSION = "1.2.8";
|
package/dist/version.js
CHANGED
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1591,25 +1591,25 @@ After initialization,
|
|
|
1591
1591
|
```typescript
|
|
1592
1592
|
await client.conversation.initialize({
|
|
1593
1593
|
conversationId: {
|
|
1594
|
-
referenceId: "
|
|
1594
|
+
referenceId: "x",
|
|
1595
1595
|
},
|
|
1596
1596
|
messages: [
|
|
1597
1597
|
{
|
|
1598
1598
|
conversationMessageId: {
|
|
1599
|
-
referenceId: "
|
|
1599
|
+
referenceId: "x",
|
|
1600
1600
|
},
|
|
1601
1601
|
userId: {
|
|
1602
|
-
referenceId: "
|
|
1602
|
+
referenceId: "x",
|
|
1603
1603
|
},
|
|
1604
1604
|
text: "text",
|
|
1605
1605
|
userMessageType: "USER",
|
|
1606
1606
|
},
|
|
1607
1607
|
{
|
|
1608
1608
|
conversationMessageId: {
|
|
1609
|
-
referenceId: "
|
|
1609
|
+
referenceId: "x",
|
|
1610
1610
|
},
|
|
1611
1611
|
userId: {
|
|
1612
|
-
referenceId: "
|
|
1612
|
+
referenceId: "x",
|
|
1613
1613
|
},
|
|
1614
1614
|
text: "text",
|
|
1615
1615
|
userMessageType: "USER",
|
|
@@ -1910,20 +1910,20 @@ Append messages to an existing conversation. The conversation must be initialize
|
|
|
1910
1910
|
await client.conversation.appendNewMessages("conversationId", [
|
|
1911
1911
|
{
|
|
1912
1912
|
conversationMessageId: {
|
|
1913
|
-
referenceId: "
|
|
1913
|
+
referenceId: "x",
|
|
1914
1914
|
},
|
|
1915
1915
|
userId: {
|
|
1916
|
-
referenceId: "
|
|
1916
|
+
referenceId: "x",
|
|
1917
1917
|
},
|
|
1918
1918
|
text: "text",
|
|
1919
1919
|
userMessageType: "USER",
|
|
1920
1920
|
},
|
|
1921
1921
|
{
|
|
1922
1922
|
conversationMessageId: {
|
|
1923
|
-
referenceId: "
|
|
1923
|
+
referenceId: "x",
|
|
1924
1924
|
},
|
|
1925
1925
|
userId: {
|
|
1926
|
-
referenceId: "
|
|
1926
|
+
referenceId: "x",
|
|
1927
1927
|
},
|
|
1928
1928
|
text: "text",
|
|
1929
1929
|
userMessageType: "USER",
|
|
@@ -2220,10 +2220,10 @@ Known Limitations:
|
|
|
2220
2220
|
const response = await client.conversation.askObjectStream("conversationId", {
|
|
2221
2221
|
schema: "schema",
|
|
2222
2222
|
conversationMessageId: {
|
|
2223
|
-
referenceId: "
|
|
2223
|
+
referenceId: "x",
|
|
2224
2224
|
},
|
|
2225
2225
|
userId: {
|
|
2226
|
-
referenceId: "
|
|
2226
|
+
referenceId: "x",
|
|
2227
2227
|
},
|
|
2228
2228
|
text: "text",
|
|
2229
2229
|
});
|
|
@@ -2820,14 +2820,14 @@ await client.conversation.deliverMessage({
|
|
|
2820
2820
|
userId: {
|
|
2821
2821
|
type: "AGENT",
|
|
2822
2822
|
appId: "appId",
|
|
2823
|
-
referenceId: "
|
|
2823
|
+
referenceId: "x",
|
|
2824
2824
|
},
|
|
2825
2825
|
message: {
|
|
2826
2826
|
conversationMessageId: {
|
|
2827
|
-
referenceId: "
|
|
2827
|
+
referenceId: "x",
|
|
2828
2828
|
},
|
|
2829
2829
|
userId: {
|
|
2830
|
-
referenceId: "
|
|
2830
|
+
referenceId: "x",
|
|
2831
2831
|
},
|
|
2832
2832
|
text: "text",
|
|
2833
2833
|
userMessageType: "USER",
|
|
@@ -2900,12 +2900,12 @@ Create a new event
|
|
|
2900
2900
|
await client.events.create({
|
|
2901
2901
|
eventType: "userEvent",
|
|
2902
2902
|
id: {
|
|
2903
|
-
referenceId: "
|
|
2903
|
+
referenceId: "x",
|
|
2904
2904
|
},
|
|
2905
2905
|
eventName: "BUTTON_CLICKED",
|
|
2906
2906
|
userInfo: {
|
|
2907
2907
|
id: {
|
|
2908
|
-
referenceId: "
|
|
2908
|
+
referenceId: "x",
|
|
2909
2909
|
},
|
|
2910
2910
|
},
|
|
2911
2911
|
});
|
|
@@ -3,13 +3,17 @@ import * as MavenAGI from "../../../../api/index";
|
|
|
3
3
|
import * as core from "../../../../core";
|
|
4
4
|
import { InboxItemDuplicateDocuments } from "./InboxItemDuplicateDocuments";
|
|
5
5
|
import { InboxItemMissingKnowledge } from "./InboxItemMissingKnowledge";
|
|
6
|
+
import { InboxItemCustom } from "./InboxItemCustom";
|
|
6
7
|
export declare const InboxItem: core.serialization.Schema<serializers.InboxItem.Raw, MavenAGI.InboxItem>;
|
|
7
8
|
export declare namespace InboxItem {
|
|
8
|
-
type Raw = InboxItem.DuplicateDocuments | InboxItem.MissingKnowledge;
|
|
9
|
+
type Raw = InboxItem.DuplicateDocuments | InboxItem.MissingKnowledge | InboxItem.Custom;
|
|
9
10
|
interface DuplicateDocuments extends InboxItemDuplicateDocuments.Raw {
|
|
10
11
|
type: "duplicateDocuments";
|
|
11
12
|
}
|
|
12
13
|
interface MissingKnowledge extends InboxItemMissingKnowledge.Raw {
|
|
13
14
|
type: "missingKnowledge";
|
|
14
15
|
}
|
|
16
|
+
interface Custom extends InboxItemCustom.Raw {
|
|
17
|
+
type: "custom";
|
|
18
|
+
}
|
|
15
19
|
}
|
|
@@ -38,10 +38,12 @@ exports.InboxItem = void 0;
|
|
|
38
38
|
const core = __importStar(require("../../../../core"));
|
|
39
39
|
const InboxItemDuplicateDocuments_1 = require("./InboxItemDuplicateDocuments");
|
|
40
40
|
const InboxItemMissingKnowledge_1 = require("./InboxItemMissingKnowledge");
|
|
41
|
+
const InboxItemCustom_1 = require("./InboxItemCustom");
|
|
41
42
|
exports.InboxItem = core.serialization
|
|
42
43
|
.union("type", {
|
|
43
44
|
duplicateDocuments: InboxItemDuplicateDocuments_1.InboxItemDuplicateDocuments,
|
|
44
45
|
missingKnowledge: InboxItemMissingKnowledge_1.InboxItemMissingKnowledge,
|
|
46
|
+
custom: InboxItemCustom_1.InboxItemCustom,
|
|
45
47
|
})
|
|
46
48
|
.transform({
|
|
47
49
|
transform: (value) => value,
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as serializers from "../../../index";
|
|
2
|
+
import * as MavenAGI from "../../../../api/index";
|
|
3
|
+
import * as core from "../../../../core";
|
|
4
|
+
import { InboxItemBase } from "./InboxItemBase";
|
|
5
|
+
export declare const InboxItemCustom: core.serialization.ObjectSchema<serializers.InboxItemCustom.Raw, MavenAGI.InboxItemCustom>;
|
|
6
|
+
export declare namespace InboxItemCustom {
|
|
7
|
+
interface Raw extends InboxItemBase.Raw {
|
|
8
|
+
metadata: Record<string, string>;
|
|
9
|
+
}
|
|
10
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.InboxItemCustom = void 0;
|
|
38
|
+
const core = __importStar(require("../../../../core"));
|
|
39
|
+
const InboxItemBase_1 = require("./InboxItemBase");
|
|
40
|
+
exports.InboxItemCustom = core.serialization
|
|
41
|
+
.object({
|
|
42
|
+
metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
|
|
43
|
+
})
|
|
44
|
+
.extend(InboxItemBase_1.InboxItemBase);
|
|
@@ -125,6 +125,7 @@ export * from "./InboxItemType";
|
|
|
125
125
|
export * from "./InboxItemSeverity";
|
|
126
126
|
export * from "./InboxItem";
|
|
127
127
|
export * from "./InboxItemBase";
|
|
128
|
+
export * from "./InboxItemCustom";
|
|
128
129
|
export * from "./InboxItemDuplicateDocuments";
|
|
129
130
|
export * from "./InboxItemMissingKnowledge";
|
|
130
131
|
export * from "./InboxItemFix";
|
|
@@ -141,6 +141,7 @@ __exportStar(require("./InboxItemType"), exports);
|
|
|
141
141
|
__exportStar(require("./InboxItemSeverity"), exports);
|
|
142
142
|
__exportStar(require("./InboxItem"), exports);
|
|
143
143
|
__exportStar(require("./InboxItemBase"), exports);
|
|
144
|
+
__exportStar(require("./InboxItemCustom"), exports);
|
|
144
145
|
__exportStar(require("./InboxItemDuplicateDocuments"), exports);
|
|
145
146
|
__exportStar(require("./InboxItemMissingKnowledge"), exports);
|
|
146
147
|
__exportStar(require("./InboxItemFix"), exports);
|
|
@@ -12,7 +12,8 @@ export declare namespace KnowledgeDocumentRequest {
|
|
|
12
12
|
versionId?: EntityIdWithoutAgent.Raw | null;
|
|
13
13
|
contentType: KnowledgeDocumentContentType.Raw;
|
|
14
14
|
title: string;
|
|
15
|
-
|
|
15
|
+
assetId?: EntityIdBase.Raw | null;
|
|
16
|
+
content?: string | null;
|
|
16
17
|
metadata?: Record<string, string> | null;
|
|
17
18
|
createdAt?: string | null;
|
|
18
19
|
updatedAt?: string | null;
|
|
@@ -46,7 +46,8 @@ exports.KnowledgeDocumentRequest = core.serialization
|
|
|
46
46
|
versionId: EntityIdWithoutAgent_1.EntityIdWithoutAgent.optional(),
|
|
47
47
|
contentType: KnowledgeDocumentContentType_1.KnowledgeDocumentContentType,
|
|
48
48
|
title: core.serialization.string(),
|
|
49
|
-
|
|
49
|
+
assetId: EntityIdBase_1.EntityIdBase.optional(),
|
|
50
|
+
content: core.serialization.string().optional(),
|
|
50
51
|
metadata: core.serialization.record(core.serialization.string(), core.serialization.string()).optional(),
|
|
51
52
|
createdAt: core.serialization.date().optional(),
|
|
52
53
|
updatedAt: core.serialization.date().optional(),
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import * as serializers from "../../../index";
|
|
2
2
|
import * as MavenAGI from "../../../../api/index";
|
|
3
3
|
import * as core from "../../../../core";
|
|
4
|
+
import { KnowledgeDocumentStatus } from "./KnowledgeDocumentStatus";
|
|
5
|
+
import { AttachmentResponse } from "../../commons/types/AttachmentResponse";
|
|
4
6
|
import { KnowledgeDocumentSearchResponse } from "./KnowledgeDocumentSearchResponse";
|
|
5
7
|
export declare const KnowledgeDocumentResponse: core.serialization.ObjectSchema<serializers.KnowledgeDocumentResponse.Raw, MavenAGI.KnowledgeDocumentResponse>;
|
|
6
8
|
export declare namespace KnowledgeDocumentResponse {
|
|
7
9
|
interface Raw extends KnowledgeDocumentSearchResponse.Raw {
|
|
10
|
+
processingStatus?: KnowledgeDocumentStatus.Raw | null;
|
|
8
11
|
content: string;
|
|
12
|
+
asset?: AttachmentResponse.Raw | null;
|
|
9
13
|
metadata: Record<string, string>;
|
|
10
14
|
}
|
|
11
15
|
}
|
|
@@ -36,10 +36,14 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
37
|
exports.KnowledgeDocumentResponse = void 0;
|
|
38
38
|
const core = __importStar(require("../../../../core"));
|
|
39
|
+
const KnowledgeDocumentStatus_1 = require("./KnowledgeDocumentStatus");
|
|
40
|
+
const AttachmentResponse_1 = require("../../commons/types/AttachmentResponse");
|
|
39
41
|
const KnowledgeDocumentSearchResponse_1 = require("./KnowledgeDocumentSearchResponse");
|
|
40
42
|
exports.KnowledgeDocumentResponse = core.serialization
|
|
41
43
|
.object({
|
|
44
|
+
processingStatus: KnowledgeDocumentStatus_1.KnowledgeDocumentStatus.optional(),
|
|
42
45
|
content: core.serialization.string(),
|
|
46
|
+
asset: AttachmentResponse_1.AttachmentResponse.optional(),
|
|
43
47
|
metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
|
|
44
48
|
})
|
|
45
49
|
.extend(KnowledgeDocumentSearchResponse_1.KnowledgeDocumentSearchResponse);
|