mavenagi 1.2.6 → 1.2.8

package/reference.md

@@ -354,270 +354,6 @@ await client.actions.delete("get-balance");
 </dl>
 </details>
 
-## AgentCapabilities
-
-<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">list</a>({ ...params }) -> MavenAGI.ListAgentCapabilitiesResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-List all capabilities for an agent.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agentCapabilities.list({});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `MavenAGI.AgentCapabilityListRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentCapabilities.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">get</a>(integrationId, capabilityId) -> MavenAGI.AgentCapability</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agentCapabilities.get("integrationId", "capabilityId");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**integrationId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**capabilityId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentCapabilities.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">patch</a>(integrationId, capabilityId, { ...params }) -> MavenAGI.AgentCapability</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agentCapabilities.patch("integrationId", "capabilityId", {});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**integrationId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**capabilityId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `MavenAGI.PatchAgentCapabilityRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentCapabilities.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">execute</a>(integrationId, capabilityId, { ...params }) -> MavenAGI.ExecuteCapabilityResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Execute an action capability.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.agentCapabilities.execute("integrationId", "capabilityId", {});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**integrationId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**capabilityId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `MavenAGI.ExecuteCapabilityRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `AgentCapabilities.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Agents
 
 <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
@@ -1855,25 +1591,25 @@ After initialization,
 ```typescript
 await client.conversation.initialize({
     conversationId: {
-        referenceId: "referenceId",
+        referenceId: "x",
     },
     messages: [
         {
             conversationMessageId: {
-                referenceId: "referenceId",
+                referenceId: "x",
             },
             userId: {
-                referenceId: "referenceId",
+                referenceId: "x",
             },
             text: "text",
             userMessageType: "USER",
         },
         {
             conversationMessageId: {
-                referenceId: "referenceId",
+                referenceId: "x",
             },
             userId: {
-                referenceId: "referenceId",
+                referenceId: "x",
             },
             text: "text",
             userMessageType: "USER",
@@ -2174,20 +1910,20 @@ Append messages to an existing conversation. The conversation must be initialize
 await client.conversation.appendNewMessages("conversationId", [
     {
         conversationMessageId: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
         userId: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
         text: "text",
         userMessageType: "USER",
     },
     {
         conversationMessageId: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
         userId: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
         text: "text",
         userMessageType: "USER",
@@ -2484,10 +2220,10 @@ Known Limitations:
 const response = await client.conversation.askObjectStream("conversationId", {
     schema: "schema",
     conversationMessageId: {
-        referenceId: "referenceId",
+        referenceId: "x",
     },
     userId: {
-        referenceId: "referenceId",
+        referenceId: "x",
     },
     text: "text",
 });
@@ -3084,14 +2820,14 @@ await client.conversation.deliverMessage({
     userId: {
         type: "AGENT",
         appId: "appId",
-        referenceId: "referenceId",
+        referenceId: "x",
     },
     message: {
         conversationMessageId: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
         userId: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
         text: "text",
         userMessageType: "USER",
@@ -3164,12 +2900,12 @@ Create a new event
 await client.events.create({
     eventType: "userEvent",
     id: {
-        referenceId: "referenceId",
+        referenceId: "x",
     },
     eventName: "BUTTON_CLICKED",
     userInfo: {
         id: {
-            referenceId: "referenceId",
+            referenceId: "x",
         },
     },
 });
@@ -4675,6 +4411,92 @@ await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "
 </dl>
 </details>
 
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">patchKnowledgeDocument</a>(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update mutable knowledge document fields that can be set independently of a knowledge base version.
+
+For any changes in document content see the `createKnowledgeBaseVersion` and `createKnowledgeDocument` endpoints.
+
+The `knowledgeBaseAppId` field can be provided to update a knowledge document in a knowledge base owned by a different app.
+All other fields will overwrite the existing value on the knowledge document only if provided.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.knowledge.patchKnowledgeDocument("help-center", "how-it-works", {
+    llmInclusionStatus: "ALWAYS",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to patch.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to patch.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.KnowledgeDocumentPatchRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Knowledge.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Organizations
 
 <details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">create</a>(organizationReferenceId, { ...params }) -> MavenAGI.Organization</code></summary>

package/serialization/resources/commons/types/ConversationSummary.d.ts

@@ -17,6 +17,7 @@ export declare namespace ConversationSummary {
         humanAgents: string[];
         humanAgentsWithInserts: string[];
         users: string[];
+        userIdentifiers: string[];
         lastUserMessage?: string | null;
         lastBotMessage?: string | null;
     }

package/serialization/resources/commons/types/ConversationSummary.js

@@ -50,6 +50,7 @@ exports.ConversationSummary = core.serialization.object({
     humanAgents: core.serialization.list(core.serialization.string()),
     humanAgentsWithInserts: core.serialization.list(core.serialization.string()),
     users: core.serialization.list(core.serialization.string()),
+    userIdentifiers: core.serialization.list(core.serialization.string()),
     lastUserMessage: core.serialization.string().optional(),
     lastBotMessage: core.serialization.string().optional(),
 });

package/serialization/resources/commons/types/InboxItem.d.ts

@@ -3,13 +3,17 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { InboxItemDuplicateDocuments } from "./InboxItemDuplicateDocuments";
 import { InboxItemMissingKnowledge } from "./InboxItemMissingKnowledge";
+import { InboxItemCustom } from "./InboxItemCustom";
 export declare const InboxItem: core.serialization.Schema<serializers.InboxItem.Raw, MavenAGI.InboxItem>;
 export declare namespace InboxItem {
-    type Raw = InboxItem.DuplicateDocuments | InboxItem.MissingKnowledge;
+    type Raw = InboxItem.DuplicateDocuments | InboxItem.MissingKnowledge | InboxItem.Custom;
     interface DuplicateDocuments extends InboxItemDuplicateDocuments.Raw {
         type: "duplicateDocuments";
     }
     interface MissingKnowledge extends InboxItemMissingKnowledge.Raw {
         type: "missingKnowledge";
     }
+    interface Custom extends InboxItemCustom.Raw {
+        type: "custom";
+    }
 }

package/serialization/resources/commons/types/InboxItem.js

@@ -38,10 +38,12 @@ exports.InboxItem = void 0;
 const core = __importStar(require("../../../../core"));
 const InboxItemDuplicateDocuments_1 = require("./InboxItemDuplicateDocuments");
 const InboxItemMissingKnowledge_1 = require("./InboxItemMissingKnowledge");
+const InboxItemCustom_1 = require("./InboxItemCustom");
 exports.InboxItem = core.serialization
     .union("type", {
     duplicateDocuments: InboxItemDuplicateDocuments_1.InboxItemDuplicateDocuments,
     missingKnowledge: InboxItemMissingKnowledge_1.InboxItemMissingKnowledge,
+    custom: InboxItemCustom_1.InboxItemCustom,
 })
     .transform({
     transform: (value) => value,

package/serialization/resources/commons/types/InboxItemCustom.d.ts

@@ -0,0 +1,10 @@
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { InboxItemBase } from "./InboxItemBase";
+export declare const InboxItemCustom: core.serialization.ObjectSchema<serializers.InboxItemCustom.Raw, MavenAGI.InboxItemCustom>;
+export declare namespace InboxItemCustom {
+    interface Raw extends InboxItemBase.Raw {
+        metadata: Record<string, string>;
+    }
+}

package/{dist/serialization/resources/agentCapabilities/types/AgentCapabilityField.js → serialization/resources/commons/types/InboxItemCustom.js}

@@ -34,6 +34,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentCapabilityField = void 0;
+exports.InboxItemCustom = void 0;
 const core = __importStar(require("../../../../core"));
-exports.AgentCapabilityField = core.serialization.enum_(["CreatedAt", "Enabled", "Name", "Type", "UserInteractionRequired"]);
+const InboxItemBase_1 = require("./InboxItemBase");
+exports.InboxItemCustom = core.serialization
+    .object({
+    metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
+})
+    .extend(InboxItemBase_1.InboxItemBase);

package/serialization/resources/commons/types/index.d.ts

@@ -125,6 +125,7 @@ export * from "./InboxItemType";
 export * from "./InboxItemSeverity";
 export * from "./InboxItem";
 export * from "./InboxItemBase";
+export * from "./InboxItemCustom";
 export * from "./InboxItemDuplicateDocuments";
 export * from "./InboxItemMissingKnowledge";
 export * from "./InboxItemFix";

package/serialization/resources/commons/types/index.js

@@ -141,6 +141,7 @@ __exportStar(require("./InboxItemType"), exports);
 __exportStar(require("./InboxItemSeverity"), exports);
 __exportStar(require("./InboxItem"), exports);
 __exportStar(require("./InboxItemBase"), exports);
+__exportStar(require("./InboxItemCustom"), exports);
 __exportStar(require("./InboxItemDuplicateDocuments"), exports);
 __exportStar(require("./InboxItemMissingKnowledge"), exports);
 __exportStar(require("./InboxItemFix"), exports);

package/serialization/resources/index.d.ts

@@ -1,7 +1,5 @@
 export * as actions from "./actions";
 export * from "./actions/types";
-export * as agentCapabilities from "./agentCapabilities";
-export * from "./agentCapabilities/types";
 export * as agents from "./agents";
 export * from "./agents/types";
 export * as analytics from "./analytics";

package/serialization/resources/index.js

@@ -36,11 +36,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.users = exports.triggers = exports.translations = exports.segments = exports.organizations = exports.knowledge = exports.inbox = exports.conversation = exports.commons = exports.assets = exports.appSettings = exports.analytics = exports.agents = exports.agentCapabilities = exports.actions = void 0;
+exports.users = exports.triggers = exports.translations = exports.segments = exports.organizations = exports.knowledge = exports.inbox = exports.conversation = exports.commons = exports.assets = exports.appSettings = exports.analytics = exports.agents = exports.actions = void 0;
 exports.actions = __importStar(require("./actions"));
 __exportStar(require("./actions/types"), exports);
-exports.agentCapabilities = __importStar(require("./agentCapabilities"));
-__exportStar(require("./agentCapabilities/types"), exports);
 exports.agents = __importStar(require("./agents"));
 __exportStar(require("./agents/types"), exports);
 exports.analytics = __importStar(require("./analytics"));

package/serialization/resources/knowledge/client/requests/KnowledgeDocumentPatchRequest.d.ts

@@ -0,0 +1,11 @@
+import * as serializers from "../../../../index";
+import * as MavenAGI from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { LlmInclusionStatus } from "../../../commons/types/LlmInclusionStatus";
+export declare const KnowledgeDocumentPatchRequest: core.serialization.Schema<serializers.KnowledgeDocumentPatchRequest.Raw, MavenAGI.KnowledgeDocumentPatchRequest>;
+export declare namespace KnowledgeDocumentPatchRequest {
+    interface Raw {
+        knowledgeBaseAppId?: string | null;
+        llmInclusionStatus?: LlmInclusionStatus.Raw | null;
+    }
+}

package/serialization/resources/{agentCapabilities/types/ExecuteCapabilityRequest.js → knowledge/client/requests/KnowledgeDocumentPatchRequest.js}

@@ -34,8 +34,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExecuteCapabilityRequest = void 0;
-const core = __importStar(require("../../../../core"));
-exports.ExecuteCapabilityRequest = core.serialization.object({
-    parameters: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
+exports.KnowledgeDocumentPatchRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+const LlmInclusionStatus_1 = require("../../../commons/types/LlmInclusionStatus");
+exports.KnowledgeDocumentPatchRequest = core.serialization.object({
+    knowledgeBaseAppId: core.serialization.string().optional(),
+    llmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus.optional(),
 });

package/serialization/resources/knowledge/client/requests/index.d.ts

@@ -1 +1,2 @@
 export { KnowledgeBasePatchRequest } from "./KnowledgeBasePatchRequest";
+export { KnowledgeDocumentPatchRequest } from "./KnowledgeDocumentPatchRequest";

package/serialization/resources/knowledge/client/requests/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KnowledgeBasePatchRequest = void 0;
+exports.KnowledgeDocumentPatchRequest = exports.KnowledgeBasePatchRequest = void 0;
 var KnowledgeBasePatchRequest_1 = require("./KnowledgeBasePatchRequest");
 Object.defineProperty(exports, "KnowledgeBasePatchRequest", { enumerable: true, get: function () { return KnowledgeBasePatchRequest_1.KnowledgeBasePatchRequest; } });
+var KnowledgeDocumentPatchRequest_1 = require("./KnowledgeDocumentPatchRequest");
+Object.defineProperty(exports, "KnowledgeDocumentPatchRequest", { enumerable: true, get: function () { return KnowledgeDocumentPatchRequest_1.KnowledgeDocumentPatchRequest; } });

package/serialization/resources/knowledge/types/BaseKnowledgeDocument.d.ts

@@ -6,8 +6,6 @@ export declare namespace BaseKnowledgeDocument {
     interface Raw {
         url?: string | null;
         language?: string | null;
-        createdAt?: string | null;
-        updatedAt?: string | null;
         author?: string | null;
     }
 }

package/serialization/resources/knowledge/types/BaseKnowledgeDocument.js

@@ -39,7 +39,5 @@ const core = __importStar(require("../../../../core"));
 exports.BaseKnowledgeDocument = core.serialization.object({
     url: core.serialization.string().optional(),
     language: core.serialization.string().optional(),
-    createdAt: core.serialization.date().optional(),
-    updatedAt: core.serialization.date().optional(),
     author: core.serialization.string().optional(),
 });

package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts

@@ -18,7 +18,7 @@ export declare namespace KnowledgeBaseResponse {
         type: KnowledgeBaseType.Raw;
         metadata: Record<string, string>;
         tags: string[];
-        llmInclusionStatus?: LlmInclusionStatus.Raw | null;
+        llmInclusionStatus: LlmInclusionStatus.Raw;
         refreshFrequency: KnowledgeBaseRefreshFrequency.Raw;
         segmentId?: EntityId.Raw | null;
     }

package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js

@@ -52,7 +52,7 @@ exports.KnowledgeBaseResponse = core.serialization
     type: KnowledgeBaseType_1.KnowledgeBaseType,
     metadata: core.serialization.record(core.serialization.string(), core.serialization.string()),
     tags: core.serialization.set(core.serialization.string()),
-    llmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus.optional(),
+    llmInclusionStatus: LlmInclusionStatus_1.LlmInclusionStatus,
     refreshFrequency: KnowledgeBaseRefreshFrequency_1.KnowledgeBaseRefreshFrequency,
     segmentId: EntityId_1.EntityId.optional(),
 })

package/serialization/resources/knowledge/types/KnowledgeBaseVersion.d.ts

@@ -10,5 +10,7 @@ export declare namespace KnowledgeBaseVersion {
         versionId: EntityId.Raw;
         status: KnowledgeBaseVersionStatus.Raw;
         errorMessage?: string | null;
+        createdAt: string;
+        updatedAt: string;
     }
 }

package/serialization/resources/knowledge/types/KnowledgeBaseVersion.js

@@ -44,5 +44,7 @@ exports.KnowledgeBaseVersion = core.serialization
     versionId: EntityId_1.EntityId,
     status: KnowledgeBaseVersionStatus_1.KnowledgeBaseVersionStatus,
     errorMessage: core.serialization.string().optional(),
+    createdAt: core.serialization.date(),
+    updatedAt: core.serialization.date(),
 })
     .extend(KnowledgeBaseVersionRequest_1.KnowledgeBaseVersionRequest);