mavenagi 0.0.0-alpha.7 → 0.0.0-alpha.8

package/api/resources/knowledge/client/Client.d.ts

@@ -23,9 +23,9 @@ export declare class Knowledge {
     protected readonly _options: Knowledge.Options;
     constructor(_options: Knowledge.Options);
     /**
-     * Create a new knowledge base.
+     * Update a knowledge base or create it if it doesn't exist.
      *
-     * @param {MavenAGI.KnowledgeBase} request
+     * @param {MavenAGI.KnowledgeBaseRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -33,18 +33,19 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeBase({
-     *         displayName: "string",
-     *         type: MavenAGI.KnowledgeBaseType.Api,
-     *         url: "string",
-     *         knowledgeBaseId: "string"
+     *     await client.knowledge.createOrUpdateKnowledgeBase({
+     *         knowledgeBaseId: {
+     *             referenceId: "help-center"
+     *         },
+     *         name: "Help center",
+     *         type: MavenAGI.KnowledgeBaseType.Api
      *     })
      */
-    createKnowledgeBase(request: MavenAGI.KnowledgeBase, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
+    createOrUpdateKnowledgeBase(request: MavenAGI.KnowledgeBaseRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseResponse>;
     /**
-     * Get an existing knowledge base.
+     * Get an existing knowledge base by its supplied ID
      *
-     * @param {string} knowledgeBaseId - The ID of the knowledge base to get
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -52,12 +53,13 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.getKnowledgeBase("string")
+     *     await client.knowledge.getKnowledgeBase("help-center")
      */
-    getKnowledgeBase(knowledgeBaseId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
+    getKnowledgeBase(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseResponse>;
     /**
      * Create a new knowledge base version. Only supported on API knowledge bases. Will throw an exception if there is an existing version in progress.
      *
+     * @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 {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -66,16 +68,15 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeBaseVersion({
-     *         knowledgeBaseId: "string",
+     *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
      *         type: MavenAGI.KnowledgeBaseVersionType.Full
      *     })
      */
-    createKnowledgeBaseVersion(request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
+    createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
     /**
      * Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
      *
-     * @param {MavenAGI.KnowledgeBaseId} request
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -83,14 +84,13 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.finalizeKnowledgeBaseVersion({
-     *         knowledgeBaseId: "string"
-     *     })
+     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center")
      */
-    finalizeKnowledgeBaseVersion(request: MavenAGI.KnowledgeBaseId, requestOptions?: Knowledge.RequestOptions): Promise<void>;
+    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<void>;
     /**
      * 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.
      *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -99,23 +99,20 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeDocument({
-     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
-     *         content: "string",
-     *         title: "string",
-     *         url: "string",
-     *         language: "string",
-     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         author: "string",
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
+     *     await client.knowledge.createKnowledgeDocument("help-center", {
+     *         knowledgeDocumentId: {
+     *             referenceId: "getting-started"
+     *         },
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+     *         title: "Getting started"
      *     })
      */
-    createKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
+    createKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
-     * 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.
+     * 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.
      *
+     * @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 {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -124,24 +121,21 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.updateKnowledgeDocument({
-     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
-     *         content: "string",
-     *         title: "string",
-     *         url: "string",
-     *         language: "string",
-     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         author: "string",
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
+     *     await client.knowledge.updateKnowledgeDocument("help-center", {
+     *         knowledgeDocumentId: {
+     *             referenceId: "getting-started"
+     *         },
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+     *         title: "Getting started"
      *     })
      */
-    updateKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
+    updateKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
-     * 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.
+     * 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.
      *
-     * @param {MavenAGI.KnowledgeDocumentId} 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 {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -149,11 +143,8 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.deleteKnowledgeDocument({
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
-     *     })
+     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
      */
-    deleteKnowledgeDocument(request: MavenAGI.KnowledgeDocumentId, requestOptions?: Knowledge.RequestOptions): Promise<void>;
+    deleteKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -21,9 +21,9 @@ export class Knowledge {
         this._options = _options;
     }
     /**
-     * Create a new knowledge base.
+     * Update a knowledge base or create it if it doesn't exist.
      *
-     * @param {MavenAGI.KnowledgeBase} request
+     * @param {MavenAGI.KnowledgeBaseRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -31,37 +31,38 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeBase({
-     *         displayName: "string",
-     *         type: MavenAGI.KnowledgeBaseType.Api,
-     *         url: "string",
-     *         knowledgeBaseId: "string"
+     *     await client.knowledge.createOrUpdateKnowledgeBase({
+     *         knowledgeBaseId: {
+     *             referenceId: "help-center"
+     *         },
+     *         name: "Help center",
+     *         type: MavenAGI.KnowledgeBaseType.Api
      *     })
      */
-    createKnowledgeBase(request, requestOptions) {
+    createOrUpdateKnowledgeBase(request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/knowledge"),
-                method: "POST",
+                method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Organization-Id": yield core.Supplier.get(this._options.organizationId),
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.KnowledgeBase.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                body: yield serializers.KnowledgeBaseRequest.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 yield serializers.KnowledgeBase.parseOrThrow(_response.body, {
+                return yield serializers.KnowledgeBaseResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -114,9 +115,9 @@ export class Knowledge {
         });
     }
     /**
-     * Get an existing knowledge base.
+     * Get an existing knowledge base by its supplied ID
      *
-     * @param {string} knowledgeBaseId - The ID of the knowledge base to get
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -124,13 +125,13 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.getKnowledgeBase("string")
+     *     await client.knowledge.getKnowledgeBase("help-center")
      */
-    getKnowledgeBase(knowledgeBaseId, requestOptions) {
+    getKnowledgeBase(knowledgeBaseReferenceId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseId)}`),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}`),
                 method: "GET",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -138,7 +139,7 @@ export class Knowledge {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -148,7 +149,7 @@ export class Knowledge {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.KnowledgeBase.parseOrThrow(_response.body, {
+                return yield serializers.KnowledgeBaseResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -203,6 +204,7 @@ export class Knowledge {
     /**
      * Create a new knowledge base version. Only supported on API knowledge bases. Will throw an exception if there is an existing version in progress.
      *
+     * @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 {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -211,16 +213,15 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeBaseVersion({
-     *         knowledgeBaseId: "string",
+     *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
      *         type: MavenAGI.KnowledgeBaseVersionType.Full
      *     })
      */
-    createKnowledgeBaseVersion(request, requestOptions) {
+    createKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/knowledge/version"),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/version`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -228,7 +229,7 @@ export class Knowledge {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -294,7 +295,7 @@ export class Knowledge {
     /**
      * Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
      *
-     * @param {MavenAGI.KnowledgeBaseId} request
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -302,15 +303,13 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.finalizeKnowledgeBaseVersion({
-     *         knowledgeBaseId: "string"
-     *     })
+     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center")
      */
-    finalizeKnowledgeBaseVersion(request, requestOptions) {
+    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/knowledge/version/finalize"),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/version/finalize`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -318,12 +317,11 @@ export class Knowledge {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.KnowledgeBaseId.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,
@@ -379,6 +377,7 @@ export 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.
      *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -387,24 +386,20 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeDocument({
-     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
-     *         content: "string",
-     *         title: "string",
-     *         url: "string",
-     *         language: "string",
-     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         author: "string",
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
+     *     await client.knowledge.createKnowledgeDocument("help-center", {
+     *         knowledgeDocumentId: {
+     *             referenceId: "getting-started"
+     *         },
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+     *         title: "Getting started"
      *     })
      */
-    createKnowledgeDocument(request, requestOptions) {
+    createKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/knowledge/document"),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/document`),
                 method: "POST",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -412,7 +407,7 @@ export class Knowledge {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -476,8 +471,9 @@ export class Knowledge {
         });
     }
     /**
-     * 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.
+     * 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.
      *
+     * @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 {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -486,24 +482,20 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.updateKnowledgeDocument({
-     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
-     *         content: "string",
-     *         title: "string",
-     *         url: "string",
-     *         language: "string",
-     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         author: "string",
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
+     *     await client.knowledge.updateKnowledgeDocument("help-center", {
+     *         knowledgeDocumentId: {
+     *             referenceId: "getting-started"
+     *         },
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+     *         title: "Getting started"
      *     })
      */
-    updateKnowledgeDocument(request, requestOptions) {
+    updateKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/knowledge/document"),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/document`),
                 method: "PUT",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -511,7 +503,7 @@ export class Knowledge {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -575,9 +567,10 @@ export class Knowledge {
         });
     }
     /**
-     * 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.
+     * 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.
      *
-     * @param {MavenAGI.KnowledgeDocumentId} 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 {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -585,16 +578,13 @@ export class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.deleteKnowledgeDocument({
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
-     *     })
+     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
      */
-    deleteKnowledgeDocument(request, requestOptions) {
+    deleteKnowledgeDocument(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/knowledge/document"),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/${encodeURIComponent(knowledgeDocumentReferenceId)}/document`),
                 method: "DELETE",
                 headers: {
                     Authorization: yield this._getAuthorizationHeader(),
@@ -602,12 +592,11 @@ export class Knowledge {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.KnowledgeDocumentId.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,

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

@@ -1,11 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MavenAGI from "../../../index";
-export interface BaseKnowledgeDocument extends MavenAGI.KnowledgeDocumentId {
+export interface BaseKnowledgeDocument {
     /** The title of the document. Will be shown as part of answers. */
     title: string;
-    /** The URL of the document. Should be visible to end users. Will be shown as part of answers. */
+    /** The URL of the document. Should be visible to end users. Will be shown as part of answers. Not used for crawling. */
     url?: string;
     /** The document language. Must be a valid ISO 639-1 language code. */
     language?: string;

package/{dist/api/resources/knowledge/types/KnowledgeBase.d.ts → api/resources/knowledge/types/KnowledgeBaseProperties.d.ts}

@@ -2,9 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface KnowledgeBase extends MavenAGI.KnowledgeBaseId {
+export interface KnowledgeBaseProperties {
     /** The name of the knowledge base */
-    displayName: string;
+    name: string;
     /** The type of the knowledge base. Can not be changed once created. */
     type: MavenAGI.KnowledgeBaseType;
     /** The URL to pull content from for RSS and URL knowledge bases. */

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         knowledgeBaseId: {
+ *             referenceId: "help-center"
+ *         },
+ *         name: "Help center",
+ *         type: MavenAGI.KnowledgeBaseType.Api
+ *     }
+ */
+export interface KnowledgeBaseRequest extends MavenAGI.KnowledgeBaseProperties {
+    /** ID that uniquely identifies this knowledge base */
+    knowledgeBaseId: MavenAGI.EntityIdBase;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         knowledgeBaseId: {
+ *             referenceId: "help-center",
+ *             appId: "readme",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.KnowledgeBase
+ *         },
+ *         name: "Help center",
+ *         type: MavenAGI.KnowledgeBaseType.Api
+ *     }
+ */
+export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties {
+    /** ID that uniquely identifies this knowledge base */
+    knowledgeBaseId: MavenAGI.EntityId;
+}

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

@@ -2,9 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         type: MavenAGI.KnowledgeBaseVersionType.Full
+ *     }
+ */
 export interface KnowledgeBaseVersion {
-    /** External ID of the knowledge base used to create a new version */
-    knowledgeBaseId: string;
     /** 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/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts

@@ -2,7 +2,20 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         knowledgeDocumentId: {
+ *             referenceId: "getting-started"
+ *         },
+ *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+ *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+ *         title: "Getting started"
+ *     }
+ */
 export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument {
+    /** ID that uniquely identifies this knowledge document within its knowledge base */
+    knowledgeDocumentId: MavenAGI.EntityIdBase;
     contentType: MavenAGI.KnowledgeDocumentContentType;
     /** 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;