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

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

@@ -1,3 +1,2 @@
 export * from "./types";
-export * from "./errors";
 export * from "./client";

package/api/resources/conversation/index.js

@@ -1,3 +1,2 @@
 export * from "./types";
-export * from "./errors";
 export * from "./client";

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

@@ -6,4 +6,5 @@ export interface ActionFormField {
     label: string;
     description: string;
     required: boolean;
+    suggestion?: string;
 }

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

@@ -2,11 +2,23 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         conversationMessageId: {
+ *             referenceId: "message-1"
+ *         },
+ *         userId: {
+ *             referenceId: "user-1"
+ *         },
+ *         text: "How do I reset my password?"
+ *     }
+ */
 export interface AskRequest {
     /** Externally supplied ID to uniquely identify this message within the conversation */
-    id: string;
+    conversationMessageId: MavenAGI.EntityIdBase;
+    /** Externally supplied ID to uniquely identify the user that created this message */
+    userId: MavenAGI.EntityIdBase;
     /** The text of the message */
     text: string;
-    /** The context of the message */
-    context?: MavenAGI.ConversationMessageContext;
 }

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AskStreamActionEvent extends MavenAGI.BotActionFormResponse {
+}

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

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

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

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as MavenAGI from "../../../index";
 export interface AskStreamStartEvent {
-    id: string;
+    conversationMessageId: MavenAGI.EntityId;
 }

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

@@ -2,5 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface AskStreamTextEvent {
+    /** A partial response to the question. All stream text events should be concatenated to form the full response. */
     contents: string;
 }

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

@@ -3,6 +3,7 @@
  */
 import * as MavenAGI from "../../../index";
 export interface BotActionFormResponse {
+    id: string;
     formLabel: string;
     fields: MavenAGI.ActionFormField[];
     submitLabel: string;

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

@@ -3,6 +3,8 @@
  */
 import * as MavenAGI from "../../../index";
 export interface BotMessage extends MavenAGI.ConversationMessageBase {
+    /** The ID that uniquely identifies this message within the conversation */
+    conversationMessageId: MavenAGI.EntityId;
     botMessageType: MavenAGI.BotConversationMessageType;
     responses: MavenAGI.BotResponse[];
     metadata: MavenAGI.BotResponseMetadata;

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Capability = 
+/**
+ * Whether the response should include markdown formatting. If not provided, the response will be plain text. */
+"MARKDOWN"
+/**
+ * Whether the response should include forms. Not yet supported. */
+ | "FORMS"
+/**
+ * Whether the response should include images. Not yet supported. */
+ | "IMAGES";
+export declare const Capability: {
+    readonly Markdown: "MARKDOWN";
+    readonly Forms: "FORMS";
+    readonly Images: "IMAGES";
+};

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

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

package/{dist/api/resources/knowledge/types/IdBody.d.ts → api/resources/conversation/types/CategorizationResponse.d.ts}

@@ -1,6 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface IdBody {
-    requestedId: string;
+export interface CategorizationResponse {
+    category?: string;
 }

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationAnalysis {
+    /** Generated user request summary of the conversation */
+    userRequest?: string;
+    /** Generated agent response summary of the conversation */
+    agentResponse?: string;
+    /** Generated sentiment of the conversation */
+    sentiment?: MavenAGI.Sentiment;
+}

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

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

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

@@ -3,8 +3,18 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ConversationBase {
-    /** Externally supplied ID to uniquely identify this conversation */
-    id: string;
-    /** The context of the conversation */
-    context?: MavenAGI.ConversationContext;
+    /** Optional configurations for responses to this conversation */
+    responseConfig?: MavenAGI.ResponseConfig;
+    /** The subject of the conversation */
+    subject?: string;
+    /** The url of the conversation */
+    url?: string;
+    /** The date and time the conversation was created */
+    createdAt?: Date;
+    /** The date and time the conversation was last updated */
+    updatedAt?: Date;
+    /** The tags of the conversation. Used for filtering in Agent Designer. */
+    tags?: Set<string>;
+    /** The metadata of the conversation. */
+    metadata?: Record<string, string>;
 }

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

@@ -1,10 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as MavenAGI from "../../../index";
 export interface ConversationMessageBase {
-    /** Externally supplied ID to uniquely identify this message within the conversation */
-    id: string;
-    /** The context of the message */
-    context?: MavenAGI.ConversationMessageContext;
+    /** The date and time the conversation was created */
+    createdAt?: Date;
+    /** The date and time the conversation was last updated */
+    updatedAt?: Date;
 }

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

@@ -2,5 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface ConversationMessageRequest extends MavenAGI.UserMessage {
+export interface ConversationMessageRequest extends MavenAGI.UserMessageBase {
+    /** The ID that uniquely identifies this message within the conversation */
+    conversationMessageId: MavenAGI.EntityIdBase;
 }

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

@@ -3,6 +3,8 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ConversationRequest extends MavenAGI.ConversationBase {
+    /** An externally supplied ID to uniquely identify this conversation */
+    conversationId: MavenAGI.EntityIdBase;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageRequest[];
 }

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

@@ -3,6 +3,10 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ConversationResponse extends MavenAGI.ConversationBase {
+    /** The ID that uniquely identifies this conversation */
+    conversationId: MavenAGI.EntityId;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageResponse[];
+    /** An analysis of the conversation. */
+    analysis: MavenAGI.ConversationAnalysis;
 }

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

@@ -2,11 +2,11 @@
  * 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 interface FeedbackRequest extends MavenAGI.FeedbackBase {
+    /** The ID that uniquely identifies this feedback */
+    feedbackId: MavenAGI.EntityIdBase;
+    /** The ID that uniquely identifies the the conversation the feedback is about */
+    conversationId: MavenAGI.EntityIdBase;
+    /** The ID that uniquely identifies the message within the conversation the feedback is about */
+    conversationMessageId: MavenAGI.EntityIdBase;
 }

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

@@ -1,7 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as MavenAGI from "../../../index";
 export interface GenerateMavenSuggestionsRequest {
     /** The message ids to generate a suggested response for. One suggestion will be generated for each message id. */
-    messageIds: string[];
+    conversationMessageIds: MavenAGI.EntityIdBase[];
 }

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. Only the markdown capability is supported at this time. If not provided, responses will be plain text. */
+    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/Sentiment.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The sentiment of the conversation
+ */
+export declare type Sentiment = "POSITIVE" | "NEGATIVE" | "NEUTRAL" | "MIXED" | "UNKNOWN";
+export declare const Sentiment: {
+    readonly Positive: "POSITIVE";
+    readonly Negative: "NEGATIVE";
+    readonly Neutral: "NEUTRAL";
+    readonly Mixed: "MIXED";
+    readonly Unknown: "UNKNOWN";
+};

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const Sentiment = {
+    Positive: "POSITIVE",
+    Negative: "NEGATIVE",
+    Neutral: "NEUTRAL",
+    Mixed: "MIXED",
+    Unknown: "UNKNOWN",
+};

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

@@ -2,11 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export declare type StreamResponse = MavenAGI.StreamResponse.Text | MavenAGI.StreamResponse.Metadata | MavenAGI.StreamResponse.Start | MavenAGI.StreamResponse.End;
+export declare type StreamResponse = MavenAGI.StreamResponse.Text | MavenAGI.StreamResponse.Action | MavenAGI.StreamResponse.Metadata | MavenAGI.StreamResponse.Start | MavenAGI.StreamResponse.End;
 export declare namespace StreamResponse {
     interface Text extends MavenAGI.AskStreamTextEvent {
         eventType: "text";
     }
+    interface Action extends MavenAGI.AskStreamActionEvent {
+        eventType: "action";
+    }
     interface Metadata extends MavenAGI.AskStreamMetadataEvent {
         eventType: "metadata";
     }

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SubmitActionFormRequest {
+    actionFormId: string;
+    /** Map of parameter IDs to values provided by the user. All required action fields must be provided. */
+    parameters: Record<string, unknown>;
+}

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

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

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

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface UserMessage extends MavenAGI.ConversationMessageBase {
-    text: string;
-    userMessageType: MavenAGI.UserConversationMessageType;
+export interface UserMessage extends MavenAGI.UserMessageBase {
+    /** The ID that uniquely identifies this message within the conversation */
+    conversationMessageId: MavenAGI.EntityId;
 }

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface UserMessageBase extends MavenAGI.ConversationMessageBase {
+    /** ID that uniquely identifies the user that created this message */
+    userId: MavenAGI.EntityIdBase;
+    /** The text of the message. Cannot be empty */
+    text: string;
+    userMessageType: MavenAGI.UserConversationMessageType;
+}

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

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

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";
@@ -6,6 +9,8 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./ConversationMessageBase";
 export * from "./ConversationMessageResponse";
+export * from "./ConversationAnalysis";
+export * from "./UserMessageBase";
 export * from "./UserMessage";
 export * from "./BotMessage";
 export * from "./BotResponseMetadata";
@@ -13,15 +18,16 @@ export * from "./BotResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
-export * from "./ConversationContext";
-export * from "./ConversationMessageContext";
+export * from "./SubmitActionFormRequest";
 export * from "./UserConversationMessageType";
+export * from "./Sentiment";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
-export * from "./FeedbackType";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
+export * from "./AskStreamActionEvent";
 export * from "./AskStreamMetadataEvent";
 export * from "./AskStreamStartEvent";
 export * from "./AskStreamEndEvent";
 export * from "./Source";
+export * from "./CategorizationResponse";

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";
@@ -6,6 +9,8 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./ConversationMessageBase";
 export * from "./ConversationMessageResponse";
+export * from "./ConversationAnalysis";
+export * from "./UserMessageBase";
 export * from "./UserMessage";
 export * from "./BotMessage";
 export * from "./BotResponseMetadata";
@@ -13,15 +18,16 @@ export * from "./BotResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
-export * from "./ConversationContext";
-export * from "./ConversationMessageContext";
+export * from "./SubmitActionFormRequest";
 export * from "./UserConversationMessageType";
+export * from "./Sentiment";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
-export * from "./FeedbackType";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
+export * from "./AskStreamActionEvent";
 export * from "./AskStreamMetadataEvent";
 export * from "./AskStreamStartEvent";
 export * from "./AskStreamEndEvent";
 export * from "./Source";
+export * from "./CategorizationResponse";

package/api/resources/index.d.ts

@@ -1,9 +1,13 @@
+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 appSettings from "./appSettings";
+export * as users from "./users";

package/api/resources/index.js

@@ -1,9 +1,13 @@
+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 appSettings from "./appSettings";
+export * as users from "./users";