mavenagi 0.0.0-alpha.9 → 1.0.1

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

@@ -1 +1 @@
-export {};
+export * from "./requests";

package/dist/api/resources/conversation/client/index.js

@@ -1 +1 @@
-export {};
+export * from "./requests";

package/dist/api/resources/conversation/client/requests/ConversationGetRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         appId: "string"
+ *     }
+ */
+export interface ConversationGetRequest {
+    /**
+     * The App ID of the conversation to get. If not provided the ID of the calling app will be used.
+     */
+    appId?: string;
+}

package/dist/api/resources/conversation/client/requests/ConversationGetRequest.js

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

package/dist/api/resources/conversation/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type ConversationGetRequest } from "./ConversationGetRequest";

package/dist/api/resources/conversation/client/requests/index.js

@@ -0,0 +1 @@
+export {};

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

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

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

@@ -2,13 +2,29 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         conversationMessageId: {
+ *             referenceId: "message-0"
+ *         },
+ *         userId: {
+ *             referenceId: "user-0"
+ *         },
+ *         text: "How do I reset my password?",
+ *         attachments: [{
+ *                 type: "image/png",
+ *                 content: "iVBORw0KGgo..."
+ *             }]
+ *     }
+ */
 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;
-    /** Optional configuration for responses to this conversation. Only applies to new conversations. */
-    responseConfig?: MavenAGI.ResponseConfig;
+    /** The attachments to the message. */
+    attachments?: MavenAGI.Attachment[];
 }

package/dist/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/dist/api/resources/conversation/types/AskStreamActionEvent.js

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

package/dist/api/resources/conversation/types/AskStreamChartEvent.d.ts

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

package/dist/api/resources/conversation/types/AskStreamChartEvent.js

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

package/dist/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/dist/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/dist/api/resources/conversation/types/Attachment.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Attachment {
+    /** The mime-type of the attachment. Supported types are {image/jpeg, image/jpg, image/png, image/gif, image/webp}. */
+    type: string;
+    /** The attachment data. */
+    content: string;
+}

package/dist/api/resources/conversation/types/Attachment.js

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

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

@@ -2,6 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * This response should be rendered as a form which users can submit. Upon submission call the submit action form API.
+ */
 export interface BotActionFormResponse {
     id: string;
     formLabel: string;

package/dist/api/resources/conversation/types/BotActionResponse.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * A response from an action that was provided to the LLM. Should not be shown to users.
+ */
+export interface BotActionResponse {
+    actionId: MavenAGI.EntityId;
+    actionParameters: Record<string, unknown>;
+    actionResponse: string;
+    /** True if the bot automatically took this action. False if the user manually submitted the actionForm. */
+    autoAction: boolean;
+    actionError?: string;
+}

package/dist/api/resources/conversation/types/BotActionResponse.js

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

package/dist/api/resources/conversation/types/BotChartResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Will only be provided if the responseConfig contains the charts_highcharts_ts capability.
+ */
+export interface BotChartResponse {
+    /** The label of the chart */
+    label: string;
+    specSchema: MavenAGI.ChartSpecSchema;
+    /** The spec string for the chart. For HIGHCHARTS_TS charts, the spec is the json object that represents the chart options. */
+    spec: string;
+}

package/dist/api/resources/conversation/types/BotChartResponse.js

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

package/dist/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/dist/api/resources/conversation/types/BotResponse.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export declare type BotResponse = MavenAGI.BotResponse.Text | MavenAGI.BotResponse.ActionForm;
+export declare type BotResponse = MavenAGI.BotResponse.Text | MavenAGI.BotResponse.ActionForm | MavenAGI.BotResponse.Chart | MavenAGI.BotResponse.ActionResponse;
 export declare namespace BotResponse {
     interface Text extends MavenAGI.BotTextResponse {
         type: "text";
@@ -10,4 +10,10 @@ export declare namespace BotResponse {
     interface ActionForm extends MavenAGI.BotActionFormResponse {
         type: "actionForm";
     }
+    interface Chart extends MavenAGI.BotChartResponse {
+        type: "chart";
+    }
+    interface ActionResponse extends MavenAGI.BotActionResponse {
+        type: "actionResponse";
+    }
 }

package/dist/api/resources/conversation/types/BotResponseMetadata.d.ts

@@ -5,4 +5,6 @@ import * as MavenAGI from "../../../index";
 export interface BotResponseMetadata {
     followupQuestions: string[];
     sources: MavenAGI.Source[];
+    /** The language of the message in ISO 639-1 code format */
+    language?: string;
 }

package/dist/api/resources/conversation/types/BotTextResponse.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * A text answer to the user's question. Should be rendered to the user.
+ */
 export interface BotTextResponse {
     text: string;
 }

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

@@ -1,8 +1,22 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Capability = "MARKDOWN" | "FORMS";
+export declare type Capability = 
+/**
+ * Whether the response should include markdown formatting. If not provided, the response will be plain text. Not respected while streaming. */
+"MARKDOWN"
+/**
+ * Whether the response should include forms. Not yet supported. */
+ | "FORMS"
+/**
+ * Whether the response should include images. Not yet supported. */
+ | "IMAGES"
+/**
+ * Whether the response should include a Highcharts typescript chart if applicable. */
+ | "CHARTS_HIGHCHARTS_TS";
 export declare const Capability: {
     readonly Markdown: "MARKDOWN";
     readonly Forms: "FORMS";
+    readonly Images: "IMAGES";
+    readonly ChartsHighchartsTs: "CHARTS_HIGHCHARTS_TS";
 };

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

@@ -4,4 +4,6 @@
 export const Capability = {
     Markdown: "MARKDOWN",
     Forms: "FORMS",
+    Images: "IMAGES",
+    ChartsHighchartsTs: "CHARTS_HIGHCHARTS_TS",
 };

package/dist/api/resources/conversation/types/CategorizationResponse.d.ts

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

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

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

package/dist/api/resources/conversation/types/ChartSpecSchema.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ChartSpecSchema = "HIGHCHARTS_TS";
+export declare const ChartSpecSchema: {
+    readonly HighchartsTs: "HIGHCHARTS_TS";
+};

package/dist/api/resources/conversation/types/ChartSpecSchema.js

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const ChartSpecSchema = {
+    HighchartsTs: "HIGHCHARTS_TS",
+};

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

@@ -0,0 +1,16 @@
+/**
+ * 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 resolution status of the conversation */
+    resolutionStatus?: string;
+    /** Generated category of the conversation */
+    category?: string;
+    /** Generated sentiment of the conversation */
+    sentiment?: MavenAGI.Sentiment;
+}

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

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

package/dist/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;
     /** 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/dist/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/dist/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/dist/api/resources/conversation/types/ConversationRequest.d.ts

@@ -7,6 +7,4 @@ export interface ConversationRequest extends MavenAGI.ConversationBase {
     conversationId: MavenAGI.EntityIdBase;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageRequest[];
-    /** The context of the conversation */
-    context?: MavenAGI.ConversationContext;
 }

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

@@ -2,11 +2,63 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         conversationId: {
+ *             referenceId: "conversation-0",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Conversation
+ *         },
+ *         analysis: {
+ *             resolutionStatus: "Resolved",
+ *             sentiment: MavenAGI.Sentiment.Positive
+ *         },
+ *         messages: [{
+ *                 type: "user",
+ *                 userMessageType: MavenAGI.UserConversationMessageType.User,
+ *                 conversationMessageId: {
+ *                     referenceId: "message-0",
+ *                     appId: "myapp",
+ *                     organizationId: "acme",
+ *                     agentId: "support",
+ *                     type: MavenAGI.EntityType.ConversationMessage
+ *                 },
+ *                 userId: {
+ *                     referenceId: "user-0"
+ *                 },
+ *                 text: "How do I reset my password?",
+ *                 attachments: [{
+ *                         url: "https://example.com/attachment-0"
+ *                     }]
+ *             }, {
+ *                 type: "bot",
+ *                 botMessageType: MavenAGI.BotConversationMessageType.BotResponse,
+ *                 conversationMessageId: {
+ *                     referenceId: "message-1",
+ *                     appId: "myapp",
+ *                     organizationId: "acme",
+ *                     agentId: "support",
+ *                     type: MavenAGI.EntityType.ConversationMessage
+ *                 },
+ *                 responses: [{
+ *                         type: "text",
+ *                         text: "Hi! Go to acme.com/reset-password"
+ *                     }],
+ *                 metadata: {
+ *                     followupQuestions: ["What if I did not get the reset email?"],
+ *                     sources: []
+ *                 }
+ *             }]
+ *     }
+ */
 export interface ConversationResponse extends MavenAGI.ConversationBase {
     /** The ID that uniquely identifies this conversation */
     conversationId: MavenAGI.EntityId;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageResponse[];
-    /** The context of the conversation */
-    context: MavenAGI.ConversationContext;
+    /** An analysis of the conversation. */
+    analysis: MavenAGI.ConversationAnalysis;
 }

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

@@ -2,4 +2,27 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export declare type FeedbackRequest = MavenAGI.Feedback;
+/**
+ * @example
+ *     {
+ *         feedbackId: {
+ *             referenceId: "feedback-0"
+ *         },
+ *         conversationId: {
+ *             referenceId: "conversation-0"
+ *         },
+ *         conversationMessageId: {
+ *             referenceId: "message-1"
+ *         },
+ *         type: MavenAGI.FeedbackType.ThumbsUp,
+ *         text: "Great answer!"
+ *     }
+ */
+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/dist/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/dist/api/resources/conversation/types/ResponseConfig.d.ts

@@ -3,10 +3,10 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ResponseConfig {
-    /** List of capabilities supported by the caller. Defaults to all */
-    capabilities?: MavenAGI.Capability[];
+    /** List of capabilities supported by the caller. Defaults to everything except charts_highcharts_ts. Note that the forms and images capabilities are not respected at this time. */
+    capabilities: MavenAGI.Capability[];
     /** Whether the response is for an human agent (true) or an end user (false). Defaults to false. */
-    isCopilot?: boolean;
+    isCopilot: boolean;
     /** The desired response length. Defaults to ResponseLength.MEDIUM. */
-    responseLength?: MavenAGI.ResponseLength;
+    responseLength: MavenAGI.ResponseLength;
 }

package/dist/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/dist/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/dist/api/resources/conversation/types/StreamResponse.d.ts

@@ -2,11 +2,17 @@
  * 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.Chart | 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 Chart extends MavenAGI.AskStreamChartEvent {
+        eventType: "chart";
+    }
     interface Metadata extends MavenAGI.AskStreamMetadataEvent {
         eventType: "metadata";
     }

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

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

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

@@ -2,8 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface UserMessage extends MavenAGI.ConversationMessageBase {
-    /** The text of the message. Cannot be empty */
-    text: string;
-    userMessageType: MavenAGI.UserConversationMessageType;
+export interface UserMessage extends MavenAGI.UserMessageBase {
+    /** The ID that uniquely identifies this message within the conversation */
+    conversationMessageId: MavenAGI.EntityId;
+    /** The language of the message in ISO 639-1 code format */
+    language?: string;
+    /** The attachments associated with the message */
+    attachments: MavenAGI.UserMessageAttachment[];
 }

package/dist/api/resources/conversation/types/UserMessageAttachment.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UserMessageAttachment {
+    /** The URL to access the attachment, The URL will be valid for 20 minutes. */
+    url: string;
+}

package/dist/api/resources/conversation/types/UserMessageAttachment.js

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

package/dist/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/dist/api/resources/conversation/types/UserMessageBase.js

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