mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.3

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

@@ -3,6 +3,7 @@
  */
 import * as MavenAGI from "../../../index";
 export interface UserMessage extends MavenAGI.ConversationMessageBase {
+    /** The text of the message. Cannot be empty */
     text: string;
     userMessageType: MavenAGI.UserConversationMessageType;
 }

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

@@ -13,12 +13,13 @@ export * from "./BotResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
+export * from "./ActionExecutionRequest";
+export * from "./ActionExecutionResponse";
 export * from "./ConversationContext";
 export * from "./ConversationMessageContext";
 export * from "./UserConversationMessageType";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
-export * from "./FeedbackType";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
 export * from "./AskStreamMetadataEvent";

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

@@ -13,12 +13,13 @@ export * from "./BotResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
+export * from "./ActionExecutionRequest";
+export * from "./ActionExecutionResponse";
 export * from "./ConversationContext";
 export * from "./ConversationMessageContext";
 export * from "./UserConversationMessageType";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
-export * from "./FeedbackType";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
 export * from "./AskStreamMetadataEvent";

package/api/resources/index.d.ts

@@ -1,3 +1,7 @@
+export * as actionSet from "./actionSet";
+export * from "./actionSet/types";
+export * as action from "./action";
+export * from "./action/types";
 export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
@@ -5,5 +9,3 @@ export * from "./conversation/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
 export * from "./commons/errors";
-export * from "./conversation/errors";
-export * from "./knowledge/errors";

package/api/resources/index.js

@@ -1,3 +1,7 @@
+export * as actionSet from "./actionSet";
+export * from "./actionSet/types";
+export * as action from "./action";
+export * from "./action/types";
 export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
@@ -5,5 +9,3 @@ export * from "./conversation/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
 export * from "./commons/errors";
-export * from "./conversation/errors";
-export * from "./knowledge/errors";

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

@@ -23,15 +23,17 @@ export declare class Knowledge {
     protected readonly _options: Knowledge.Options;
     constructor(_options: Knowledge.Options);
     /**
-     * Create knowledge base
+     * Create a new knowledge base.
      *
      * @param {MavenAGI.KnowledgeBase} 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({
+     *     await client.knowledge.createKnowledgeBase({
      *         displayName: "string",
      *         type: MavenAGI.KnowledgeBaseType.Api,
      *         url: "string",
@@ -40,54 +42,50 @@ export declare class Knowledge {
      */
     createKnowledgeBase(request: MavenAGI.KnowledgeBase, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
     /**
-     * Create a new knowledge base version. Only supported on API knowledge bases.
+     * 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 {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({
+     *     await client.knowledge.createKnowledgeBaseVersion({
      *         knowledgeBaseId: "string",
      *         type: MavenAGI.KnowledgeBaseVersionType.Full
      *     })
      */
     createKnowledgeBaseVersion(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 {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({
+     *     await client.knowledge.finalizeKnowledgeBaseVersion({
      *         knowledgeBaseId: "string"
      *     })
      */
     finalizeKnowledgeBaseVersion(request: MavenAGI.KnowledgeBaseId, 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 {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({
+     *     await client.knowledge.createKnowledgeDocument({
      *         title: "string",
      *         content: "string",
      *         url: "string",
@@ -101,18 +99,17 @@ export declare class Knowledge {
      */
     createKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
     /**
-     * Update knowledge document
+     * 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 {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({
+     *     await client.knowledge.updateKnowledgeDocument({
      *         title: "string",
      *         content: "string",
      *         url: "string",
@@ -126,18 +123,17 @@ export declare class Knowledge {
      */
     updateKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
     /**
-     * Delete knowledge document
+     * 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 {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({
+     *     await client.knowledge.deleteKnowledgeDocument({
      *         knowledgeBaseId: "string",
      *         documentId: "string"
      *     })