mavenagi 1.2.6 → 1.2.8

package/dist/api/resources/conversation/client/Client.d.ts

@@ -56,23 +56,23 @@ export declare class Conversation {
      * @example
      *     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"
@@ -159,19 +159,19 @@ export declare class Conversation {
      * @example
      *     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"
@@ -401,6 +401,25 @@ export declare class Conversation {
      */
     export(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
     private __export;
+    /**
+     * Import simulation conversations from a CSV file.
+     *
+     * This CSV format is very simple and only allows for one column: `question`. A header containing this column is required.
+     * Each row will generate one simulation conversation, using the provided response config, if present.
+     *
+     * This API is offered for backwards compatibility.
+     * Most API callers should create simulations programmatically to allow for more flexibility.
+     *
+     * @param {core.file.Uploadable.FileLike} file
+     * @param {MavenAGI.SimulationImportRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    importSimulations(file: core.file.Uploadable.FileLike, request: MavenAGI.SimulationImportRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<void>;
+    private __importSimulations;
     /**
      * Deliver a message to a user or conversation.
      *
@@ -422,14 +441,14 @@ export declare class Conversation {
      *         userId: {
      *             type: "AGENT",
      *             appId: "appId",
-     *             referenceId: "referenceId"
+     *             referenceId: "x"
      *         },
      *         message: {
      *             conversationMessageId: {
-     *                 referenceId: "referenceId"
+     *                 referenceId: "x"
      *             },
      *             userId: {
-     *                 referenceId: "referenceId"
+     *                 referenceId: "x"
      *             },
      *             text: "text",
      *             userMessageType: "USER"

package/dist/api/resources/conversation/client/Client.js

@@ -50,6 +50,7 @@ const MavenAGI = __importStar(require("../../../index"));
 const headers_1 = require("../../../../core/headers");
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
+const json_1 = require("../../../../core/json");
 class Conversation {
     constructor(_options) {
         this._options = _options;
@@ -74,23 +75,23 @@ class Conversation {
      * @example
      *     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"
@@ -497,19 +498,19 @@ class Conversation {
      * @example
      *     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"
@@ -1635,6 +1636,99 @@ class Conversation {
             }
         });
     }
+    /**
+     * Import simulation conversations from a CSV file.
+     *
+     * This CSV format is very simple and only allows for one column: `question`. A header containing this column is required.
+     * Each row will generate one simulation conversation, using the provided response config, if present.
+     *
+     * This API is offered for backwards compatibility.
+     * Most API callers should create simulations programmatically to allow for more flexibility.
+     *
+     * @param {core.file.Uploadable.FileLike} file
+     * @param {MavenAGI.SimulationImportRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    importSimulations(file, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__importSimulations(file, request, requestOptions));
+    }
+    __importSimulations(file, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const _request = yield core.newFormData();
+            yield _request.appendFile("file", file);
+            if (request.responseConfig != null) {
+                _request.append("responseConfig", (0, json_1.toJson)(serializers.ResponseConfig.jsonOrThrow(request.responseConfig, { unrecognizedObjectKeys: "strip" })));
+            }
+            const _maybeEncodedRequest = yield _request.getRequest();
+            let _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)(Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId, "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId }, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, "/v1/conversations/import_simulations"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/conversations/import_simulations.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Deliver a message to a user or conversation.
      *
@@ -1656,14 +1750,14 @@ class Conversation {
      *         userId: {
      *             type: "AGENT",
      *             appId: "appId",
-     *             referenceId: "referenceId"
+     *             referenceId: "x"
      *         },
      *         message: {
      *             conversationMessageId: {
-     *                 referenceId: "referenceId"
+     *                 referenceId: "x"
      *             },
      *             userId: {
-     *                 referenceId: "referenceId"
+     *                 referenceId: "x"
      *             },
      *             text: "text",
      *             userMessageType: "USER"

package/dist/api/resources/conversation/client/requests/SimulationImportRequest.d.ts

@@ -0,0 +1,5 @@
+import * as MavenAGI from "../../../../index";
+export interface SimulationImportRequest {
+    /** The response config to use for all of the created simulations. */
+    responseConfig?: MavenAGI.ResponseConfig;
+}

package/dist/api/resources/conversation/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export { type ConversationGetRequest } from "./ConversationGetRequest";
 export { type ConversationDeleteRequest } from "./ConversationDeleteRequest";
+export { type SimulationImportRequest } from "./SimulationImportRequest";

package/dist/api/resources/events/client/Client.d.ts

@@ -50,12 +50,12 @@ export declare class Events {
      *     await client.events.create({
      *         eventType: "userEvent",
      *         id: {
-     *             referenceId: "referenceId"
+     *             referenceId: "x"
      *         },
      *         eventName: "BUTTON_CLICKED",
      *         userInfo: {
      *             id: {
-     *                 referenceId: "referenceId"
+     *                 referenceId: "x"
      *             }
      *         }
      *     })

package/dist/api/resources/events/client/Client.js

@@ -68,12 +68,12 @@ class Events {
      *     await client.events.create({
      *         eventType: "userEvent",
      *         id: {
-     *             referenceId: "referenceId"
+     *             referenceId: "x"
      *         },
      *         eventName: "BUTTON_CLICKED",
      *         userInfo: {
      *             id: {
-     *                 referenceId: "referenceId"
+     *                 referenceId: "x"
      *             }
      *         }
      *     })

package/dist/api/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/dist/api/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.events = 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.events = 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/dist/api/resources/knowledge/client/Client.d.ts

@@ -291,5 +291,29 @@ export declare class Knowledge {
      */
     getKnowledgeDocument(knowledgeBaseVersionReferenceId: string, knowledgeDocumentReferenceId: string, request: MavenAGI.KnowledgeDocumentGetRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentResponse>;
     private __getKnowledgeDocument;
+    /**
+     * 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.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to patch.
+     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to patch.
+     * @param {MavenAGI.KnowledgeDocumentPatchRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.patchKnowledgeDocument("help-center", "how-it-works", {
+     *         llmInclusionStatus: "ALWAYS"
+     *     })
+     */
+    patchKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, request?: MavenAGI.KnowledgeDocumentPatchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentResponse>;
+    private __patchKnowledgeDocument;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/api/resources/knowledge/client/Client.js

@@ -1259,6 +1259,110 @@ class Knowledge {
             }
         });
     }
+    /**
+     * 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.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to patch.
+     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to patch.
+     * @param {MavenAGI.KnowledgeDocumentPatchRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.patchKnowledgeDocument("help-center", "how-it-works", {
+     *         llmInclusionStatus: "ALWAYS"
+     *     })
+     */
+    patchKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__patchKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, request, requestOptions));
+    }
+    __patchKnowledgeDocument(knowledgeBaseReferenceId_1, knowledgeDocumentReferenceId_1) {
+        return __awaiter(this, arguments, void 0, function* (knowledgeBaseReferenceId, knowledgeDocumentReferenceId, request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            let _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
+                "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/${encodeURIComponent(knowledgeDocumentReferenceId)}/document`),
+                method: "PATCH",
+                headers: _headers,
+                contentType: "application/merge-patch+json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.KnowledgeDocumentPatchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.KnowledgeDocumentResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling PATCH /v1/knowledge/{knowledgeBaseReferenceId}/{knowledgeDocumentReferenceId}/document.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;

package/dist/api/resources/knowledge/client/requests/KnowledgeDocumentPatchRequest.d.ts

@@ -0,0 +1,13 @@
+import * as MavenAGI from "../../../../index";
+/**
+ * @example
+ *     {
+ *         llmInclusionStatus: "ALWAYS"
+ *     }
+ */
+export interface KnowledgeDocumentPatchRequest {
+    /** The App ID of the knowledge base that contains the knowledge document to patch. If not provided the ID of the calling app will be used. */
+    knowledgeBaseAppId?: string;
+    /** Determines whether this document is sent to the LLM as part of a conversation. */
+    llmInclusionStatus?: MavenAGI.LlmInclusionStatus;
+}

package/dist/api/resources/knowledge/client/requests/index.d.ts

@@ -2,3 +2,4 @@ export { type KnowledgeBaseGetRequest } from "./KnowledgeBaseGetRequest";
 export { type KnowledgeBasePatchRequest } from "./KnowledgeBasePatchRequest";
 export { type KnowledgeBaseVersionsListRequest } from "./KnowledgeBaseVersionsListRequest";
 export { type KnowledgeDocumentGetRequest } from "./KnowledgeDocumentGetRequest";
+export { type KnowledgeDocumentPatchRequest } from "./KnowledgeDocumentPatchRequest";

package/dist/api/resources/knowledge/types/BaseKnowledgeDocument.d.ts

@@ -3,10 +3,6 @@ export interface BaseKnowledgeDocument {
     url?: string;
     /** The document language. Must be a valid ISO 639-1 language code. */
     language?: string;
-    /** The time at which this document was created. */
-    createdAt?: Date;
-    /** The time at which this document was last modified. */
-    updatedAt?: Date;
     /** The name of the author who created this document. */
     author?: string;
 }

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

@@ -58,7 +58,7 @@ export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties
     /** The tags of the knowledge base. */
     tags: Set<string>;
     /** Determines whether documents in the knowledge base are sent to the LLM as part of a conversation. */
-    llmInclusionStatus?: MavenAGI.LlmInclusionStatus;
+    llmInclusionStatus: MavenAGI.LlmInclusionStatus;
     /** How often the knowledge base should be refreshed. */
     refreshFrequency: MavenAGI.KnowledgeBaseRefreshFrequency;
     /**

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

@@ -10,7 +10,9 @@ import * as MavenAGI from "../../../index";
  *             agentId: "support"
  *         },
  *         type: MavenAGI.KnowledgeBaseVersionType.Full,
- *         status: MavenAGI.KnowledgeBaseVersionStatus.InProgress
+ *         status: MavenAGI.KnowledgeBaseVersionStatus.InProgress,
+ *         createdAt: new Date("2024-01-01T00:00:00.000Z"),
+ *         updatedAt: new Date("2024-02-02T00:00:00.000Z")
  *     }
  */
 export interface KnowledgeBaseVersion extends MavenAGI.KnowledgeBaseVersionRequest {
@@ -20,4 +22,8 @@ export interface KnowledgeBaseVersion extends MavenAGI.KnowledgeBaseVersionReque
     status: MavenAGI.KnowledgeBaseVersionStatus;
     /** A user-facing error message that provides more details about a version failure. */
     errorMessage?: string;
+    /** The date and time the knowledge base version was created. */
+    createdAt: Date;
+    /** The date and time the knowledge base version was last updated. */
+    updatedAt: Date;
 }

package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts

@@ -17,6 +17,8 @@ export interface KnowledgeDocumentFilter {
     search?: string;
     /** Filter by title */
     title?: string;
+    /** Filter by url */
+    url?: string;
     /** Filter knowledge documents created on or after this timestamp */
     createdAfter?: Date;
     /** Filter knowledge documents created on or before this timestamp */
@@ -28,4 +30,6 @@ export interface KnowledgeDocumentFilter {
      * If not provided all active knowledge base versions within the agent will be searched.
      */
     knowledgeBaseVersionId?: MavenAGI.EntityIdWithoutAgent;
+    /** Filter by the LLM inclusion status */
+    llmInclusionStatus?: MavenAGI.LlmInclusionStatus[];
 }

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

@@ -23,11 +23,18 @@ export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument
     knowledgeDocumentId: MavenAGI.EntityIdBase;
     /** 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. */
     versionId?: MavenAGI.EntityIdWithoutAgent;
+    /** Type of knowledge document content, if content is provided. This does not need to be set if content is not provided */
     contentType: MavenAGI.KnowledgeDocumentContentType;
     /** The title of the document. Will be shown as part of answers. */
     title: string;
-    /** 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. */
-    content: string;
+    /** ID of the asset associated with this document. Either this or content is required, but not both */
+    assetId?: MavenAGI.EntityIdBase;
+    /** 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. */
     metadata?: Record<string, string>;
+    /** The time at which this document was created. */
+    createdAt?: Date;
+    /** The time at which this document was last modified. */
+    updatedAt?: Date;
 }

package/dist/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts

@@ -20,12 +20,19 @@ import * as MavenAGI from "../../../index";
  *         title: "Getting started",
  *         metadata: {
  *             "category": "getting-started"
- *         }
+ *         },
+ *         createdAt: new Date("2024-01-01T00:00:00.000Z"),
+ *         updatedAt: new Date("2024-02-02T00:00:00.000Z"),
+ *         llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant
  *     }
  */
 export interface KnowledgeDocumentResponse extends MavenAGI.KnowledgeDocumentSearchResponse {
+    /** The current processing status of the knowledge document */
+    processingStatus?: MavenAGI.KnowledgeDocumentStatus;
     /** The content of the document in markdown format. Not shown directly to users. */
     content: string;
+    /** If the document is associated with an asset, this will contain the asset metadata */
+    asset?: MavenAGI.AttachmentResponse;
     /** Metadata for the knowledge document. */
     metadata: Record<string, string>;
 }