mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.20

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

@@ -9,139 +9,151 @@ export declare namespace Knowledge {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class Knowledge {
     protected readonly _options: Knowledge.Options;
     constructor(_options: Knowledge.Options);
     /**
-     * Create 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.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.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>;
     /**
-     * Create a new knowledge base version. Only supported on API knowledge bases.
+     * Get an existing knowledge base by its supplied ID
      *
+     * @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}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.getKnowledgeBase("help-center")
+     */
+    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.
      *
-     * @throws {@link MavenAGI.VersionInProgressError}
-     * @throws {@link MavenAGI.IneligibleKnowledgeBaseError}
-     * @throws {@link MavenAGI.KnowledgeBaseNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.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 a knowledge base version. Required to indicate a version is complete.
+     * 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.VersionNotInProgressError}
-     * @throws {@link MavenAGI.IneligibleKnowledgeBaseError}
-     * @throws {@link MavenAGI.KnowledgeBaseNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.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
+     * 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 {MavenAGI.KnowledgeDocument} request
+     * @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.
      *
-     * @throws {@link MavenAGI.VersionNotInProgressError}
-     * @throws {@link MavenAGI.IneligibleKnowledgeBaseError}
-     * @throws {@link MavenAGI.KnowledgeBaseNotFoundError}
-     * @throws {@link MavenAGI.DocumentCreationError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.knowledge.createKnowledgeDocument({
-     *         title: "string",
-     *         content: "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.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
+    createKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
-     * Update knowledge document
+     * 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 {MavenAGI.KnowledgeDocument} request
+     * @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.
      *
-     * @throws {@link MavenAGI.VersionNotInProgressError}
-     * @throws {@link MavenAGI.KnowledgeBaseNotFoundError}
-     * @throws {@link MavenAGI.DocumentNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.knowledge.updateKnowledgeDocument({
-     *         title: "string",
-     *         content: "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.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
+    updateKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
-     * Delete knowledge document
+     * 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.VersionNotInProgressError}
-     * @throws {@link MavenAGI.KnowledgeBaseNotFoundError}
-     * @throws {@link MavenAGI.DocumentNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.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>;
 }