mavenagi 1.2.45 → 1.2.46

package/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "mavenagi",
-        "X-Fern-SDK-Version": "1.2.45",
-        "User-Agent": "mavenagi/1.2.45",
+        "X-Fern-SDK-Version": "1.2.46",
+        "User-Agent": "mavenagi/1.2.46",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "X-Organization-Id": options === null || options === void 0 ? void 0 : options.organizationId,

package/api/resources/conversation/types/ConversationRequest.d.ts

@@ -20,7 +20,16 @@ export interface ConversationRequest {
     updatedAt?: Date;
     /** The tags of the conversation. Used for filtering in Agent Designer. */
     tags?: Set<string>;
-    /** The metadata of the conversation supplied by the app which created the conversation. */
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 500 characters. Values are strings with a maximum
+     * length of 512 characters.
+     *
+     * The metadata of the conversation supplied by the app which created the conversation.
+     */
     metadata?: Record<string, string>;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageRequest[];

package/api/resources/conversation/types/UpdateMetadataRequest.d.ts

@@ -10,6 +10,12 @@
 export interface UpdateMetadataRequest {
     /** The App ID of the conversation to modify metadata for. If not provided the ID of the calling app will be used. */
     appId?: string;
-    /** The metadata values to add to the conversation. */
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys and values are strings with a maximum length of 500 characters.
+     */
     values: Record<string, string>;
 }

package/api/resources/customers/types/CustomerBase.d.ts

@@ -2,6 +2,14 @@ import type * as MavenAGI from "../../../index";
 export interface CustomerBase {
     name: string;
     description?: string;
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     */
     metadata: Record<string, string>;
     /**
      * Whether or not the customer is in active use.

package/api/resources/customers/types/CustomerPatchRequest.d.ts

@@ -12,7 +12,16 @@ export interface CustomerPatchRequest {
      * Only active customers will be available for agent interactions.
      */
     status?: MavenAGI.CustomerStatus;
-    /** Metadata associated with the customer. If not provided, the existing metadata will be preserved. */
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     *
+     * If not provided, the existing metadata will be preserved.
+     */
     metadata?: Record<string, string>;
     /** Set of agent user IDs to assign to this customer. If provided, replaces all existing assignees. */
     assignees?: Set<string>;

package/api/resources/inbox/client/requests/InboxItemPatchRequest.d.ts

@@ -15,6 +15,13 @@ export interface InboxItemPatchRequest {
     status?: MavenAGI.InboxItemStatus;
     /** Severity of the inbox item. */
     severity?: MavenAGI.InboxItemSeverity;
-    /** Additional metadata associated with the inbox item. */
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     */
     metadata?: Record<string, string>;
 }

package/api/resources/inbox/types/InboxItemCreateRequest.d.ts

@@ -38,7 +38,14 @@ export interface InboxItemCreateRequest {
     status: MavenAGI.InboxItemStatus;
     /** Severity of the inbox item. */
     severity: MavenAGI.InboxItemSeverity;
-    /** Additional metadata associated with the inbox item. */
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     */
     metadata: Record<string, string>;
     /** Title of the inbox item. */
     title: string;

package/api/resources/knowledge/types/KnowledgeBaseIndexingProgressState.d.ts

@@ -0,0 +1,13 @@
+import type * as MavenAGI from "../../../index";
+export interface KnowledgeBaseIndexingProgressState {
+    /** The unique ID of a knowledge base version. */
+    versionId: MavenAGI.EntityId;
+    /** The status of the knowledge base indexing process. */
+    status: MavenAGI.KnowledgeBaseIndexingStatus;
+    /** The expected number of documents to be indexed for the latest knowledge base version. */
+    expectedCount: number;
+    /** The number of documents that have been indexed so far for the latest knowledge base version. */
+    indexedCount: number;
+    /** The number of documents that have failed to index for the latest knowledge base version. */
+    failedCount: number;
+}

package/api/resources/knowledge/types/KnowledgeBaseIndexingProgressState.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/knowledge/types/KnowledgeBaseIndexingStatus.d.ts

@@ -0,0 +1,10 @@
+/** The indexing status of the knowledge base version */
+export declare const KnowledgeBaseIndexingStatus: {
+    readonly Building: "BUILDING";
+    readonly Indexing: "INDEXING";
+    readonly Indexed: "INDEXED";
+    readonly Published: "PUBLISHED";
+    readonly Failed: "FAILED";
+    readonly Superseded: "SUPERSEDED";
+};
+export type KnowledgeBaseIndexingStatus = (typeof KnowledgeBaseIndexingStatus)[keyof typeof KnowledgeBaseIndexingStatus] | string;

package/api/resources/knowledge/types/KnowledgeBaseIndexingStatus.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeBaseIndexingStatus = void 0;
+/** The indexing status of the knowledge base version */
+exports.KnowledgeBaseIndexingStatus = {
+    Building: "BUILDING",
+    Indexing: "INDEXING",
+    Indexed: "INDEXED",
+    Published: "PUBLISHED",
+    Failed: "FAILED",
+    Superseded: "SUPERSEDED",
+};

package/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts

@@ -11,6 +11,13 @@ import type * as MavenAGI from "../../../index";
 export interface KnowledgeBaseRequest extends MavenAGI.KnowledgeBaseProperties {
     /** ID that uniquely identifies this knowledge base */
     knowledgeBaseId: MavenAGI.EntityIdBase;
-    /** Metadata for the knowledge base. */
+    /**
+     * Set of 16 key-value pairs that can be attached to an object. This can be useful for storing
+     * additional information about the object in a structured format, and querying for objects
+     * via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     */
     metadata?: Record<string, string>;
 }

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

@@ -81,4 +81,6 @@ export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties
     segmentIds: MavenAGI.EntityId[];
     /** The source URL of URL and RSS knowledge bases that was used for crawl. */
     url?: string;
+    /** The indexing status of the latest version of the knowledge base. */
+    indexingState?: MavenAGI.KnowledgeBaseIndexingProgressState;
 }

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

@@ -26,4 +26,6 @@ export interface KnowledgeBaseVersion extends MavenAGI.KnowledgeBaseVersionReque
     createdAt: Date;
     /** The date and time the knowledge base version was last updated. */
     updatedAt: Date;
+    /** The indexing status of the knowledge base version. */
+    indexingState?: MavenAGI.KnowledgeBaseIndexingProgressState;
 }

package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts

@@ -36,7 +36,14 @@ export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument
     assetId?: MavenAGI.EntityIdWithoutAgent;
     /** 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 */
     content?: string;
-    /** Metadata for the knowledge document. */
+    /**
+     * Set of 16 key-value pairs that can be attached to the knowledge document. This can be useful
+     * for storing additional information about the object in a structured format, and querying for
+     * objects via API or the dashboard.
+     *
+     * Keys are strings with a maximum length of 64 characters. Values are strings with a maximum
+     * length of 512 characters.
+     */
     metadata?: Record<string, string>;
     /** The time at which this document was created. */
     createdAt?: Date;

package/api/resources/knowledge/types/index.d.ts

@@ -3,6 +3,8 @@ export * from "./CancelKnowledgeBaseVersionRequest";
 export * from "./FinalizeKnowledgeBaseVersionRequest";
 export * from "./KnowledgeBaseField";
 export * from "./KnowledgeBaseFilter";
+export * from "./KnowledgeBaseIndexingProgressState";
+export * from "./KnowledgeBaseIndexingStatus";
 export * from "./KnowledgeBaseProperties";
 export * from "./KnowledgeBaseRefreshFrequency";
 export * from "./KnowledgeBaseRefreshRequest";

package/api/resources/knowledge/types/index.js

@@ -19,6 +19,8 @@ __exportStar(require("./CancelKnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./KnowledgeBaseField"), exports);
 __exportStar(require("./KnowledgeBaseFilter"), exports);
+__exportStar(require("./KnowledgeBaseIndexingProgressState"), exports);
+__exportStar(require("./KnowledgeBaseIndexingStatus"), exports);
 __exportStar(require("./KnowledgeBaseProperties"), exports);
 __exportStar(require("./KnowledgeBaseRefreshFrequency"), exports);
 __exportStar(require("./KnowledgeBaseRefreshRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mavenagi",
-    "version": "1.2.45",
+    "version": "1.2.46",
     "private": false,
     "repository": {
         "type": "git",

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

@@ -0,0 +1,15 @@
+import type * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import type * as serializers from "../../../index";
+import { EntityId } from "../../commons/types/EntityId";
+import { KnowledgeBaseIndexingStatus } from "./KnowledgeBaseIndexingStatus";
+export declare const KnowledgeBaseIndexingProgressState: core.serialization.ObjectSchema<serializers.KnowledgeBaseIndexingProgressState.Raw, MavenAGI.KnowledgeBaseIndexingProgressState>;
+export declare namespace KnowledgeBaseIndexingProgressState {
+    interface Raw {
+        versionId: EntityId.Raw;
+        status: KnowledgeBaseIndexingStatus.Raw;
+        expectedCount: number;
+        indexedCount: number;
+        failedCount: number;
+    }
+}

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

@@ -0,0 +1,47 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeBaseIndexingProgressState = void 0;
+const core = __importStar(require("../../../../core"));
+const EntityId_1 = require("../../commons/types/EntityId");
+const KnowledgeBaseIndexingStatus_1 = require("./KnowledgeBaseIndexingStatus");
+exports.KnowledgeBaseIndexingProgressState = core.serialization.object({
+    versionId: EntityId_1.EntityId,
+    status: KnowledgeBaseIndexingStatus_1.KnowledgeBaseIndexingStatus,
+    expectedCount: core.serialization.number(),
+    indexedCount: core.serialization.number(),
+    failedCount: core.serialization.number(),
+});

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

@@ -0,0 +1,7 @@
+import type * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import type * as serializers from "../../../index";
+export declare const KnowledgeBaseIndexingStatus: core.serialization.Schema<serializers.KnowledgeBaseIndexingStatus.Raw, MavenAGI.KnowledgeBaseIndexingStatus>;
+export declare namespace KnowledgeBaseIndexingStatus {
+    type Raw = "BUILDING" | "INDEXING" | "INDEXED" | "PUBLISHED" | "FAILED" | "SUPERSEDED";
+}

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

@@ -0,0 +1,39 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeBaseIndexingStatus = void 0;
+const core = __importStar(require("../../../../core"));
+exports.KnowledgeBaseIndexingStatus = core.serialization.forwardCompatibleEnum_(["BUILDING", "INDEXING", "INDEXED", "PUBLISHED", "FAILED", "SUPERSEDED"]);

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

@@ -3,6 +3,7 @@ import * as core from "../../../../core";
 import type * as serializers from "../../../index";
 import { EntityId } from "../../commons/types/EntityId";
 import { LlmInclusionStatus } from "../../commons/types/LlmInclusionStatus";
+import { KnowledgeBaseIndexingProgressState } from "./KnowledgeBaseIndexingProgressState";
 import { KnowledgeBaseProperties } from "./KnowledgeBaseProperties";
 import { KnowledgeBaseRefreshFrequency } from "./KnowledgeBaseRefreshFrequency";
 import { KnowledgeBaseType } from "./KnowledgeBaseType";
@@ -23,5 +24,6 @@ export declare namespace KnowledgeBaseResponse {
         segmentId?: EntityId.Raw | null;
         segmentIds: EntityId.Raw[];
         url?: string | null;
+        indexingState?: KnowledgeBaseIndexingProgressState.Raw | null;
     }
 }

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

@@ -38,6 +38,7 @@ exports.KnowledgeBaseResponse = void 0;
 const core = __importStar(require("../../../../core"));
 const EntityId_1 = require("../../commons/types/EntityId");
 const LlmInclusionStatus_1 = require("../../commons/types/LlmInclusionStatus");
+const KnowledgeBaseIndexingProgressState_1 = require("./KnowledgeBaseIndexingProgressState");
 const KnowledgeBaseProperties_1 = require("./KnowledgeBaseProperties");
 const KnowledgeBaseRefreshFrequency_1 = require("./KnowledgeBaseRefreshFrequency");
 const KnowledgeBaseType_1 = require("./KnowledgeBaseType");
@@ -57,5 +58,6 @@ exports.KnowledgeBaseResponse = core.serialization
     segmentId: EntityId_1.EntityId.optional(),
     segmentIds: core.serialization.list(EntityId_1.EntityId),
     url: core.serialization.string().optional(),
+    indexingState: KnowledgeBaseIndexingProgressState_1.KnowledgeBaseIndexingProgressState.optional(),
 })
     .extend(KnowledgeBaseProperties_1.KnowledgeBaseProperties);

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

@@ -2,6 +2,7 @@ import type * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import type * as serializers from "../../../index";
 import { EntityId } from "../../commons/types/EntityId";
+import { KnowledgeBaseIndexingProgressState } from "./KnowledgeBaseIndexingProgressState";
 import { KnowledgeBaseVersionRequest } from "./KnowledgeBaseVersionRequest";
 import { KnowledgeBaseVersionStatus } from "./KnowledgeBaseVersionStatus";
 export declare const KnowledgeBaseVersion: core.serialization.ObjectSchema<serializers.KnowledgeBaseVersion.Raw, MavenAGI.KnowledgeBaseVersion>;
@@ -12,5 +13,6 @@ export declare namespace KnowledgeBaseVersion {
         errorMessage?: string | null;
         createdAt: string;
         updatedAt: string;
+        indexingState?: KnowledgeBaseIndexingProgressState.Raw | null;
     }
 }

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

@@ -37,6 +37,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KnowledgeBaseVersion = void 0;
 const core = __importStar(require("../../../../core"));
 const EntityId_1 = require("../../commons/types/EntityId");
+const KnowledgeBaseIndexingProgressState_1 = require("./KnowledgeBaseIndexingProgressState");
 const KnowledgeBaseVersionRequest_1 = require("./KnowledgeBaseVersionRequest");
 const KnowledgeBaseVersionStatus_1 = require("./KnowledgeBaseVersionStatus");
 exports.KnowledgeBaseVersion = core.serialization
@@ -46,5 +47,6 @@ exports.KnowledgeBaseVersion = core.serialization
     errorMessage: core.serialization.string().optional(),
     createdAt: core.serialization.date(),
     updatedAt: core.serialization.date(),
+    indexingState: KnowledgeBaseIndexingProgressState_1.KnowledgeBaseIndexingProgressState.optional(),
 })
     .extend(KnowledgeBaseVersionRequest_1.KnowledgeBaseVersionRequest);

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

@@ -3,6 +3,8 @@ export * from "./CancelKnowledgeBaseVersionRequest";
 export * from "./FinalizeKnowledgeBaseVersionRequest";
 export * from "./KnowledgeBaseField";
 export * from "./KnowledgeBaseFilter";
+export * from "./KnowledgeBaseIndexingProgressState";
+export * from "./KnowledgeBaseIndexingStatus";
 export * from "./KnowledgeBaseProperties";
 export * from "./KnowledgeBaseRefreshFrequency";
 export * from "./KnowledgeBaseRefreshRequest";

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

@@ -19,6 +19,8 @@ __exportStar(require("./CancelKnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./KnowledgeBaseField"), exports);
 __exportStar(require("./KnowledgeBaseFilter"), exports);
+__exportStar(require("./KnowledgeBaseIndexingProgressState"), exports);
+__exportStar(require("./KnowledgeBaseIndexingStatus"), exports);
 __exportStar(require("./KnowledgeBaseProperties"), exports);
 __exportStar(require("./KnowledgeBaseRefreshFrequency"), exports);
 __exportStar(require("./KnowledgeBaseRefreshRequest"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.45";
+export declare const SDK_VERSION = "1.2.46";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.2.45";
+exports.SDK_VERSION = "1.2.46";