mavenagi 1.2.7 → 1.2.9
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 +13 -1
- package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +12 -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 +13 -1
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +12 -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/KnowledgeDocumentSearchResponse.d.ts +2 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +2 -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 +17 -17
- 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/KnowledgeDocumentSearchResponse.d.ts +2 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +2 -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
package/Client.js
CHANGED
|
@@ -58,8 +58,8 @@ class MavenAGIClient {
|
|
|
58
58
|
"X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
|
|
59
59
|
"X-Fern-Language": "JavaScript",
|
|
60
60
|
"X-Fern-SDK-Name": "mavenagi",
|
|
61
|
-
"X-Fern-SDK-Version": "1.2.
|
|
62
|
-
"User-Agent": "mavenagi/1.2.
|
|
61
|
+
"X-Fern-SDK-Version": "1.2.9",
|
|
62
|
+
"User-Agent": "mavenagi/1.2.9",
|
|
63
63
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
64
64
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
65
65
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
package/README.md
CHANGED
|
@@ -5,6 +5,26 @@
|
|
|
5
5
|
|
|
6
6
|
The Mavenagi TypeScript library provides convenient access to the Mavenagi APIs from TypeScript.
|
|
7
7
|
|
|
8
|
+
## Table of Contents
|
|
9
|
+
|
|
10
|
+
- [Installation](#installation)
|
|
11
|
+
- [Reference](#reference)
|
|
12
|
+
- [Usage](#usage)
|
|
13
|
+
- [Aborting Requests](#aborting-requests)
|
|
14
|
+
- [Runtime Compatibility](#runtime-compatibility)
|
|
15
|
+
- [Request and Response Types](#request-and-response-types)
|
|
16
|
+
- [Exception Handling](#exception-handling)
|
|
17
|
+
- [Binary Response](#binary-response)
|
|
18
|
+
- [Advanced](#advanced)
|
|
19
|
+
- [Additional Headers](#additional-headers)
|
|
20
|
+
- [Additional Query String Parameters](#additional-query-string-parameters)
|
|
21
|
+
- [Retries](#retries)
|
|
22
|
+
- [Timeouts](#timeouts)
|
|
23
|
+
- [Aborting Requests](#aborting-requests)
|
|
24
|
+
- [Access Raw Response Data](#access-raw-response-data)
|
|
25
|
+
- [Runtime Compatibility](#runtime-compatibility)
|
|
26
|
+
- [Contributing](#contributing)
|
|
27
|
+
|
|
8
28
|
## Installation
|
|
9
29
|
|
|
10
30
|
```sh
|
|
@@ -69,7 +89,7 @@ const client = new MavenAGIClient({
|
|
|
69
89
|
});
|
|
70
90
|
```
|
|
71
91
|
|
|
72
|
-
## Request
|
|
92
|
+
## Request and Response Types
|
|
73
93
|
|
|
74
94
|
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
|
|
75
95
|
following namespace:
|
|
@@ -2,6 +2,17 @@
|
|
|
2
2
|
* All other entityId fields are inferred from the API request.
|
|
3
3
|
*/
|
|
4
4
|
export interface EntityIdBase {
|
|
5
|
-
/**
|
|
5
|
+
/**
|
|
6
|
+
* Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId).
|
|
7
|
+
*
|
|
8
|
+
* Must be less than 192 characters and contain only:
|
|
9
|
+
* - alphanumeric characters (`a-z`, `A-Z`, `0-9`)
|
|
10
|
+
* - hyphens (`-`)
|
|
11
|
+
* - underscores (`_`)
|
|
12
|
+
* - plus signs (`+`)
|
|
13
|
+
* - periods (`.`)
|
|
14
|
+
* - at symbol (`@`)
|
|
15
|
+
* - pipe symbol (`|`)
|
|
16
|
+
*/
|
|
6
17
|
referenceId: string;
|
|
7
18
|
}
|
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
import * as MavenAGI from "../../../index";
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* type: "custom",
|
|
6
|
+
* id: {
|
|
7
|
+
* referenceId: "todo-item-1",
|
|
8
|
+
* appId: "myapp",
|
|
9
|
+
* organizationId: "acme",
|
|
10
|
+
* agentId: "support",
|
|
11
|
+
* type: MavenAGI.EntityType.InboxItem
|
|
12
|
+
* },
|
|
13
|
+
* status: MavenAGI.InboxItemStatus.Open,
|
|
14
|
+
* severity: MavenAGI.InboxItemSeverity.High,
|
|
15
|
+
* createdAt: new Date("2025-01-01T00:00:00.000Z"),
|
|
16
|
+
* updatedAt: new Date("2025-02-01T00:00:00.000Z"),
|
|
17
|
+
* metadata: {
|
|
18
|
+
* "key": "value"
|
|
19
|
+
* }
|
|
20
|
+
* }
|
|
21
|
+
*/
|
|
22
|
+
export type InboxItem = MavenAGI.InboxItem.DuplicateDocuments | MavenAGI.InboxItem.MissingKnowledge | MavenAGI.InboxItem.Custom;
|
|
3
23
|
export declare namespace InboxItem {
|
|
4
24
|
interface DuplicateDocuments extends MavenAGI.InboxItemDuplicateDocuments {
|
|
5
25
|
type: "duplicateDocuments";
|
|
@@ -7,4 +27,7 @@ export declare namespace InboxItem {
|
|
|
7
27
|
interface MissingKnowledge extends MavenAGI.InboxItemMissingKnowledge {
|
|
8
28
|
type: "missingKnowledge";
|
|
9
29
|
}
|
|
30
|
+
interface Custom extends MavenAGI.InboxItemCustom {
|
|
31
|
+
type: "custom";
|
|
32
|
+
}
|
|
10
33
|
}
|
|
@@ -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);
|
|
@@ -56,23 +56,23 @@ export declare class Conversation {
|
|
|
56
56
|
* @example
|
|
57
57
|
* await client.conversation.initialize({
|
|
58
58
|
* conversationId: {
|
|
59
|
-
* referenceId: "
|
|
59
|
+
* referenceId: "x"
|
|
60
60
|
* },
|
|
61
61
|
* messages: [{
|
|
62
62
|
* conversationMessageId: {
|
|
63
|
-
* referenceId: "
|
|
63
|
+
* referenceId: "x"
|
|
64
64
|
* },
|
|
65
65
|
* userId: {
|
|
66
|
-
* referenceId: "
|
|
66
|
+
* referenceId: "x"
|
|
67
67
|
* },
|
|
68
68
|
* text: "text",
|
|
69
69
|
* userMessageType: "USER"
|
|
70
70
|
* }, {
|
|
71
71
|
* conversationMessageId: {
|
|
72
|
-
* referenceId: "
|
|
72
|
+
* referenceId: "x"
|
|
73
73
|
* },
|
|
74
74
|
* userId: {
|
|
75
|
-
* referenceId: "
|
|
75
|
+
* referenceId: "x"
|
|
76
76
|
* },
|
|
77
77
|
* text: "text",
|
|
78
78
|
* userMessageType: "USER"
|
|
@@ -159,19 +159,19 @@ export declare class Conversation {
|
|
|
159
159
|
* @example
|
|
160
160
|
* await client.conversation.appendNewMessages("conversationId", [{
|
|
161
161
|
* conversationMessageId: {
|
|
162
|
-
* referenceId: "
|
|
162
|
+
* referenceId: "x"
|
|
163
163
|
* },
|
|
164
164
|
* userId: {
|
|
165
|
-
* referenceId: "
|
|
165
|
+
* referenceId: "x"
|
|
166
166
|
* },
|
|
167
167
|
* text: "text",
|
|
168
168
|
* userMessageType: "USER"
|
|
169
169
|
* }, {
|
|
170
170
|
* conversationMessageId: {
|
|
171
|
-
* referenceId: "
|
|
171
|
+
* referenceId: "x"
|
|
172
172
|
* },
|
|
173
173
|
* userId: {
|
|
174
|
-
* referenceId: "
|
|
174
|
+
* referenceId: "x"
|
|
175
175
|
* },
|
|
176
176
|
* text: "text",
|
|
177
177
|
* userMessageType: "USER"
|
|
@@ -441,14 +441,14 @@ export declare class Conversation {
|
|
|
441
441
|
* userId: {
|
|
442
442
|
* type: "AGENT",
|
|
443
443
|
* appId: "appId",
|
|
444
|
-
* referenceId: "
|
|
444
|
+
* referenceId: "x"
|
|
445
445
|
* },
|
|
446
446
|
* message: {
|
|
447
447
|
* conversationMessageId: {
|
|
448
|
-
* referenceId: "
|
|
448
|
+
* referenceId: "x"
|
|
449
449
|
* },
|
|
450
450
|
* userId: {
|
|
451
|
-
* referenceId: "
|
|
451
|
+
* referenceId: "x"
|
|
452
452
|
* },
|
|
453
453
|
* text: "text",
|
|
454
454
|
* userMessageType: "USER"
|
|
@@ -75,23 +75,23 @@ class Conversation {
|
|
|
75
75
|
* @example
|
|
76
76
|
* await client.conversation.initialize({
|
|
77
77
|
* conversationId: {
|
|
78
|
-
* referenceId: "
|
|
78
|
+
* referenceId: "x"
|
|
79
79
|
* },
|
|
80
80
|
* messages: [{
|
|
81
81
|
* conversationMessageId: {
|
|
82
|
-
* referenceId: "
|
|
82
|
+
* referenceId: "x"
|
|
83
83
|
* },
|
|
84
84
|
* userId: {
|
|
85
|
-
* referenceId: "
|
|
85
|
+
* referenceId: "x"
|
|
86
86
|
* },
|
|
87
87
|
* text: "text",
|
|
88
88
|
* userMessageType: "USER"
|
|
89
89
|
* }, {
|
|
90
90
|
* conversationMessageId: {
|
|
91
|
-
* referenceId: "
|
|
91
|
+
* referenceId: "x"
|
|
92
92
|
* },
|
|
93
93
|
* userId: {
|
|
94
|
-
* referenceId: "
|
|
94
|
+
* referenceId: "x"
|
|
95
95
|
* },
|
|
96
96
|
* text: "text",
|
|
97
97
|
* userMessageType: "USER"
|
|
@@ -498,19 +498,19 @@ class Conversation {
|
|
|
498
498
|
* @example
|
|
499
499
|
* await client.conversation.appendNewMessages("conversationId", [{
|
|
500
500
|
* conversationMessageId: {
|
|
501
|
-
* referenceId: "
|
|
501
|
+
* referenceId: "x"
|
|
502
502
|
* },
|
|
503
503
|
* userId: {
|
|
504
|
-
* referenceId: "
|
|
504
|
+
* referenceId: "x"
|
|
505
505
|
* },
|
|
506
506
|
* text: "text",
|
|
507
507
|
* userMessageType: "USER"
|
|
508
508
|
* }, {
|
|
509
509
|
* conversationMessageId: {
|
|
510
|
-
* referenceId: "
|
|
510
|
+
* referenceId: "x"
|
|
511
511
|
* },
|
|
512
512
|
* userId: {
|
|
513
|
-
* referenceId: "
|
|
513
|
+
* referenceId: "x"
|
|
514
514
|
* },
|
|
515
515
|
* text: "text",
|
|
516
516
|
* userMessageType: "USER"
|
|
@@ -1750,14 +1750,14 @@ class Conversation {
|
|
|
1750
1750
|
* userId: {
|
|
1751
1751
|
* type: "AGENT",
|
|
1752
1752
|
* appId: "appId",
|
|
1753
|
-
* referenceId: "
|
|
1753
|
+
* referenceId: "x"
|
|
1754
1754
|
* },
|
|
1755
1755
|
* message: {
|
|
1756
1756
|
* conversationMessageId: {
|
|
1757
|
-
* referenceId: "
|
|
1757
|
+
* referenceId: "x"
|
|
1758
1758
|
* },
|
|
1759
1759
|
* userId: {
|
|
1760
|
-
* referenceId: "
|
|
1760
|
+
* referenceId: "x"
|
|
1761
1761
|
* },
|
|
1762
1762
|
* text: "text",
|
|
1763
1763
|
* userMessageType: "USER"
|
|
@@ -50,12 +50,12 @@ export declare class Events {
|
|
|
50
50
|
* await client.events.create({
|
|
51
51
|
* eventType: "userEvent",
|
|
52
52
|
* id: {
|
|
53
|
-
* referenceId: "
|
|
53
|
+
* referenceId: "x"
|
|
54
54
|
* },
|
|
55
55
|
* eventName: "BUTTON_CLICKED",
|
|
56
56
|
* userInfo: {
|
|
57
57
|
* id: {
|
|
58
|
-
* referenceId: "
|
|
58
|
+
* referenceId: "x"
|
|
59
59
|
* }
|
|
60
60
|
* }
|
|
61
61
|
* })
|
|
@@ -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. This asset will be transformed into text and set as the content of the document. The following types are supported: `application/pdf`, `text/plain`. 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. */
|
|
@@ -16,6 +16,13 @@ import * as MavenAGI from "../../../index";
|
|
|
16
16
|
* agentId: "support",
|
|
17
17
|
* type: MavenAGI.EntityType.KnowledgeBaseVersion
|
|
18
18
|
* },
|
|
19
|
+
* knowledgeBaseId: {
|
|
20
|
+
* referenceId: "help-docs",
|
|
21
|
+
* appId: "help-center",
|
|
22
|
+
* organizationId: "acme",
|
|
23
|
+
* agentId: "support",
|
|
24
|
+
* type: MavenAGI.EntityType.KnowledgeBase
|
|
25
|
+
* },
|
|
19
26
|
* content: "## Getting started This is a getting started guide for the help center.",
|
|
20
27
|
* title: "Getting started",
|
|
21
28
|
* metadata: {
|
|
@@ -23,12 +30,17 @@ import * as MavenAGI from "../../../index";
|
|
|
23
30
|
* },
|
|
24
31
|
* createdAt: new Date("2024-01-01T00:00:00.000Z"),
|
|
25
32
|
* updatedAt: new Date("2024-02-02T00:00:00.000Z"),
|
|
26
|
-
* llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
|
|
33
|
+
* llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
|
|
34
|
+
* knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
|
|
27
35
|
* }
|
|
28
36
|
*/
|
|
29
37
|
export interface KnowledgeDocumentResponse extends MavenAGI.KnowledgeDocumentSearchResponse {
|
|
38
|
+
/** The current processing status of the knowledge document */
|
|
39
|
+
processingStatus?: MavenAGI.KnowledgeDocumentStatus;
|
|
30
40
|
/** The content of the document in markdown format. Not shown directly to users. */
|
|
31
41
|
content: string;
|
|
42
|
+
/** If the document is associated with an asset, this will contain the asset metadata */
|
|
43
|
+
asset?: MavenAGI.AttachmentResponse;
|
|
32
44
|
/** Metadata for the knowledge document. */
|
|
33
45
|
metadata: Record<string, string>;
|
|
34
46
|
}
|
|
@@ -16,8 +16,16 @@ import * as MavenAGI from "../../../index";
|
|
|
16
16
|
* agentId: "support",
|
|
17
17
|
* type: MavenAGI.EntityType.KnowledgeBaseVersion
|
|
18
18
|
* },
|
|
19
|
+
* knowledgeBaseId: {
|
|
20
|
+
* referenceId: "help-docs",
|
|
21
|
+
* appId: "help-center",
|
|
22
|
+
* organizationId: "acme",
|
|
23
|
+
* agentId: "support",
|
|
24
|
+
* type: MavenAGI.EntityType.KnowledgeBase
|
|
25
|
+
* },
|
|
19
26
|
* title: "How it works",
|
|
20
27
|
* llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
|
|
28
|
+
* knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus.Never,
|
|
21
29
|
* url: "https://help-center.acme.com/how-it-works",
|
|
22
30
|
* createdAt: new Date("2024-01-01T00:00:00.000Z"),
|
|
23
31
|
* updatedAt: new Date("2024-02-02T00:00:00.000Z")
|
|
@@ -31,10 +39,14 @@ export interface KnowledgeDocumentSearchResponse extends MavenAGI.BaseKnowledgeD
|
|
|
31
39
|
* This may be missing on legacy documents.
|
|
32
40
|
*/
|
|
33
41
|
knowledgeBaseVersionId?: MavenAGI.EntityId;
|
|
42
|
+
/** ID that uniquely identifies the knowledge base that contains this document. */
|
|
43
|
+
knowledgeBaseId: MavenAGI.EntityId;
|
|
34
44
|
/** The title of the document. Will be shown as part of answers. May be missing on legacy documents. */
|
|
35
45
|
title?: string;
|
|
36
46
|
/** Whether the document is included in the agent's knowledge. */
|
|
37
47
|
llmInclusionStatus: MavenAGI.LlmInclusionStatus;
|
|
48
|
+
/** Whether the knowledge base is included in the agent's knowledge. */
|
|
49
|
+
knowledgeBaseLlmInclusionStatus: MavenAGI.LlmInclusionStatus;
|
|
38
50
|
/** The time at which this document was created. */
|
|
39
51
|
createdAt: Date;
|
|
40
52
|
/** The time at which this document was last modified. */
|
|
@@ -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.
|
package/dist/Client.js
CHANGED
|
@@ -58,8 +58,8 @@ class MavenAGIClient {
|
|
|
58
58
|
"X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
|
|
59
59
|
"X-Fern-Language": "JavaScript",
|
|
60
60
|
"X-Fern-SDK-Name": "mavenagi",
|
|
61
|
-
"X-Fern-SDK-Version": "1.2.
|
|
62
|
-
"User-Agent": "mavenagi/1.2.
|
|
61
|
+
"X-Fern-SDK-Version": "1.2.9",
|
|
62
|
+
"User-Agent": "mavenagi/1.2.9",
|
|
63
63
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
64
64
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
65
65
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -2,6 +2,17 @@
|
|
|
2
2
|
* All other entityId fields are inferred from the API request.
|
|
3
3
|
*/
|
|
4
4
|
export interface EntityIdBase {
|
|
5
|
-
/**
|
|
5
|
+
/**
|
|
6
|
+
* Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId).
|
|
7
|
+
*
|
|
8
|
+
* Must be less than 192 characters and contain only:
|
|
9
|
+
* - alphanumeric characters (`a-z`, `A-Z`, `0-9`)
|
|
10
|
+
* - hyphens (`-`)
|
|
11
|
+
* - underscores (`_`)
|
|
12
|
+
* - plus signs (`+`)
|
|
13
|
+
* - periods (`.`)
|
|
14
|
+
* - at symbol (`@`)
|
|
15
|
+
* - pipe symbol (`|`)
|
|
16
|
+
*/
|
|
6
17
|
referenceId: string;
|
|
7
18
|
}
|
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
import * as MavenAGI from "../../../index";
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* type: "custom",
|
|
6
|
+
* id: {
|
|
7
|
+
* referenceId: "todo-item-1",
|
|
8
|
+
* appId: "myapp",
|
|
9
|
+
* organizationId: "acme",
|
|
10
|
+
* agentId: "support",
|
|
11
|
+
* type: MavenAGI.EntityType.InboxItem
|
|
12
|
+
* },
|
|
13
|
+
* status: MavenAGI.InboxItemStatus.Open,
|
|
14
|
+
* severity: MavenAGI.InboxItemSeverity.High,
|
|
15
|
+
* createdAt: new Date("2025-01-01T00:00:00.000Z"),
|
|
16
|
+
* updatedAt: new Date("2025-02-01T00:00:00.000Z"),
|
|
17
|
+
* metadata: {
|
|
18
|
+
* "key": "value"
|
|
19
|
+
* }
|
|
20
|
+
* }
|
|
21
|
+
*/
|
|
22
|
+
export type InboxItem = MavenAGI.InboxItem.DuplicateDocuments | MavenAGI.InboxItem.MissingKnowledge | MavenAGI.InboxItem.Custom;
|
|
3
23
|
export declare namespace InboxItem {
|
|
4
24
|
interface DuplicateDocuments extends MavenAGI.InboxItemDuplicateDocuments {
|
|
5
25
|
type: "duplicateDocuments";
|
|
@@ -7,4 +27,7 @@ export declare namespace InboxItem {
|
|
|
7
27
|
interface MissingKnowledge extends MavenAGI.InboxItemMissingKnowledge {
|
|
8
28
|
type: "missingKnowledge";
|
|
9
29
|
}
|
|
30
|
+
interface Custom extends MavenAGI.InboxItemCustom {
|
|
31
|
+
type: "custom";
|
|
32
|
+
}
|
|
10
33
|
}
|
|
@@ -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);
|
|
@@ -56,23 +56,23 @@ export declare class Conversation {
|
|
|
56
56
|
* @example
|
|
57
57
|
* await client.conversation.initialize({
|
|
58
58
|
* conversationId: {
|
|
59
|
-
* referenceId: "
|
|
59
|
+
* referenceId: "x"
|
|
60
60
|
* },
|
|
61
61
|
* messages: [{
|
|
62
62
|
* conversationMessageId: {
|
|
63
|
-
* referenceId: "
|
|
63
|
+
* referenceId: "x"
|
|
64
64
|
* },
|
|
65
65
|
* userId: {
|
|
66
|
-
* referenceId: "
|
|
66
|
+
* referenceId: "x"
|
|
67
67
|
* },
|
|
68
68
|
* text: "text",
|
|
69
69
|
* userMessageType: "USER"
|
|
70
70
|
* }, {
|
|
71
71
|
* conversationMessageId: {
|
|
72
|
-
* referenceId: "
|
|
72
|
+
* referenceId: "x"
|
|
73
73
|
* },
|
|
74
74
|
* userId: {
|
|
75
|
-
* referenceId: "
|
|
75
|
+
* referenceId: "x"
|
|
76
76
|
* },
|
|
77
77
|
* text: "text",
|
|
78
78
|
* userMessageType: "USER"
|
|
@@ -159,19 +159,19 @@ export declare class Conversation {
|
|
|
159
159
|
* @example
|
|
160
160
|
* await client.conversation.appendNewMessages("conversationId", [{
|
|
161
161
|
* conversationMessageId: {
|
|
162
|
-
* referenceId: "
|
|
162
|
+
* referenceId: "x"
|
|
163
163
|
* },
|
|
164
164
|
* userId: {
|
|
165
|
-
* referenceId: "
|
|
165
|
+
* referenceId: "x"
|
|
166
166
|
* },
|
|
167
167
|
* text: "text",
|
|
168
168
|
* userMessageType: "USER"
|
|
169
169
|
* }, {
|
|
170
170
|
* conversationMessageId: {
|
|
171
|
-
* referenceId: "
|
|
171
|
+
* referenceId: "x"
|
|
172
172
|
* },
|
|
173
173
|
* userId: {
|
|
174
|
-
* referenceId: "
|
|
174
|
+
* referenceId: "x"
|
|
175
175
|
* },
|
|
176
176
|
* text: "text",
|
|
177
177
|
* userMessageType: "USER"
|
|
@@ -441,14 +441,14 @@ export declare class Conversation {
|
|
|
441
441
|
* userId: {
|
|
442
442
|
* type: "AGENT",
|
|
443
443
|
* appId: "appId",
|
|
444
|
-
* referenceId: "
|
|
444
|
+
* referenceId: "x"
|
|
445
445
|
* },
|
|
446
446
|
* message: {
|
|
447
447
|
* conversationMessageId: {
|
|
448
|
-
* referenceId: "
|
|
448
|
+
* referenceId: "x"
|
|
449
449
|
* },
|
|
450
450
|
* userId: {
|
|
451
|
-
* referenceId: "
|
|
451
|
+
* referenceId: "x"
|
|
452
452
|
* },
|
|
453
453
|
* text: "text",
|
|
454
454
|
* userMessageType: "USER"
|