mavenagi 0.0.0-alpha.11 → 0.0.0-alpha.14

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 declare type EntityType = "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "USER_EVENT" | "EVENT_TRIGGER" | "USER_PROFILE";
+export declare type EntityType = "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "USER_EVENT" | "EVENT_TRIGGER" | "USER_PROFILE" | "FEEDBACK";
 export declare const EntityType: {
     readonly Conversation: "CONVERSATION";
     readonly ConversationMessage: "CONVERSATION_MESSAGE";
@@ -12,4 +12,5 @@ export declare const EntityType: {
     readonly UserEvent: "USER_EVENT";
     readonly EventTrigger: "EVENT_TRIGGER";
     readonly UserProfile: "USER_PROFILE";
+    readonly Feedback: "FEEDBACK";
 };

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

@@ -11,4 +11,5 @@ export const EntityType = {
     UserEvent: "USER_EVENT",
     EventTrigger: "EVENT_TRIGGER",
     UserProfile: "USER_PROFILE",
+    Feedback: "FEEDBACK",
 };

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

@@ -2,15 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface Feedback {
+export interface Feedback extends MavenAGI.FeedbackBase {
     /** The ID of the piece of feedback */
-    id: string;
+    feedbackId: MavenAGI.EntityId;
     /** The ID of the conversation the feedback is about */
-    conversationId: string;
+    conversationId: MavenAGI.EntityId;
     /** The ID of the conversation message the feedback is about */
-    conversationMessageId: string;
-    /** The type of feedback */
-    type: MavenAGI.FeedbackType;
-    /** The feedback text */
-    text?: string;
+    conversationMessageId: MavenAGI.EntityId;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface FeedbackBase {
+    /** The type of feedback */
+    type: MavenAGI.FeedbackType;
+    /** The feedback text */
+    text?: string;
+}

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

@@ -6,5 +6,5 @@ export interface UserData {
     /** The value of the user metadata */
     value: string;
     /** The visibility of the user metadata */
-    visibility?: MavenAGI.VisibilityType;
+    visibility: MavenAGI.VisibilityType;
 }

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

@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
-export * from "./User";
+export * from "./FeedbackBase";
 export * from "./FeedbackType";
 export * from "./Feedback";
-export * from "./AppUserIdentification";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
 export * from "./VisibilityType";
 export * from "./AppUserRequest";
 export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";

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

@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
-export * from "./User";
+export * from "./FeedbackBase";
 export * from "./FeedbackType";
 export * from "./Feedback";
-export * from "./AppUserIdentification";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
 export * from "./VisibilityType";
 export * from "./AppUserRequest";
 export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";

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

@@ -9,21 +9,30 @@ export declare namespace Conversation {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class Conversation {
     protected readonly _options: Conversation.Options;
     constructor(_options: Conversation.Options);
     /**
-     * Pre-populate a new conversation with messages
+     * Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
      *
      * @param {MavenAGI.ConversationRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,11 +47,18 @@ export declare class Conversation {
      *             referenceId: "string"
      *         },
      *         messages: [{}],
-     *         context: {},
      *         responseConfig: {
      *             capabilities: [MavenAGI.Capability.Markdown],
      *             isCopilot: true,
      *             responseLength: MavenAGI.ResponseLength.Short
+     *         },
+     *         subject: "string",
+     *         url: "string",
+     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
+     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
+     *         tags: new Set(["string"]),
+     *         metadata: {
+     *             "string": "string"
      *         }
      *     })
      */
@@ -77,14 +93,18 @@ export declare class Conversation {
      *             conversationMessageId: {
      *                 referenceId: "string"
      *             },
+     *             userId: {
+     *                 referenceId: "string"
+     *             },
      *             text: "string",
      *             userMessageType: MavenAGI.UserConversationMessageType.User,
-     *             context: {}
+     *             createdAt: new Date("2024-01-15T09:30:00.000Z"),
+     *             updatedAt: new Date("2024-01-15T09:30:00.000Z")
      *         }])
      */
     appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Ask a question in a conversation
+     * Ask a question
      *
      * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
      * @param {MavenAGI.AskRequest} request
@@ -99,9 +119,10 @@ export declare class Conversation {
      *         conversationMessageId: {
      *             referenceId: "string"
      *         },
-     *         text: "string",
-     *         context: {},
-     *         responseConfig: {}
+     *         userId: {
+     *             referenceId: "string"
+     *         },
+     *         text: "string"
      *     })
      */
     ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -140,14 +161,20 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.createFeedback({
-     *         id: "string",
-     *         conversationId: "string",
-     *         conversationMessageId: "string",
+     *         feedbackId: {
+     *             referenceId: "string"
+     *         },
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
+     *         conversationMessageId: {
+     *             referenceId: "string"
+     *         },
      *         type: MavenAGI.FeedbackType.ThumbsUp,
      *         text: "string"
      *     })
      */
-    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.Feedback>;
     /**
      * Submit a filled out action form
      *
@@ -162,16 +189,6 @@ export declare class Conversation {
      * @example
      *     await client.conversation.submitActionForm("string", {
      *         actionFormId: "string",
-     *         userContext: {
-     *             name: "string",
-     *             id: {
-     *                 "string": "string"
-     *             },
-     *             email: "string",
-     *             context: {
-     *                 "string": "string"
-     *             }
-     *         },
      *         parameters: {
      *             "string": {
      *                 "key": "value"
@@ -181,7 +198,7 @@ export declare class Conversation {
      */
     submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
+     * Add metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
      *
      * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
      * @param {Record<string, string>} request