mavenagi 1.2.0 → 1.2.3

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

@@ -359,13 +359,13 @@ class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId", {})
+     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId")
      */
-    patchKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions) {
+    patchKnowledgeBase(knowledgeBaseReferenceId, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__patchKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions));
     }
-    __patchKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __patchKnowledgeBase(knowledgeBaseReferenceId_1) {
+        return __awaiter(this, arguments, void 0, function* (knowledgeBaseReferenceId, request = {}, requestOptions) {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}`),
@@ -375,7 +375,7 @@ class Knowledge {
                     "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
                     "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
                 }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                contentType: "application/json",
+                contentType: "application/merge-patch+json",
                 requestType: "json",
                 body: serializers.KnowledgeBasePatchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -447,7 +447,7 @@ class Knowledge {
      * If an existing version is in progress, then that version will be finalized in an error state.
      *
      * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a version for. All other entity ID fields are inferred from the request.
-     * @param {MavenAGI.KnowledgeBaseVersion} request
+     * @param {MavenAGI.KnowledgeBaseVersionRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -456,15 +456,7 @@ class Knowledge {
      *
      * @example
      *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
-     *         versionId: {
-     *             type: "KNOWLEDGE_BASE_VERSION",
-     *             referenceId: "versionId",
-     *             appId: "maven",
-     *             organizationId: "acme",
-     *             agentId: "support"
-     *         },
-     *         type: "FULL",
-     *         status: "IN_PROGRESS"
+     *         type: "FULL"
      *     })
      */
     createKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
@@ -483,7 +475,7 @@ class Knowledge {
                 }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
-                body: serializers.KnowledgeBaseVersion.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                body: serializers.KnowledgeBaseVersionRequest.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,
@@ -650,6 +642,103 @@ class Knowledge {
             }
         });
     }
+    /**
+     * List all active versions for a knowledge base. Returns the most recent versions first.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to list versions for. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeBaseVersionsListRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.listKnowledgeBaseVersions("knowledgeBaseReferenceId")
+     */
+    listKnowledgeBaseVersions(knowledgeBaseReferenceId, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listKnowledgeBaseVersions(knowledgeBaseReferenceId, request, requestOptions));
+    }
+    __listKnowledgeBaseVersions(knowledgeBaseReferenceId_1) {
+        return __awaiter(this, arguments, void 0, function* (knowledgeBaseReferenceId, request = {}, requestOptions) {
+            var _a, _b, _c, _d;
+            const { appId } = request;
+            const _queryParams = {};
+            if (appId != null) {
+                _queryParams["appId"] = appId;
+            }
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/versions`),
+                method: "GET",
+                headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
+                    "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                queryParameters: _queryParams,
+                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.KnowledgeBaseVersionsListResponse.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 GET /v1/knowledge/{knowledgeBaseReferenceId}/versions.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Search knowledge documents
      *
@@ -744,10 +833,11 @@ class Knowledge {
         });
     }
     /**
-     * Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
+     * Create or update a knowledge document. Requires an existing knowledge base with an in progress version.
+     * Will throw an exception if the latest version is not in progress.
      *
      * <Tip>
-     * This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
+     * This API maintains document version history. If for the same reference ID none of the `title`, `text`, `sourceUrl`, `metadata` fields
      * have changed, a new document version will not be created. The existing version will be reused.
      * </Tip>
      *
@@ -858,10 +948,12 @@ class Knowledge {
         });
     }
     /**
-     * Not yet implemented. Update knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
+     * Delete knowledge document from a specific version.
+     * Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the version is not in progress.
      *
-     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base that contains the document to update. All other entity ID fields are inferred from the request.
-     * @param {MavenAGI.KnowledgeDocumentRequest} request
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
+     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeDeleteRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -869,32 +961,23 @@ class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.updateKnowledgeDocument("help-center", {
-     *         knowledgeDocumentId: {
-     *             referenceId: "getting-started"
-     *         },
+     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started", {
      *         versionId: {
      *             type: "KNOWLEDGE_BASE_VERSION",
-     *             referenceId: "versionId",
-     *             appId: "maven"
-     *         },
-     *         contentType: "MARKDOWN",
-     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
-     *         title: "Getting started",
-     *         metadata: {
-     *             "category": "getting-started"
+     *             appId: "maven",
+     *             referenceId: "versionId"
      *         }
      *     })
      */
-    updateKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__updateKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions));
+    deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, request, requestOptions));
     }
-    __updateKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions) {
+    __deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/document`),
-                method: "PUT",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/${encodeURIComponent(knowledgeDocumentReferenceId)}/document`),
+                method: "DELETE",
                 headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
@@ -902,21 +985,13 @@ class Knowledge {
                 }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
-                body: serializers.KnowledgeDocumentRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                body: serializers.KnowledgeDeleteRequest.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,
-                };
+                return { data: undefined, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -957,7 +1032,7 @@ class Knowledge {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling PUT /v1/knowledge/{knowledgeBaseReferenceId}/document.");
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling DELETE /v1/knowledge/{knowledgeBaseReferenceId}/{knowledgeDocumentReferenceId}/document.");
                 case "unknown":
                     throw new errors.MavenAGIError({
                         message: _response.error.errorMessage,
@@ -967,10 +1042,11 @@ class Knowledge {
         });
     }
     /**
-     * Not yet implemented. Delete knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
+     * Get a knowledge document by its supplied version and document IDs. Response includes document content in markdown format.
      *
-     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
-     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
+     * @param {string} knowledgeBaseVersionReferenceId - The reference ID of the knowledge base version that contains the document. All other entity ID fields are inferred from the request.
+     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to get. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeDocumentGetRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -978,28 +1054,42 @@ class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
+     *     await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "knowledgeDocumentReferenceId", {
+     *         knowledgeBaseVersionAppId: "knowledgeBaseVersionAppId"
+     *     })
      */
-    deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, requestOptions));
+    getKnowledgeDocument(knowledgeBaseVersionReferenceId, knowledgeDocumentReferenceId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getKnowledgeDocument(knowledgeBaseVersionReferenceId, knowledgeDocumentReferenceId, request, requestOptions));
     }
-    __deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, requestOptions) {
+    __getKnowledgeDocument(knowledgeBaseVersionReferenceId, knowledgeDocumentReferenceId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
+            const { knowledgeBaseVersionAppId } = request;
+            const _queryParams = {};
+            _queryParams["knowledgeBaseVersionAppId"] = knowledgeBaseVersionAppId;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/${encodeURIComponent(knowledgeDocumentReferenceId)}/document`),
-                method: "DELETE",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/versions/${encodeURIComponent(knowledgeBaseVersionReferenceId)}/documents/${encodeURIComponent(knowledgeDocumentReferenceId)}`),
+                method: "GET",
                 headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
                     "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
                 }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                queryParameters: _queryParams,
                 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 };
+                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) {
@@ -1040,7 +1130,7 @@ class Knowledge {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling DELETE /v1/knowledge/{knowledgeBaseReferenceId}/{knowledgeDocumentReferenceId}/document.");
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling GET /v1/knowledge/versions/{knowledgeBaseVersionReferenceId}/documents/{knowledgeDocumentReferenceId}.");
                 case "unknown":
                     throw new errors.MavenAGIError({
                         message: _response.error.errorMessage,

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

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface KnowledgeBasePatchRequest {
+    /** The App ID of the knowledge base to patch. If not provided the ID of the calling app will be used. */
+    appId?: string;
+    /** The name of the knowledge base. */
+    name?: string;
+    /** 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. Note that at this time knowledge bases can not be set to `ALWAYS`. */
+    llmInclusionStatus?: MavenAGI.LlmInclusionStatus;
+    /** The preconditions that must be met for a knowledge base to be relevant to a conversation. Can be used to restrict knowledge bases to certain types of users. A null value will remove the precondition from the knowledge base, it will be available on all conversations. */
+    precondition?: MavenAGI.Precondition | null;
+    /**
+     * The ID of the segment that must be matched for the knowledge base to be relevant to a conversation.
+     * A null value will remove the segment from the knowledge base, it will be available on all conversations.
+     *
+     * Segments are replacing inline preconditions - a knowledge base may not have both an inline precondition and a segment.
+     * Inline precondition support will be removed in a future release.
+     */
+    segmentId?: MavenAGI.EntityId | null;
+    /** How often the knowledge base should be refreshed. */
+    refreshFrequency?: MavenAGI.KnowledgeBaseRefreshFrequency;
+}

package/dist/api/resources/knowledge/client/requests/KnowledgeBasePatchRequest.js

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

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface KnowledgeBaseVersionsListRequest {
+    /**
+     * The App ID of the knowledge base. If not provided the ID of the calling app will be used.
+     */
+    appId?: string;
+}

package/dist/api/resources/knowledge/client/requests/KnowledgeBaseVersionsListRequest.js

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

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         knowledgeBaseVersionAppId: "knowledgeBaseVersionAppId"
+ *     }
+ */
+export interface KnowledgeDocumentGetRequest {
+    /**
+     * The App ID of the knowledge base version.
+     */
+    knowledgeBaseVersionAppId: string;
+}

package/dist/api/resources/knowledge/client/requests/KnowledgeDocumentGetRequest.js

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

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

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

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

@@ -23,4 +23,6 @@ export interface KnowledgeBaseFilter {
     createdAfter?: Date;
     /** Filter knowledge bases created on or before this timestamp */
     createdBefore?: Date;
+    /** Filter by app IDs */
+    appIds?: string[];
 }

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

@@ -24,6 +24,8 @@ import * as MavenAGI from "../../../index";
 export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties {
     /** ID that uniquely identifies this knowledge base */
     knowledgeBaseId: MavenAGI.EntityId;
+    /** ID of the knowledge base version that is currently active. Documents can be fetched using this version ID. */
+    activeVersionId?: MavenAGI.EntityId;
     /** The type of the knowledge base. Can not be changed once created. */
     type: MavenAGI.KnowledgeBaseType;
     /** Metadata for the knowledge base. */

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

@@ -16,11 +16,9 @@ import * as MavenAGI from "../../../index";
  *         status: MavenAGI.KnowledgeBaseVersionStatus.InProgress
  *     }
  */
-export interface KnowledgeBaseVersion {
+export interface KnowledgeBaseVersion extends MavenAGI.KnowledgeBaseVersionRequest {
     /** The unique ID of the knowledge base version. */
     versionId: MavenAGI.EntityId;
-    /** Indicates whether the completed version constitutes a full or partial refresh of the knowledge base. Deleting and updating documents is only supported for partial refreshes. */
-    type: MavenAGI.KnowledgeBaseVersionType;
     /** The status of the knowledge base version */
     status: MavenAGI.KnowledgeBaseVersionStatus;
     /** A user-facing error message that provides more details about a version failure. */

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         type: MavenAGI.KnowledgeBaseVersionType.Full
+ *     }
+ */
+export interface KnowledgeBaseVersionRequest {
+    /** Indicates whether the completed version constitutes a full or partial refresh of the knowledge base. Deleting and updating documents is only supported for partial refreshes. */
+    type: MavenAGI.KnowledgeBaseVersionType;
+}

package/dist/api/resources/knowledge/types/KnowledgeBaseVersionRequest.js

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

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeBaseVersionsListResponse {
+    /** The active knowledge base versions for the knowledge base. Includes all versions within the last 90 days or the last 10, whichever is greater. */
+    knowledgeBaseVersions: MavenAGI.KnowledgeBaseVersion[];
+}

package/dist/api/resources/knowledge/types/KnowledgeBaseVersionsListResponse.js

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

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         versionId: {
+ *             type: MavenAGI.EntityType.KnowledgeBaseVersion,
+ *             appId: "maven",
+ *             referenceId: "versionId"
+ *         }
+ *     }
+ */
+export interface KnowledgeDeleteRequest {
+    /** ID that uniquely identifies which knowledge base version to delete the document from. */
+    versionId: MavenAGI.EntityIdWithoutAgent;
+}

package/dist/api/resources/knowledge/types/KnowledgeDeleteRequest.js

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

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

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as MavenAGI from "../../../index";
 export interface KnowledgeDocumentFilter {
     /**
      * Full-text search query for matching knowledge documents by content.
@@ -23,4 +24,11 @@ export interface KnowledgeDocumentFilter {
     createdAfter?: Date;
     /** Filter knowledge documents created on or before this timestamp */
     createdBefore?: Date;
+    /** Filter by app IDs */
+    appIds?: string[];
+    /**
+     * Filter documents within the specified knowledge base version.
+     * If not provided all active knowledge base versions within the agent will be searched.
+     */
+    knowledgeBaseVersionId?: MavenAGI.EntityIdWithoutAgent;
 }

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

@@ -12,6 +12,13 @@ import * as MavenAGI from "../../../index";
  *             agentId: "support",
  *             type: MavenAGI.EntityType.KnowledgeDocument
  *         },
+ *         knowledgeBaseVersionId: {
+ *             referenceId: "versionId",
+ *             appId: "maven",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.KnowledgeBaseVersion
+ *         },
  *         content: "## Getting started This is a getting started guide for the help center.",
  *         title: "Getting started",
  *         metadata: {
@@ -19,9 +26,7 @@ import * as MavenAGI from "../../../index";
  *         }
  *     }
  */
-export interface KnowledgeDocumentResponse extends MavenAGI.BaseKnowledgeDocument {
-    /** ID that uniquely identifies this knowledge document within its knowledge base */
-    knowledgeDocumentId: MavenAGI.EntityId;
+export interface KnowledgeDocumentResponse extends MavenAGI.KnowledgeDocumentSearchResponse {
     /** The content of the document in markdown format. Not shown directly to users. */
     content: string;
     /** Metadata for the knowledge document. */

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

@@ -5,6 +5,9 @@ import * as MavenAGI from "../../../index";
 export interface KnowledgeDocumentSearchResponse extends MavenAGI.BaseKnowledgeDocument {
     /** ID that uniquely identifies this knowledge document within its knowledge base */
     knowledgeDocumentId: MavenAGI.EntityId;
-    /** Metadata for the knowledge document. */
-    metadata: Record<string, string>;
+    /**
+     * ID that uniquely identifies the knowledge base version that contains this document.
+     * This may be missing on legacy documents.
+     */
+    knowledgeBaseVersionId?: MavenAGI.EntityId;
 }

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

@@ -3,7 +3,7 @@ export * from "./KnowledgeBaseRequest";
 export * from "./KnowledgeBaseResponse";
 export * from "./KnowledgeBaseType";
 export * from "./KnowledgeBaseRefreshFrequency";
-export * from "./KnowledgeBasePatchRequest";
+export * from "./KnowledgeBaseVersionRequest";
 export * from "./KnowledgeBaseVersion";
 export * from "./KnowledgeBaseVersionType";
 export * from "./KnowledgeBaseVersionStatus";
@@ -11,6 +11,7 @@ export * from "./KnowledgeBaseVersionFinalizeStatus";
 export * from "./FinalizeKnowledgeBaseVersionRequest";
 export * from "./BaseKnowledgeDocument";
 export * from "./KnowledgeDocumentContentType";
+export * from "./KnowledgeDeleteRequest";
 export * from "./KnowledgeDocumentRequest";
 export * from "./KnowledgeDocumentResponse";
 export * from "./KnowledgeBaseField";
@@ -22,3 +23,4 @@ export * from "./KnowledgeBasesResponse";
 export * from "./KnowledgeDocumentSearchRequest";
 export * from "./KnowledgeDocumentSearchResponse";
 export * from "./KnowledgeDocumentsResponse";
+export * from "./KnowledgeBaseVersionsListResponse";

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

@@ -19,7 +19,7 @@ __exportStar(require("./KnowledgeBaseRequest"), exports);
 __exportStar(require("./KnowledgeBaseResponse"), exports);
 __exportStar(require("./KnowledgeBaseType"), exports);
 __exportStar(require("./KnowledgeBaseRefreshFrequency"), exports);
-__exportStar(require("./KnowledgeBasePatchRequest"), exports);
+__exportStar(require("./KnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./KnowledgeBaseVersion"), exports);
 __exportStar(require("./KnowledgeBaseVersionType"), exports);
 __exportStar(require("./KnowledgeBaseVersionStatus"), exports);
@@ -27,6 +27,7 @@ __exportStar(require("./KnowledgeBaseVersionFinalizeStatus"), exports);
 __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./BaseKnowledgeDocument"), exports);
 __exportStar(require("./KnowledgeDocumentContentType"), exports);
+__exportStar(require("./KnowledgeDeleteRequest"), exports);
 __exportStar(require("./KnowledgeDocumentRequest"), exports);
 __exportStar(require("./KnowledgeDocumentResponse"), exports);
 __exportStar(require("./KnowledgeBaseField"), exports);
@@ -38,3 +39,4 @@ __exportStar(require("./KnowledgeBasesResponse"), exports);
 __exportStar(require("./KnowledgeDocumentSearchRequest"), exports);
 __exportStar(require("./KnowledgeDocumentSearchResponse"), exports);
 __exportStar(require("./KnowledgeDocumentsResponse"), exports);
+__exportStar(require("./KnowledgeBaseVersionsListResponse"), exports);