mavenagi 1.0.15 → 1.2.0

package/dist/api/resources/commons/types/ConversationResponse.d.ts

@@ -13,6 +13,8 @@ import * as MavenAGI from "../../../index";
  *             type: MavenAGI.EntityType.Conversation
  *         },
  *         deleted: false,
+ *         open: false,
+ *         llmEnabled: true,
  *         analysis: {
  *             resolutionStatus: "Resolved",
  *             sentiment: MavenAGI.Sentiment.Positive,
@@ -31,6 +33,7 @@ import * as MavenAGI from "../../../index";
  *         },
  *         metadata: {},
  *         allMetadata: {},
+ *         attachments: [],
  *         messages: [{
  *                 type: "user",
  *                 userMessageType: MavenAGI.UserConversationMessageType.User,
@@ -41,12 +44,16 @@ import * as MavenAGI from "../../../index";
  *                     agentId: "support",
  *                     type: MavenAGI.EntityType.ConversationMessage
  *                 },
+ *                 status: MavenAGI.MessageStatus.Unknown,
  *                 userId: {
  *                     referenceId: "user-0"
  *                 },
  *                 text: "How do I reset my password?",
  *                 attachments: [{
- *                         url: "https://example.com/attachment-0"
+ *                         url: "https://example.com/attachment-0",
+ *                         type: "image/png",
+ *                         status: MavenAGI.AttachmentStatus.Accepted,
+ *                         sizeBytes: 1234
  *                     }]
  *             }, {
  *                 type: "bot",
@@ -58,7 +65,7 @@ import * as MavenAGI from "../../../index";
  *                     agentId: "support",
  *                     type: MavenAGI.EntityType.ConversationMessage
  *                 },
- *                 status: MavenAGI.BotMessageStatus.Sent,
+ *                 status: MavenAGI.MessageStatus.Sent,
  *                 responses: [{
  *                         type: "text",
  *                         text: "Hi! Go to acme.com/reset-password"
@@ -73,4 +80,10 @@ import * as MavenAGI from "../../../index";
 export interface ConversationResponse extends MavenAGI.BaseConversationResponse {
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageResponse[];
+    /**
+     * The attachments associated with this conversation. Additional attachments may be associated to individual messages.
+     *
+     * Message attachments are included in LLM context, conversation attachments are not.
+     */
+    attachments: MavenAGI.AttachmentResponse[];
 }

package/dist/api/resources/commons/types/DocumentInformation.d.ts

@@ -3,6 +3,8 @@
  */
 import * as MavenAGI from "../../../index";
 export interface DocumentInformation {
+    /** Unique identifier for the knowledge base. */
+    knowledgeBaseId: MavenAGI.EntityIdWithoutAgent;
     /** Unique identifier for the document. */
     documentId: MavenAGI.EntityIdWithoutAgent;
     /** Title of the document. */

package/dist/api/resources/commons/types/EntityType.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type EntityType = "AGENT" | "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_BASE_VERSION" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "EVENT" | "EVENT_TRIGGER" | "USER_PROFILE" | "FEEDBACK" | "INBOX_ITEM" | "INBOX_ITEM_FIX";
+export type EntityType = "AGENT" | "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_BASE_VERSION" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "EVENT" | "EVENT_TRIGGER" | "USER_PROFILE" | "FEEDBACK" | "INBOX_ITEM" | "INBOX_ITEM_FIX" | "SEGMENT";
 export declare const EntityType: {
     readonly Agent: "AGENT";
     readonly Conversation: "CONVERSATION";
@@ -17,4 +17,5 @@ export declare const EntityType: {
     readonly Feedback: "FEEDBACK";
     readonly InboxItem: "INBOX_ITEM";
     readonly InboxItemFix: "INBOX_ITEM_FIX";
+    readonly Segment: "SEGMENT";
 };

package/dist/api/resources/commons/types/EntityType.js

@@ -19,4 +19,5 @@ exports.EntityType = {
     Feedback: "FEEDBACK",
     InboxItem: "INBOX_ITEM",
     InboxItemFix: "INBOX_ITEM_FIX",
+    Segment: "SEGMENT",
 };

package/dist/api/resources/commons/types/InboxItem.d.ts

@@ -2,17 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export type InboxItem = MavenAGI.InboxItem.DuplicateKnowledgeBase | MavenAGI.InboxItem.DuplicateDocuments | MavenAGI.InboxItem.KnowledgeBaseAlert | MavenAGI.InboxItem.MissingKnowledge;
+export type InboxItem = MavenAGI.InboxItem.DuplicateDocuments | MavenAGI.InboxItem.MissingKnowledge;
 export declare namespace InboxItem {
-    interface DuplicateKnowledgeBase extends MavenAGI.InboxItemDuplicateKnowledgeBase {
-        type: "duplicateKnowledgeBase";
-    }
     interface DuplicateDocuments extends MavenAGI.InboxItemDuplicateDocuments {
         type: "duplicateDocuments";
     }
-    interface KnowledgeBaseAlert extends MavenAGI.InboxItemKnowledgeBaseAlert {
-        type: "knowledgeBaseAlert";
-    }
     interface MissingKnowledge extends MavenAGI.InboxItemMissingKnowledge {
         type: "missingKnowledge";
     }

package/dist/api/resources/commons/types/InboxItemBase.d.ts

@@ -11,4 +11,6 @@ export interface InboxItemBase {
     updatedAt: Date;
     /** Status of the inbox item. */
     status: MavenAGI.InboxItemStatus;
+    /** Severity of the inbox item. */
+    severity: MavenAGI.InboxItemSeverity;
 }

package/dist/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts

@@ -8,7 +8,7 @@ export interface InboxItemDuplicateDocuments extends MavenAGI.InboxItemBase {
     /** List of fixes associated with the inbox item. */
     otherFixes: MavenAGI.InboxItemFixDeactivateDocument[];
     /** Information about the source document associated with the inbox item. */
-    sourceDocument?: MavenAGI.DocumentInformation;
+    sourceDocument: MavenAGI.DocumentInformation;
     /** List of Document information objects related to the inbox item. */
     documents: MavenAGI.DocumentInformation[];
 }

package/dist/api/resources/commons/types/InboxItemFix.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export type InboxItemFix = MavenAGI.InboxItemFix.AddDocument | MavenAGI.InboxItemFix.DeactivateDocument | MavenAGI.InboxItemFix.DeactivateKnowledgeBase;
+export type InboxItemFix = MavenAGI.InboxItemFix.AddDocument | MavenAGI.InboxItemFix.DeactivateDocument;
 export declare namespace InboxItemFix {
     interface AddDocument extends MavenAGI.InboxItemFixAddDocument {
         type: "addDocument";
@@ -10,7 +10,4 @@ export declare namespace InboxItemFix {
     interface DeactivateDocument extends MavenAGI.InboxItemFixDeactivateDocument {
         type: "deactivateDocument";
     }
-    interface DeactivateKnowledgeBase extends MavenAGI.InboxItemFixDeactivateKnowledgeBase {
-        type: "deactivateKnowledgeBase";
-    }
 }

package/dist/api/resources/commons/types/InboxItemSeverity.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type InboxItemSeverity = "LOW" | "MEDIUM" | "HIGH";
+export declare const InboxItemSeverity: {
+    readonly Low: "LOW";
+    readonly Medium: "MEDIUM";
+    readonly High: "HIGH";
+};

package/dist/api/resources/commons/types/InboxItemSeverity.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InboxItemSeverity = void 0;
+exports.InboxItemSeverity = {
+    Low: "LOW",
+    Medium: "MEDIUM",
+    High: "HIGH",
+};

package/dist/api/resources/commons/types/InboxItemType.d.ts

@@ -5,18 +5,10 @@ export type InboxItemType =
 /**
  * The inbox item is a duplicate document. */
 "DUPLICATE_DOCUMENT"
-/**
- * The inbox item is a duplicate knowledge base. */
- | "DUPLICATE_KNOWLEDGE_BASE"
 /**
  * The inbox item is missing knowledge. */
- | "MISSING_KNOWLEDGE"
-/**
- * The inbox item is related to a low quality knowledge base. */
- | "LOW_QUALITY_KNOWLEDGE_BASE";
+ | "MISSING_KNOWLEDGE";
 export declare const InboxItemType: {
     readonly DuplicateDocument: "DUPLICATE_DOCUMENT";
-    readonly DuplicateKnowledgeBase: "DUPLICATE_KNOWLEDGE_BASE";
     readonly MissingKnowledge: "MISSING_KNOWLEDGE";
-    readonly LowQualityKnowledgeBase: "LOW_QUALITY_KNOWLEDGE_BASE";
 };

package/dist/api/resources/commons/types/InboxItemType.js

@@ -6,7 +6,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InboxItemType = void 0;
 exports.InboxItemType = {
     DuplicateDocument: "DUPLICATE_DOCUMENT",
-    DuplicateKnowledgeBase: "DUPLICATE_KNOWLEDGE_BASE",
     MissingKnowledge: "MISSING_KNOWLEDGE",
-    LowQualityKnowledgeBase: "LOW_QUALITY_KNOWLEDGE_BASE",
 };

package/dist/api/resources/commons/types/LlmInclusionStatus.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type LlmInclusionStatus = "ALWAYS" | "WHEN_RELEVANT" | "NEVER";
+export declare const LlmInclusionStatus: {
+    readonly Always: "ALWAYS";
+    readonly WhenRelevant: "WHEN_RELEVANT";
+    readonly Never: "NEVER";
+};

package/dist/api/resources/commons/types/LlmInclusionStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LlmInclusionStatus = void 0;
+exports.LlmInclusionStatus = {
+    Always: "ALWAYS",
+    WhenRelevant: "WHEN_RELEVANT",
+    Never: "NEVER",
+};

package/dist/api/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * The delivery status of the bot message.
+ * The delivery status of the message.
  *
  * * `SENDING`: The message is being streamed to the user.
  * * `SENT`: The message has been sent to the user.
@@ -11,8 +11,8 @@
  * * `FAILED`: The message generating or sending encountered an error.
  * * `UNKNOWN`: The message status is unknown.
  */
-export type BotMessageStatus = "SENDING" | "SENT" | "REJECTED" | "CANCELED" | "FAILED" | "UNKNOWN";
-export declare const BotMessageStatus: {
+export type MessageStatus = "SENDING" | "SENT" | "REJECTED" | "CANCELED" | "FAILED" | "UNKNOWN";
+export declare const MessageStatus: {
     readonly Sending: "SENDING";
     readonly Sent: "SENT";
     readonly Rejected: "REJECTED";

package/{api/resources/commons/types/BotMessageStatus.js → dist/api/resources/commons/types/MessageStatus.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BotMessageStatus = void 0;
-exports.BotMessageStatus = {
+exports.MessageStatus = void 0;
+exports.MessageStatus = {
     Sending: "SENDING",
     Sent: "SENT",
     Rejected: "REJECTED",

package/dist/api/resources/commons/types/ResponseConfig.d.ts

@@ -4,15 +4,13 @@
 import * as MavenAGI from "../../../index";
 export interface ResponseConfig {
     /**
-     * List of capabilities supported by the caller. Defaults to [MARKDOWN, FORMS, IMAGES].
+     * List of capabilities supported by the caller. Defaults to `[MARKDOWN, FORMS, IMAGES]`.
      *
-     * MARKDOWN: Whether the response should include markdown formatting. If not provided, the response will be plain text. Not respected while streaming.
-     *
-     * FORMS: Whether the response should include forms. If provided, the caller needs to render action forms when returned from the ask API and allow submission of the forms with the submitActionForm API. If not provided, then actions which require user interaction will not be considered by the LLM. Removing this capability is recommended for surfaces which can not display UI (e.g. SMS, voice).
-     *
-     * IMAGES: Whether the response should include images. Not yet supported.
-     *
-     * CHARTS_HIGHCHARTS_TS: Whether the response should include a Highcharts typescript chart if applicable.
+     * - `MARKDOWN`: Whether the response should include markdown formatting. If not provided, the response will be plain text. Not respected while streaming.
+     * - `FORMS`: Whether the response should include forms. If provided, the caller needs to render action forms when returned from the ask API and allow submission of the forms with the submitActionForm API. If not provided, then actions which require user interaction will not be considered by the LLM. Removing this capability is recommended for surfaces which can not display UI (e.g. SMS, voice).
+     * - `IMAGES`: Whether the response should include images. Not yet supported.
+     * - `CHARTS_HIGHCHARTS_TS`: Whether the response should include a Highcharts typescript chart if applicable.
+     * - `ASYNC`: Whether the app that created this conversation supports asynchronous message delivery. If provided, messages may be sent to the app via the `handleMessage` function.
      */
     capabilities: MavenAGI.Capability[];
     /** Whether the response is for an human agent (true) or an end user (false). Defaults to false. */

package/dist/api/resources/commons/types/UserMessage.d.ts

@@ -8,7 +8,27 @@ export interface UserMessage extends MavenAGI.UserMessageBase {
     /** The language of the message in ISO 639-1 code format */
     language?: string;
     /** The attachments associated with the message */
-    attachments: MavenAGI.UserMessageAttachment[];
+    attachments: MavenAGI.AttachmentResponse[];
+    /** The ID of the agent user that created this message. More detail can be fetched via the agent user APIs. Will be empty only for legacy conversations. */
+    agentUserId?: string;
     /** The display name of the user who created this message. Only available for users who have saved name information. */
     userDisplayName?: string;
+    /**
+     * The delivery status of the message. Only applicable to messages sent via the deliverMessage API.
+     * All other messages have an `UNKNOWN` status.
+     *
+     * * `SENT`: The message has been sent to the user.
+     * * `FAILED`: The message sending encountered an error.
+     * * `UNKNOWN`: The message status is unknown.
+     */
+    status: MavenAGI.MessageStatus;
+    /**
+     * Only present on newer messaged where `userMessageType` is `USER`.
+     * Indicates the state of the answer to the user message.
+     *
+     * - `NOT_ASKED`: An answer was not requested for this user message.
+     * - `LLM_ENABLED`: An answer was requested for this user message and the LLM was enabled.
+     * - `LLM_DISABLED`: An answer was requested for this user message and the LLM was disabled.
+     */
+    responseState?: MavenAGI.UserMessageResponseState;
 }

package/dist/api/resources/commons/types/UserMessageResponseState.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UserMessageResponseState = "NOT_ASKED" | "LLM_ENABLED" | "LLM_DISABLED";
+export declare const UserMessageResponseState: {
+    readonly NotAsked: "NOT_ASKED";
+    readonly LlmEnabled: "LLM_ENABLED";
+    readonly LlmDisabled: "LLM_DISABLED";
+};

package/dist/api/resources/commons/types/UserMessageResponseState.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserMessageResponseState = void 0;
+exports.UserMessageResponseState = {
+    NotAsked: "NOT_ASKED",
+    LlmEnabled: "LLM_ENABLED",
+    LlmDisabled: "LLM_DISABLED",
+};

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

@@ -34,10 +34,14 @@ export * from "./ConversationMessageResponse";
 export * from "./ConversationMessageBase";
 export * from "./UserConversationMessageType";
 export * from "./UserMessageBase";
-export * from "./UserMessageAttachment";
+export * from "./AttachmentStatus";
+export * from "./BaseAttachment";
+export * from "./AttachmentRequest";
+export * from "./AttachmentResponse";
 export * from "./UserMessage";
+export * from "./UserMessageResponseState";
 export * from "./BotConversationMessageType";
-export * from "./BotMessageStatus";
+export * from "./MessageStatus";
 export * from "./BotMessage";
 export * from "./Source";
 export * from "./BotResponseMetadata";
@@ -48,8 +52,20 @@ export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./BotChartResponse";
 export * from "./ChartSpecSchema";
+export * from "./BotLogic";
+export * from "./BotLogicItem";
+export * from "./BotLogicSegmentsItem";
+export * from "./BotLogicUserItem";
+export * from "./BotLogicActionItem";
+export * from "./BotLogicActionReviewedDetail";
+export * from "./BotLogicActionExecutedDetail";
+export * from "./BotLogicFormSubmissionItem";
+export * from "./BotLogicKnowledgeItem";
+export * from "./BotLogicKnowledgeDetail";
+export * from "./BotLogicSafetyItem";
 export * from "./ActionBase";
 export * from "./ActionParameter";
+export * from "./LlmInclusionStatus";
 export * from "./ActionResponse";
 export * from "./Precondition";
 export * from "./PreconditionOperator";
@@ -62,19 +78,16 @@ export * from "./PreconditionGroupOperator";
 export * from "./PreconditionGroup";
 export * from "./TagsPrecondition";
 export * from "./ConversationExecutedActionPrecondition";
-export * from "./KnowledgeBaseInformation";
 export * from "./DocumentInformation";
 export * from "./InboxItemStatus";
 export * from "./InboxItemType";
+export * from "./InboxItemSeverity";
 export * from "./InboxItem";
 export * from "./InboxItemBase";
-export * from "./InboxItemKnowledgeBaseAlert";
-export * from "./InboxItemDuplicateKnowledgeBase";
 export * from "./InboxItemDuplicateDocuments";
 export * from "./InboxItemMissingKnowledge";
 export * from "./InboxItemFix";
 export * from "./InboxItemFixBase";
 export * from "./InboxItemFixAddDocument";
 export * from "./InboxItemFixDeactivateDocument";
-export * from "./InboxItemFixDeactivateKnowledgeBase";
 export * from "./NumberRange";

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

@@ -50,10 +50,14 @@ __exportStar(require("./ConversationMessageResponse"), exports);
 __exportStar(require("./ConversationMessageBase"), exports);
 __exportStar(require("./UserConversationMessageType"), exports);
 __exportStar(require("./UserMessageBase"), exports);
-__exportStar(require("./UserMessageAttachment"), exports);
+__exportStar(require("./AttachmentStatus"), exports);
+__exportStar(require("./BaseAttachment"), exports);
+__exportStar(require("./AttachmentRequest"), exports);
+__exportStar(require("./AttachmentResponse"), exports);
 __exportStar(require("./UserMessage"), exports);
+__exportStar(require("./UserMessageResponseState"), exports);
 __exportStar(require("./BotConversationMessageType"), exports);
-__exportStar(require("./BotMessageStatus"), exports);
+__exportStar(require("./MessageStatus"), exports);
 __exportStar(require("./BotMessage"), exports);
 __exportStar(require("./Source"), exports);
 __exportStar(require("./BotResponseMetadata"), exports);
@@ -64,8 +68,20 @@ __exportStar(require("./BotActionFormResponse"), exports);
 __exportStar(require("./ActionFormField"), exports);
 __exportStar(require("./BotChartResponse"), exports);
 __exportStar(require("./ChartSpecSchema"), exports);
+__exportStar(require("./BotLogic"), exports);
+__exportStar(require("./BotLogicItem"), exports);
+__exportStar(require("./BotLogicSegmentsItem"), exports);
+__exportStar(require("./BotLogicUserItem"), exports);
+__exportStar(require("./BotLogicActionItem"), exports);
+__exportStar(require("./BotLogicActionReviewedDetail"), exports);
+__exportStar(require("./BotLogicActionExecutedDetail"), exports);
+__exportStar(require("./BotLogicFormSubmissionItem"), exports);
+__exportStar(require("./BotLogicKnowledgeItem"), exports);
+__exportStar(require("./BotLogicKnowledgeDetail"), exports);
+__exportStar(require("./BotLogicSafetyItem"), exports);
 __exportStar(require("./ActionBase"), exports);
 __exportStar(require("./ActionParameter"), exports);
+__exportStar(require("./LlmInclusionStatus"), exports);
 __exportStar(require("./ActionResponse"), exports);
 __exportStar(require("./Precondition"), exports);
 __exportStar(require("./PreconditionOperator"), exports);
@@ -78,19 +94,16 @@ __exportStar(require("./PreconditionGroupOperator"), exports);
 __exportStar(require("./PreconditionGroup"), exports);
 __exportStar(require("./TagsPrecondition"), exports);
 __exportStar(require("./ConversationExecutedActionPrecondition"), exports);
-__exportStar(require("./KnowledgeBaseInformation"), exports);
 __exportStar(require("./DocumentInformation"), exports);
 __exportStar(require("./InboxItemStatus"), exports);
 __exportStar(require("./InboxItemType"), exports);
+__exportStar(require("./InboxItemSeverity"), exports);
 __exportStar(require("./InboxItem"), exports);
 __exportStar(require("./InboxItemBase"), exports);
-__exportStar(require("./InboxItemKnowledgeBaseAlert"), exports);
-__exportStar(require("./InboxItemDuplicateKnowledgeBase"), exports);
 __exportStar(require("./InboxItemDuplicateDocuments"), exports);
 __exportStar(require("./InboxItemMissingKnowledge"), exports);
 __exportStar(require("./InboxItemFix"), exports);
 __exportStar(require("./InboxItemFixBase"), exports);
 __exportStar(require("./InboxItemFixAddDocument"), exports);
 __exportStar(require("./InboxItemFixDeactivateDocument"), exports);
-__exportStar(require("./InboxItemFixDeactivateKnowledgeBase"), exports);
 __exportStar(require("./NumberRange"), exports);