mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.4

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Capability = "MARKDOWN" | "FORMS";
+export declare const Capability: {
+    readonly Markdown: "MARKDOWN";
+    readonly Forms: "FORMS";
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const Capability = {
+    Markdown: "MARKDOWN",
+    Forms: "FORMS",
+};

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

@@ -7,4 +7,6 @@ export interface ConversationBase {
     id: string;
     /** The context of the conversation */
     context?: MavenAGI.ConversationContext;
+    /** Optional configurations for responses to this conversation */
+    responseConfig?: MavenAGI.ResponseConfig;
 }

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

@@ -2,11 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface FeedbackRequest {
-    /** The ID of the conversation message the feedback is about */
-    conversationMessageId: string;
-    /** The feedback text */
-    text: string;
-    /** The type of feedback */
-    type: MavenAGI.FeedbackType;
-}
+export declare type FeedbackRequest = MavenAGI.Feedback;

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ResponseConfig {
+    /** List of capabilities supported by the caller. Defaults to all */
+    capabilities?: MavenAGI.Capability[];
+    /** Whether the response is for an human agent (true) or an end user (false). Defaults to false. */
+    isCopilot?: boolean;
+    /** The desired response length. Defaults to ResponseLength.MEDIUM. */
+    responseLength?: MavenAGI.ResponseLength;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ResponseLength = "SHORT" | "MEDIUM" | "LONG";
+export declare const ResponseLength: {
+    readonly Short: "SHORT";
+    readonly Medium: "MEDIUM";
+    readonly Long: "LONG";
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const ResponseLength = {
+    Short: "SHORT",
+    Medium: "MEDIUM",
+    Long: "LONG",
+};

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

@@ -1,4 +1,7 @@
 export * from "./AskRequest";
+export * from "./ResponseConfig";
+export * from "./Capability";
+export * from "./ResponseLength";
 export * from "./GenerateMavenSuggestionsRequest";
 export * from "./ConversationBase";
 export * from "./ConversationResponse";
@@ -13,12 +16,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

@@ -1,4 +1,7 @@
 export * from "./AskRequest";
+export * from "./ResponseConfig";
+export * from "./Capability";
+export * from "./ResponseLength";
 export * from "./GenerateMavenSuggestionsRequest";
 export * from "./ConversationBase";
 export * from "./ConversationResponse";
@@ -13,12 +16,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,9 +1,12 @@
+export * as actions from "./actions";
+export * from "./actions/types";
 export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
 export * from "./conversation/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
+export * as triggers from "./triggers";
+export * from "./triggers/types";
 export * from "./commons/errors";
-export * from "./conversation/errors";
-export * from "./knowledge/errors";
+export * as user from "./user";

package/api/resources/index.js

@@ -1,9 +1,12 @@
+export * as actions from "./actions";
+export * from "./actions/types";
 export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
 export * from "./conversation/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
+export * as triggers from "./triggers";
+export * from "./triggers/types";
 export * from "./commons/errors";
-export * from "./conversation/errors";
-export * from "./knowledge/errors";
+export * as user from "./user";

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,56 +42,67 @@ 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.
+     * Get an existing knowledge base.
+     *
+     * @param {string} knowledgeBaseId - The ID of the knowledge base to get
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.getKnowledgeBase("string")
+     */
+    getKnowledgeBase(knowledgeBaseId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
+    /**
+     * 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 {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",
+     *     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"),
@@ -99,22 +112,22 @@ export declare class Knowledge {
      *         documentId: "string"
      *     })
      */
-    createKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
+    createKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
-     * 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 {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",
+     *     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"),
@@ -124,20 +137,19 @@ export declare class Knowledge {
      *         documentId: "string"
      *     })
      */
-    updateKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
+    updateKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
-     * 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"
      *     })