mavenagi 1.2.4 → 1.2.5

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.
Files changed (167) hide show
  1. package/Client.js +2 -2
  2. package/README.md +390 -0
  3. package/api/resources/actions/client/Client.d.ts +11 -1
  4. package/api/resources/actions/client/Client.js +11 -1
  5. package/api/resources/actions/client/requests/ActionPatchRequest.d.ts +11 -1
  6. package/api/resources/agents/client/Client.d.ts +2 -2
  7. package/api/resources/agents/client/Client.js +5 -5
  8. package/api/resources/agents/client/index.d.ts +1 -0
  9. package/api/resources/agents/client/index.js +15 -0
  10. package/api/resources/agents/client/requests/AgentPatchRequest.d.ts +27 -0
  11. package/api/resources/agents/client/requests/index.d.ts +1 -0
  12. package/api/resources/agents/client/requests/index.js +2 -0
  13. package/api/resources/agents/types/Agent.d.ts +8 -0
  14. package/api/resources/agents/types/AgentPrompting.d.ts +23 -0
  15. package/api/resources/agents/types/index.d.ts +1 -1
  16. package/api/resources/agents/types/index.js +1 -1
  17. package/api/resources/analytics/types/ConversationBarChartRequest.d.ts +20 -0
  18. package/api/resources/analytics/types/ConversationDateHistogramRequest.d.ts +13 -1
  19. package/api/resources/analytics/types/ConversationPieChartRequest.d.ts +13 -1
  20. package/api/resources/commons/types/ActionResponse.d.ts +7 -0
  21. package/api/resources/commons/types/SimulationContext.d.ts +6 -0
  22. package/api/resources/conversation/client/Client.d.ts +18 -1
  23. package/api/resources/conversation/client/Client.js +91 -1
  24. package/api/resources/events/client/Client.d.ts +10 -0
  25. package/api/resources/events/client/Client.js +83 -0
  26. package/api/resources/index.d.ts +1 -0
  27. package/api/resources/index.js +1 -0
  28. package/api/resources/knowledge/client/Client.d.ts +32 -1
  29. package/api/resources/knowledge/client/Client.js +104 -1
  30. package/api/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts +11 -1
  31. package/api/resources/knowledge/types/BaseKnowledgeDocument.d.ts +0 -2
  32. package/api/resources/knowledge/types/KnowledgeBaseField.d.ts +1 -0
  33. package/api/resources/knowledge/types/KnowledgeBaseField.js +1 -0
  34. package/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +5 -0
  35. package/api/resources/knowledge/types/KnowledgeBaseRefreshRequest.d.ts +10 -0
  36. package/api/resources/knowledge/types/KnowledgeBaseRefreshRequest.js +3 -0
  37. package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +29 -1
  38. package/api/resources/knowledge/types/KnowledgeBaseType.d.ts +8 -1
  39. package/api/resources/knowledge/types/KnowledgeBaseType.js +8 -1
  40. package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +2 -0
  41. package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +2 -0
  42. package/api/resources/knowledge/types/index.d.ts +1 -0
  43. package/api/resources/knowledge/types/index.js +1 -0
  44. package/dist/Client.js +2 -2
  45. package/dist/api/resources/actions/client/Client.d.ts +11 -1
  46. package/dist/api/resources/actions/client/Client.js +11 -1
  47. package/dist/api/resources/actions/client/requests/ActionPatchRequest.d.ts +11 -1
  48. package/dist/api/resources/agents/client/Client.d.ts +2 -2
  49. package/dist/api/resources/agents/client/Client.js +5 -5
  50. package/dist/api/resources/agents/client/index.d.ts +1 -0
  51. package/dist/api/resources/agents/client/index.js +15 -0
  52. package/dist/api/resources/agents/client/requests/AgentPatchRequest.d.ts +27 -0
  53. package/dist/api/resources/agents/client/requests/AgentPatchRequest.js +3 -0
  54. package/dist/api/resources/agents/client/requests/index.d.ts +1 -0
  55. package/dist/api/resources/agents/client/requests/index.js +2 -0
  56. package/dist/api/resources/agents/types/Agent.d.ts +8 -0
  57. package/dist/api/resources/agents/types/AgentPrompting.d.ts +23 -0
  58. package/dist/api/resources/agents/types/AgentPrompting.js +3 -0
  59. package/dist/api/resources/agents/types/index.d.ts +1 -1
  60. package/dist/api/resources/agents/types/index.js +1 -1
  61. package/dist/api/resources/analytics/types/ConversationBarChartRequest.d.ts +20 -0
  62. package/dist/api/resources/analytics/types/ConversationDateHistogramRequest.d.ts +13 -1
  63. package/dist/api/resources/analytics/types/ConversationPieChartRequest.d.ts +13 -1
  64. package/dist/api/resources/commons/types/ActionResponse.d.ts +7 -0
  65. package/dist/api/resources/commons/types/SimulationContext.d.ts +6 -0
  66. package/dist/api/resources/conversation/client/Client.d.ts +18 -1
  67. package/dist/api/resources/conversation/client/Client.js +91 -1
  68. package/dist/api/resources/events/client/Client.d.ts +10 -0
  69. package/dist/api/resources/events/client/Client.js +83 -0
  70. package/dist/api/resources/index.d.ts +1 -0
  71. package/dist/api/resources/index.js +1 -0
  72. package/dist/api/resources/knowledge/client/Client.d.ts +32 -1
  73. package/dist/api/resources/knowledge/client/Client.js +104 -1
  74. package/dist/api/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts +11 -1
  75. package/dist/api/resources/knowledge/types/BaseKnowledgeDocument.d.ts +0 -2
  76. package/dist/api/resources/knowledge/types/KnowledgeBaseField.d.ts +1 -0
  77. package/dist/api/resources/knowledge/types/KnowledgeBaseField.js +1 -0
  78. package/dist/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +5 -0
  79. package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshRequest.d.ts +10 -0
  80. package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshRequest.js +3 -0
  81. package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +29 -1
  82. package/dist/api/resources/knowledge/types/KnowledgeBaseType.d.ts +8 -1
  83. package/dist/api/resources/knowledge/types/KnowledgeBaseType.js +8 -1
  84. package/dist/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +2 -0
  85. package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +2 -0
  86. package/dist/api/resources/knowledge/types/index.d.ts +1 -0
  87. package/dist/api/resources/knowledge/types/index.js +1 -0
  88. package/dist/serialization/resources/agents/client/index.d.ts +1 -0
  89. package/dist/serialization/resources/agents/client/index.js +4 -0
  90. package/dist/serialization/resources/agents/client/requests/AgentPatchRequest.d.ts +21 -0
  91. package/dist/serialization/resources/agents/client/requests/AgentPatchRequest.js +53 -0
  92. package/dist/serialization/resources/agents/client/requests/index.d.ts +1 -0
  93. package/dist/serialization/resources/agents/client/requests/index.js +5 -0
  94. package/dist/serialization/resources/agents/types/Agent.d.ts +3 -0
  95. package/dist/serialization/resources/agents/types/Agent.js +3 -0
  96. package/dist/serialization/resources/agents/types/AgentPrompting.d.ts +14 -0
  97. package/dist/serialization/resources/agents/types/AgentPrompting.js +46 -0
  98. package/dist/serialization/resources/agents/types/index.d.ts +1 -1
  99. package/dist/serialization/resources/agents/types/index.js +1 -1
  100. package/dist/serialization/resources/commons/types/SimulationContext.d.ts +1 -0
  101. package/dist/serialization/resources/commons/types/SimulationContext.js +1 -0
  102. package/dist/serialization/resources/index.d.ts +1 -0
  103. package/dist/serialization/resources/index.js +1 -0
  104. package/dist/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts +0 -1
  105. package/dist/serialization/resources/knowledge/types/BaseKnowledgeDocument.js +0 -1
  106. package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +1 -1
  107. package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.js +1 -1
  108. package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +4 -0
  109. package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +4 -0
  110. package/dist/serialization/resources/knowledge/types/KnowledgeBaseRefreshRequest.d.ts +9 -0
  111. package/dist/serialization/resources/{agents/types/AgentPatchRequest.js → knowledge/types/KnowledgeBaseRefreshRequest.js} +3 -8
  112. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +4 -0
  113. package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +4 -0
  114. package/dist/serialization/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  115. package/dist/serialization/resources/knowledge/types/KnowledgeBaseType.js +1 -1
  116. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +1 -0
  117. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +1 -0
  118. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +1 -0
  119. package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +1 -0
  120. package/dist/serialization/resources/knowledge/types/index.d.ts +1 -0
  121. package/dist/serialization/resources/knowledge/types/index.js +1 -0
  122. package/dist/version.d.ts +1 -1
  123. package/dist/version.js +1 -1
  124. package/package.json +1 -1
  125. package/reference.md +237 -4
  126. package/serialization/resources/agents/client/index.d.ts +1 -0
  127. package/serialization/resources/agents/client/index.js +4 -0
  128. package/serialization/resources/agents/client/requests/AgentPatchRequest.d.ts +21 -0
  129. package/serialization/resources/agents/client/requests/AgentPatchRequest.js +53 -0
  130. package/serialization/resources/agents/client/requests/index.d.ts +1 -0
  131. package/serialization/resources/agents/client/requests/index.js +5 -0
  132. package/serialization/resources/agents/types/Agent.d.ts +3 -0
  133. package/serialization/resources/agents/types/Agent.js +3 -0
  134. package/serialization/resources/agents/types/AgentPrompting.d.ts +14 -0
  135. package/serialization/resources/agents/types/AgentPrompting.js +46 -0
  136. package/serialization/resources/agents/types/index.d.ts +1 -1
  137. package/serialization/resources/agents/types/index.js +1 -1
  138. package/serialization/resources/commons/types/SimulationContext.d.ts +1 -0
  139. package/serialization/resources/commons/types/SimulationContext.js +1 -0
  140. package/serialization/resources/index.d.ts +1 -0
  141. package/serialization/resources/index.js +1 -0
  142. package/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts +0 -1
  143. package/serialization/resources/knowledge/types/BaseKnowledgeDocument.js +0 -1
  144. package/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +1 -1
  145. package/serialization/resources/knowledge/types/KnowledgeBaseField.js +1 -1
  146. package/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +4 -0
  147. package/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +4 -0
  148. package/serialization/resources/knowledge/types/KnowledgeBaseRefreshRequest.d.ts +9 -0
  149. package/serialization/resources/{agents/types/AgentPatchRequest.js → knowledge/types/KnowledgeBaseRefreshRequest.js} +3 -8
  150. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +4 -0
  151. package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +4 -0
  152. package/serialization/resources/knowledge/types/KnowledgeBaseType.d.ts +1 -1
  153. package/serialization/resources/knowledge/types/KnowledgeBaseType.js +1 -1
  154. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.d.ts +1 -0
  155. package/serialization/resources/knowledge/types/KnowledgeDocumentRequest.js +1 -0
  156. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +1 -0
  157. package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +1 -0
  158. package/serialization/resources/knowledge/types/index.d.ts +1 -0
  159. package/serialization/resources/knowledge/types/index.js +1 -0
  160. package/version.d.ts +1 -1
  161. package/version.js +1 -1
  162. package/api/resources/agents/types/AgentPatchRequest.d.ts +0 -11
  163. package/dist/api/resources/agents/types/AgentPatchRequest.d.ts +0 -11
  164. package/dist/serialization/resources/agents/types/AgentPatchRequest.d.ts +0 -14
  165. package/serialization/resources/agents/types/AgentPatchRequest.d.ts +0 -14
  166. /package/api/resources/agents/{types → client/requests}/AgentPatchRequest.js +0 -0
  167. /package/{dist/api/resources/agents/types/AgentPatchRequest.js → api/resources/agents/types/AgentPrompting.js} +0 -0
@@ -4,7 +4,6 @@ import * as core from "../../../../core";
4
4
  export declare const BaseKnowledgeDocument: core.serialization.ObjectSchema<serializers.BaseKnowledgeDocument.Raw, MavenAGI.BaseKnowledgeDocument>;
5
5
  export declare namespace BaseKnowledgeDocument {
6
6
  interface Raw {
7
- title: string;
8
7
  url?: string | null;
9
8
  language?: string | null;
10
9
  createdAt?: string | null;
@@ -37,7 +37,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.BaseKnowledgeDocument = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
39
  exports.BaseKnowledgeDocument = core.serialization.object({
40
- title: core.serialization.string(),
41
40
  url: core.serialization.string().optional(),
42
41
  language: core.serialization.string().optional(),
43
42
  createdAt: core.serialization.date().optional(),
@@ -3,5 +3,5 @@ import * as MavenAGI from "../../../../api/index";
3
3
  import * as core from "../../../../core";
4
4
  export declare const KnowledgeBaseField: core.serialization.Schema<serializers.KnowledgeBaseField.Raw, MavenAGI.KnowledgeBaseField>;
5
5
  export declare namespace KnowledgeBaseField {
6
- type Raw = "Title" | "UpdatedAt";
6
+ type Raw = "Title" | "CreatedAt" | "UpdatedAt";
7
7
  }
@@ -36,4 +36,4 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.KnowledgeBaseField = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
- exports.KnowledgeBaseField = core.serialization.enum_(["Title", "UpdatedAt"]);
39
+ exports.KnowledgeBaseField = core.serialization.enum_(["Title", "CreatedAt", "UpdatedAt"]);
@@ -1,6 +1,8 @@
1
1
  import * as serializers from "../../../index";
2
2
  import * as MavenAGI from "../../../../api/index";
3
3
  import * as core from "../../../../core";
4
+ import { KnowledgeBaseVersionStatus } from "./KnowledgeBaseVersionStatus";
5
+ import { LlmInclusionStatus } from "../../commons/types/LlmInclusionStatus";
4
6
  export declare const KnowledgeBaseFilter: core.serialization.ObjectSchema<serializers.KnowledgeBaseFilter.Raw, MavenAGI.KnowledgeBaseFilter>;
5
7
  export declare namespace KnowledgeBaseFilter {
6
8
  interface Raw {
@@ -9,5 +11,7 @@ export declare namespace KnowledgeBaseFilter {
9
11
  createdAfter?: string | null;
10
12
  createdBefore?: string | null;
11
13
  appIds?: string[] | null;
14
+ mostRecentVersionStatus?: KnowledgeBaseVersionStatus.Raw[] | null;
15
+ llmInclusionStatus?: LlmInclusionStatus.Raw | null;
12
16
  }
13
17
  }
@@ -36,10 +36,14 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.KnowledgeBaseFilter = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
+ const KnowledgeBaseVersionStatus_1 = require("./KnowledgeBaseVersionStatus");
40
+ const LlmInclusionStatus_1 = require("../../commons/types/LlmInclusionStatus");
39
41
  exports.KnowledgeBaseFilter = core.serialization.object({
40
42
  search: core.serialization.string().optional(),
41
43
  title: core.serialization.string().optional(),
42
44
  createdAfter: core.serialization.date().optional(),
43
45
  createdBefore: core.serialization.date().optional(),
44
46
  appIds: core.serialization.list(core.serialization.string()).optional(),
47
+ mostRecentVersionStatus: core.serialization.list(KnowledgeBaseVersionStatus_1.KnowledgeBaseVersionStatus).optional(),
48
+ llmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus.optional(),
45
49
  });
@@ -0,0 +1,9 @@
1
+ import * as serializers from "../../../index";
2
+ import * as MavenAGI from "../../../../api/index";
3
+ import * as core from "../../../../core";
4
+ export declare const KnowledgeBaseRefreshRequest: core.serialization.ObjectSchema<serializers.KnowledgeBaseRefreshRequest.Raw, MavenAGI.KnowledgeBaseRefreshRequest>;
5
+ export declare namespace KnowledgeBaseRefreshRequest {
6
+ interface Raw {
7
+ appId?: string | null;
8
+ }
9
+ }
@@ -34,13 +34,8 @@ var __importStar = (this && this.__importStar) || (function () {
34
34
  };
35
35
  })();
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
- exports.AgentPatchRequest = void 0;
37
+ exports.KnowledgeBaseRefreshRequest = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
- const AgentEnvironment_1 = require("./AgentEnvironment");
40
- const PiiCategory_1 = require("./PiiCategory");
41
- exports.AgentPatchRequest = core.serialization.object({
42
- name: core.serialization.string().optional(),
43
- environment: AgentEnvironment_1.AgentEnvironment.optional(),
44
- defaultTimezone: core.serialization.string().optional(),
45
- enabledPiiCategories: core.serialization.set(PiiCategory_1.PiiCategory).optional(),
39
+ exports.KnowledgeBaseRefreshRequest = core.serialization.object({
40
+ appId: core.serialization.string().optional(),
46
41
  });
@@ -2,6 +2,7 @@ import * as serializers from "../../../index";
2
2
  import * as MavenAGI from "../../../../api/index";
3
3
  import * as core from "../../../../core";
4
4
  import { EntityId } from "../../commons/types/EntityId";
5
+ import { KnowledgeBaseVersionStatus } from "./KnowledgeBaseVersionStatus";
5
6
  import { KnowledgeBaseType } from "./KnowledgeBaseType";
6
7
  import { LlmInclusionStatus } from "../../commons/types/LlmInclusionStatus";
7
8
  import { KnowledgeBaseRefreshFrequency } from "./KnowledgeBaseRefreshFrequency";
@@ -9,8 +10,11 @@ import { KnowledgeBaseProperties } from "./KnowledgeBaseProperties";
9
10
  export declare const KnowledgeBaseResponse: core.serialization.ObjectSchema<serializers.KnowledgeBaseResponse.Raw, MavenAGI.KnowledgeBaseResponse>;
10
11
  export declare namespace KnowledgeBaseResponse {
11
12
  interface Raw extends KnowledgeBaseProperties.Raw {
13
+ createdAt: string;
14
+ updatedAt: string;
12
15
  knowledgeBaseId: EntityId.Raw;
13
16
  activeVersionId?: EntityId.Raw | null;
17
+ mostRecentVersionStatus: KnowledgeBaseVersionStatus.Raw;
14
18
  type: KnowledgeBaseType.Raw;
15
19
  metadata: Record<string, string>;
16
20
  tags: string[];
@@ -37,14 +37,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.KnowledgeBaseResponse = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
39
  const EntityId_1 = require("../../commons/types/EntityId");
40
+ const KnowledgeBaseVersionStatus_1 = require("./KnowledgeBaseVersionStatus");
40
41
  const KnowledgeBaseType_1 = require("./KnowledgeBaseType");
41
42
  const LlmInclusionStatus_1 = require("../../commons/types/LlmInclusionStatus");
42
43
  const KnowledgeBaseRefreshFrequency_1 = require("./KnowledgeBaseRefreshFrequency");
43
44
  const KnowledgeBaseProperties_1 = require("./KnowledgeBaseProperties");
44
45
  exports.KnowledgeBaseResponse = core.serialization
45
46
  .object({
47
+ createdAt: core.serialization.date(),
48
+ updatedAt: core.serialization.date(),
46
49
  knowledgeBaseId: EntityId_1.EntityId,
47
50
  activeVersionId: EntityId_1.EntityId.optional(),
51
+ mostRecentVersionStatus: KnowledgeBaseVersionStatus_1.KnowledgeBaseVersionStatus,
48
52
  type: KnowledgeBaseType_1.KnowledgeBaseType,
49
53
  metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
50
54
  tags: core.serialization.set(core.serialization.string()),
@@ -3,5 +3,5 @@ import * as MavenAGI from "../../../../api/index";
3
3
  import * as core from "../../../../core";
4
4
  export declare const KnowledgeBaseType: core.serialization.Schema<serializers.KnowledgeBaseType.Raw, MavenAGI.KnowledgeBaseType>;
5
5
  export declare namespace KnowledgeBaseType {
6
- type Raw = "API";
6
+ type Raw = "API" | "URL" | "MANUAL" | "RSS" | "LEGACY";
7
7
  }
@@ -36,4 +36,4 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.KnowledgeBaseType = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
- exports.KnowledgeBaseType = core.serialization.enum_(["API"]);
39
+ exports.KnowledgeBaseType = core.serialization.enum_(["API", "URL", "MANUAL", "RSS", "LEGACY"]);
@@ -11,6 +11,7 @@ export declare namespace KnowledgeDocumentRequest {
11
11
  knowledgeDocumentId: EntityIdBase.Raw;
12
12
  versionId?: EntityIdWithoutAgent.Raw | null;
13
13
  contentType: KnowledgeDocumentContentType.Raw;
14
+ title: string;
14
15
  content: string;
15
16
  metadata?: Record<string, string> | null;
16
17
  }
@@ -45,6 +45,7 @@ exports.KnowledgeDocumentRequest = core.serialization
45
45
  knowledgeDocumentId: EntityIdBase_1.EntityIdBase,
46
46
  versionId: EntityIdWithoutAgent_1.EntityIdWithoutAgent.optional(),
47
47
  contentType: KnowledgeDocumentContentType_1.KnowledgeDocumentContentType,
48
+ title: core.serialization.string(),
48
49
  content: core.serialization.string(),
49
50
  metadata: core.serialization.record(core.serialization.string(), core.serialization.string()).optional(),
50
51
  })
@@ -8,5 +8,6 @@ export declare namespace KnowledgeDocumentSearchResponse {
8
8
  interface Raw extends BaseKnowledgeDocument.Raw {
9
9
  knowledgeDocumentId: EntityId.Raw;
10
10
  knowledgeBaseVersionId?: EntityId.Raw | null;
11
+ title?: string | null;
11
12
  }
12
13
  }
@@ -42,5 +42,6 @@ exports.KnowledgeDocumentSearchResponse = core.serialization
42
42
  .object({
43
43
  knowledgeDocumentId: EntityId_1.EntityId,
44
44
  knowledgeBaseVersionId: EntityId_1.EntityId.optional(),
45
+ title: core.serialization.string().optional(),
45
46
  })
46
47
  .extend(BaseKnowledgeDocument_1.BaseKnowledgeDocument);
@@ -24,3 +24,4 @@ export * from "./KnowledgeDocumentSearchRequest";
24
24
  export * from "./KnowledgeDocumentSearchResponse";
25
25
  export * from "./KnowledgeDocumentsResponse";
26
26
  export * from "./KnowledgeBaseVersionsListResponse";
27
+ export * from "./KnowledgeBaseRefreshRequest";
@@ -40,3 +40,4 @@ __exportStar(require("./KnowledgeDocumentSearchRequest"), exports);
40
40
  __exportStar(require("./KnowledgeDocumentSearchResponse"), exports);
41
41
  __exportStar(require("./KnowledgeDocumentsResponse"), exports);
42
42
  __exportStar(require("./KnowledgeBaseVersionsListResponse"), exports);
43
+ __exportStar(require("./KnowledgeBaseRefreshRequest"), exports);
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.4";
1
+ export declare const SDK_VERSION = "1.2.5";
package/dist/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.2.4";
4
+ exports.SDK_VERSION = "1.2.5";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mavenagi",
3
- "version": "1.2.4",
3
+ "version": "1.2.5",
4
4
  "private": false,
5
5
  "repository": "github:mavenagi/mavenagi-node",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -238,7 +238,17 @@ All other fields will overwrite the existing value on the action only if provide
238
238
  <dd>
239
239
 
240
240
  ```typescript
241
- await client.actions.patch("actionReferenceId");
241
+ await client.actions.patch("get-balance", {
242
+ instructions: "Use this action when the user asks about their account balance or remaining credits.",
243
+ llmInclusionStatus: "WHEN_RELEVANT",
244
+ segmentId: {
245
+ referenceId: "premium-users",
246
+ appId: "my-billing-system",
247
+ organizationId: "acme",
248
+ agentId: "support",
249
+ type: "SEGMENT",
250
+ },
251
+ });
242
252
  ```
243
253
 
244
254
  </dd>
@@ -927,7 +937,7 @@ This endpoint requires additional permissions. Contact support to request access
927
937
  <dd>
928
938
 
929
939
  ```typescript
930
- await client.agents.patch("organizationReferenceId", "agentReferenceId", {});
940
+ await client.agents.patch("organizationReferenceId", "agentReferenceId");
931
941
  ```
932
942
 
933
943
  </dd>
@@ -2591,7 +2601,11 @@ await client.conversation.createFeedback({
2591
2601
  <dl>
2592
2602
  <dd>
2593
2603
 
2594
- Submit a filled out action form
2604
+ Submit a filled out action form.
2605
+ Action forms can not be submitted more than once, attempting to do so will result in an error.
2606
+
2607
+ Additionally, form submission is only allowed when the form is the last message in the conversation.
2608
+ Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
2595
2609
 
2596
2610
  </dd>
2597
2611
  </dl>
@@ -2877,6 +2891,74 @@ await client.conversation.search({});
2877
2891
  </dl>
2878
2892
  </details>
2879
2893
 
2894
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">export</a>({ ...params }) -> core.BinaryResponse</code></summary>
2895
+ <dl>
2896
+ <dd>
2897
+
2898
+ #### 📝 Description
2899
+
2900
+ <dl>
2901
+ <dd>
2902
+
2903
+ <dl>
2904
+ <dd>
2905
+
2906
+ Export conversations to a CSV file.
2907
+
2908
+ This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
2909
+
2910
+ For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
2911
+ The CSV format may change over time and should not be relied upon by code consumers.
2912
+
2913
+ </dd>
2914
+ </dl>
2915
+ </dd>
2916
+ </dl>
2917
+
2918
+ #### 🔌 Usage
2919
+
2920
+ <dl>
2921
+ <dd>
2922
+
2923
+ <dl>
2924
+ <dd>
2925
+
2926
+ ```typescript
2927
+ await client.conversation.export({});
2928
+ ```
2929
+
2930
+ </dd>
2931
+ </dl>
2932
+ </dd>
2933
+ </dl>
2934
+
2935
+ #### ⚙️ Parameters
2936
+
2937
+ <dl>
2938
+ <dd>
2939
+
2940
+ <dl>
2941
+ <dd>
2942
+
2943
+ **request:** `MavenAGI.ConversationsSearchRequest`
2944
+
2945
+ </dd>
2946
+ </dl>
2947
+
2948
+ <dl>
2949
+ <dd>
2950
+
2951
+ **requestOptions:** `Conversation.RequestOptions`
2952
+
2953
+ </dd>
2954
+ </dl>
2955
+ </dd>
2956
+ </dl>
2957
+
2958
+ </dd>
2959
+ </dl>
2960
+ </details>
2961
+
2880
2962
  <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">deliverMessage</a>({ ...params }) -> MavenAGI.DeliverMessageResponse</code></summary>
2881
2963
  <dl>
2882
2964
  <dd>
@@ -3173,6 +3255,71 @@ await client.events.get("eventId", {
3173
3255
  </dl>
3174
3256
  </details>
3175
3257
 
3258
+ <details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">export</a>({ ...params }) -> core.BinaryResponse</code></summary>
3259
+ <dl>
3260
+ <dd>
3261
+
3262
+ #### 📝 Description
3263
+
3264
+ <dl>
3265
+ <dd>
3266
+
3267
+ <dl>
3268
+ <dd>
3269
+
3270
+ Export events to a CSV file.
3271
+
3272
+ This will output a summary of each event that matches the supplied filter. A maximum of 10,000 events can be exported at a time. For most use cases it is recommended to use the search API instead and convert the JSON response to your desired format. The CSV format may change over time and should not be relied upon by code consumers.
3273
+
3274
+ </dd>
3275
+ </dl>
3276
+ </dd>
3277
+ </dl>
3278
+
3279
+ #### 🔌 Usage
3280
+
3281
+ <dl>
3282
+ <dd>
3283
+
3284
+ <dl>
3285
+ <dd>
3286
+
3287
+ ```typescript
3288
+ await client.events.export({});
3289
+ ```
3290
+
3291
+ </dd>
3292
+ </dl>
3293
+ </dd>
3294
+ </dl>
3295
+
3296
+ #### ⚙️ Parameters
3297
+
3298
+ <dl>
3299
+ <dd>
3300
+
3301
+ <dl>
3302
+ <dd>
3303
+
3304
+ **request:** `MavenAGI.EventsSearchRequest`
3305
+
3306
+ </dd>
3307
+ </dl>
3308
+
3309
+ <dl>
3310
+ <dd>
3311
+
3312
+ **requestOptions:** `Events.RequestOptions`
3313
+
3314
+ </dd>
3315
+ </dl>
3316
+ </dd>
3317
+ </dl>
3318
+
3319
+ </dd>
3320
+ </dl>
3321
+ </details>
3322
+
3176
3323
  ## Inbox
3177
3324
 
3178
3325
  <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
@@ -3735,6 +3882,82 @@ await client.knowledge.getKnowledgeBase("help-center");
3735
3882
  </dl>
3736
3883
  </details>
3737
3884
 
3885
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">refreshKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> void</code></summary>
3886
+ <dl>
3887
+ <dd>
3888
+
3889
+ #### 📝 Description
3890
+
3891
+ <dl>
3892
+ <dd>
3893
+
3894
+ <dl>
3895
+ <dd>
3896
+
3897
+ Request that a knowledge base refresh itself.
3898
+
3899
+ Knowledge bases refresh on a schedule determined by the `refreshFrequency` field.
3900
+ They can also be refreshed on demand by calling this endpoint.
3901
+
3902
+ </dd>
3903
+ </dl>
3904
+ </dd>
3905
+ </dl>
3906
+
3907
+ #### 🔌 Usage
3908
+
3909
+ <dl>
3910
+ <dd>
3911
+
3912
+ <dl>
3913
+ <dd>
3914
+
3915
+ ```typescript
3916
+ await client.knowledge.refreshKnowledgeBase("help-center", {
3917
+ appId: "readme",
3918
+ });
3919
+ ```
3920
+
3921
+ </dd>
3922
+ </dl>
3923
+ </dd>
3924
+ </dl>
3925
+
3926
+ #### ⚙️ Parameters
3927
+
3928
+ <dl>
3929
+ <dd>
3930
+
3931
+ <dl>
3932
+ <dd>
3933
+
3934
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to refresh. All other entity ID fields are inferred from the request.
3935
+
3936
+ </dd>
3937
+ </dl>
3938
+
3939
+ <dl>
3940
+ <dd>
3941
+
3942
+ **request:** `MavenAGI.KnowledgeBaseRefreshRequest`
3943
+
3944
+ </dd>
3945
+ </dl>
3946
+
3947
+ <dl>
3948
+ <dd>
3949
+
3950
+ **requestOptions:** `Knowledge.RequestOptions`
3951
+
3952
+ </dd>
3953
+ </dl>
3954
+ </dd>
3955
+ </dl>
3956
+
3957
+ </dd>
3958
+ </dl>
3959
+ </details>
3960
+
3738
3961
  <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">patchKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
3739
3962
  <dl>
3740
3963
  <dd>
@@ -3766,7 +3989,17 @@ All other fields will overwrite the existing value on the knowledge base only if
3766
3989
  <dd>
3767
3990
 
3768
3991
  ```typescript
3769
- await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId");
3992
+ await client.knowledge.patchKnowledgeBase("help-center", {
3993
+ name: "Updated Help Center",
3994
+ tags: new Set(["tag1", "tag2", "tag3"]),
3995
+ segmentId: {
3996
+ referenceId: "premium-users",
3997
+ appId: "readme",
3998
+ organizationId: "acme",
3999
+ agentId: "support",
4000
+ type: "SEGMENT",
4001
+ },
4002
+ });
3770
4003
  ```
3771
4004
 
3772
4005
  </dd>
@@ -1 +1,2 @@
1
1
  export * as list from "./list";
2
+ export * from "./requests";
@@ -32,6 +32,10 @@ var __importStar = (this && this.__importStar) || (function () {
32
32
  return result;
33
33
  };
34
34
  })();
35
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
36
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
37
+ };
35
38
  Object.defineProperty(exports, "__esModule", { value: true });
36
39
  exports.list = void 0;
37
40
  exports.list = __importStar(require("./list"));
41
+ __exportStar(require("./requests"), exports);
@@ -0,0 +1,21 @@
1
+ import * as serializers from "../../../../index";
2
+ import * as MavenAGI from "../../../../../api/index";
3
+ import * as core from "../../../../../core";
4
+ import { AgentEnvironment } from "../../types/AgentEnvironment";
5
+ import { PiiCategory } from "../../types/PiiCategory";
6
+ import { LlmPersona } from "../../../commons/types/LlmPersona";
7
+ export declare const AgentPatchRequest: core.serialization.Schema<serializers.AgentPatchRequest.Raw, MavenAGI.AgentPatchRequest>;
8
+ export declare namespace AgentPatchRequest {
9
+ interface Raw {
10
+ name?: string | null;
11
+ environment?: AgentEnvironment.Raw | null;
12
+ defaultTimezone?: string | null;
13
+ enabledPiiCategories?: PiiCategory.Raw[] | null;
14
+ systemFallbackMessage?: (string | null | undefined) | null;
15
+ persona?: LlmPersona.Raw | null;
16
+ additionalPromptText?: (string | null | undefined) | null;
17
+ categoryGenerationPromptText?: (string | null | undefined) | null;
18
+ contentSafetyViolationResponsePromptText?: (string | null | undefined) | null;
19
+ rejectQuestionsWithoutKnowledge?: boolean | null;
20
+ }
21
+ }
@@ -0,0 +1,53 @@
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.AgentPatchRequest = void 0;
38
+ const core = __importStar(require("../../../../../core"));
39
+ const AgentEnvironment_1 = require("../../types/AgentEnvironment");
40
+ const PiiCategory_1 = require("../../types/PiiCategory");
41
+ const LlmPersona_1 = require("../../../commons/types/LlmPersona");
42
+ exports.AgentPatchRequest = core.serialization.object({
43
+ name: core.serialization.string().optional(),
44
+ environment: AgentEnvironment_1.AgentEnvironment.optional(),
45
+ defaultTimezone: core.serialization.string().optional(),
46
+ enabledPiiCategories: core.serialization.set(PiiCategory_1.PiiCategory).optional(),
47
+ systemFallbackMessage: core.serialization.string().optionalNullable(),
48
+ persona: LlmPersona_1.LlmPersona.optional(),
49
+ additionalPromptText: core.serialization.string().optionalNullable(),
50
+ categoryGenerationPromptText: core.serialization.string().optionalNullable(),
51
+ contentSafetyViolationResponsePromptText: core.serialization.string().optionalNullable(),
52
+ rejectQuestionsWithoutKnowledge: core.serialization.boolean().optional(),
53
+ });
@@ -0,0 +1 @@
1
+ export { AgentPatchRequest } from "./AgentPatchRequest";
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AgentPatchRequest = void 0;
4
+ var AgentPatchRequest_1 = require("./AgentPatchRequest");
5
+ Object.defineProperty(exports, "AgentPatchRequest", { enumerable: true, get: function () { return AgentPatchRequest_1.AgentPatchRequest; } });
@@ -4,6 +4,7 @@ import * as core from "../../../../core";
4
4
  import { EntityId } from "../../commons/types/EntityId";
5
5
  import { AgentEnvironment } from "./AgentEnvironment";
6
6
  import { PiiCategory } from "./PiiCategory";
7
+ import { AgentPrompting } from "./AgentPrompting";
7
8
  export declare const Agent: core.serialization.ObjectSchema<serializers.Agent.Raw, MavenAGI.Agent>;
8
9
  export declare namespace Agent {
9
10
  interface Raw {
@@ -13,5 +14,7 @@ export declare namespace Agent {
13
14
  environment: AgentEnvironment.Raw;
14
15
  defaultTimezone: string;
15
16
  enabledPiiCategories: PiiCategory.Raw[];
17
+ systemFallbackMessage?: string | null;
18
+ prompting: AgentPrompting.Raw;
16
19
  }
17
20
  }
@@ -39,6 +39,7 @@ const core = __importStar(require("../../../../core"));
39
39
  const EntityId_1 = require("../../commons/types/EntityId");
40
40
  const AgentEnvironment_1 = require("./AgentEnvironment");
41
41
  const PiiCategory_1 = require("./PiiCategory");
42
+ const AgentPrompting_1 = require("./AgentPrompting");
42
43
  exports.Agent = core.serialization.object({
43
44
  agentId: EntityId_1.EntityId,
44
45
  name: core.serialization.string(),
@@ -46,4 +47,6 @@ exports.Agent = core.serialization.object({
46
47
  environment: AgentEnvironment_1.AgentEnvironment,
47
48
  defaultTimezone: core.serialization.string(),
48
49
  enabledPiiCategories: core.serialization.set(PiiCategory_1.PiiCategory),
50
+ systemFallbackMessage: core.serialization.string().optional(),
51
+ prompting: AgentPrompting_1.AgentPrompting,
49
52
  });
@@ -0,0 +1,14 @@
1
+ import * as serializers from "../../../index";
2
+ import * as MavenAGI from "../../../../api/index";
3
+ import * as core from "../../../../core";
4
+ import { LlmPersona } from "../../commons/types/LlmPersona";
5
+ export declare const AgentPrompting: core.serialization.ObjectSchema<serializers.AgentPrompting.Raw, MavenAGI.AgentPrompting>;
6
+ export declare namespace AgentPrompting {
7
+ interface Raw {
8
+ persona: LlmPersona.Raw;
9
+ additionalPromptText?: string | null;
10
+ categoryGenerationPromptText?: string | null;
11
+ contentSafetyViolationResponsePromptText?: string | null;
12
+ rejectQuestionsWithoutKnowledge: boolean;
13
+ }
14
+ }