mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.21

package/api/resources/commons/types/AppUserResponse.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         userId: {
+ *             referenceId: "user-0",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.UserProfile
+ *         },
+ *         identifiers: new Set([{
+ *                 value: "joe@myapp.com",
+ *                 type: MavenAGI.AppUserIdentifyingPropertyType.Email
+ *             }]),
+ *         data: {
+ *             "name": {
+ *                 value: "Joe",
+ *                 visibility: MavenAGI.VisibilityType.Visible
+ *             }
+ *         },
+ *         allUserData: {
+ *             "myapp": {
+ *                 "name": "Joe"
+ *             }
+ *         },
+ *         defaultUserData: {
+ *             "name": "Joe"
+ *         }
+ *     }
+ */
+export interface AppUserResponse extends MavenAGI.AppUser {
+    /** ID that uniquely identifies this user */
+    userId: MavenAGI.EntityId;
+    /** Data from all apps */
+    allUserData: Record<string, Record<string, string>>;
+    /** Default data for this user */
+    defaultUserData: Record<string, string>;
+}

package/api/resources/commons/types/EntityId.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface EntityId extends MavenAGI.EntityIdBase {
+    /** The object type */
+    type: MavenAGI.EntityType;
+    /** The ID of the application that created this object */
+    appId: string;
+    /** The ID of the organization that this object belongs too */
+    organizationId: string;
+    /** The ID of the agent that this object belongs too */
+    agentId: string;
+}

package/api/resources/commons/types/EntityIdBase.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * All other entityId fields are inferred from the API request.
+ */
+export interface EntityIdBase {
+    /** Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId) */
+    referenceId: string;
+}

package/api/resources/commons/types/EntityIdBase.js

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

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

@@ -0,0 +1,16 @@
+/**
+ * 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" | "FEEDBACK";
+export declare const EntityType: {
+    readonly Conversation: "CONVERSATION";
+    readonly ConversationMessage: "CONVERSATION_MESSAGE";
+    readonly KnowledgeBase: "KNOWLEDGE_BASE";
+    readonly KnowledgeDocument: "KNOWLEDGE_DOCUMENT";
+    readonly Action: "ACTION";
+    readonly User: "USER";
+    readonly UserEvent: "USER_EVENT";
+    readonly EventTrigger: "EVENT_TRIGGER";
+    readonly UserProfile: "USER_PROFILE";
+    readonly Feedback: "FEEDBACK";
+};

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const EntityType = {
+    Conversation: "CONVERSATION",
+    ConversationMessage: "CONVERSATION_MESSAGE",
+    KnowledgeBase: "KNOWLEDGE_BASE",
+    KnowledgeDocument: "KNOWLEDGE_DOCUMENT",
+    Action: "ACTION",
+    User: "USER",
+    UserEvent: "USER_EVENT",
+    EventTrigger: "EVENT_TRIGGER",
+    UserProfile: "USER_PROFILE",
+    Feedback: "FEEDBACK",
+};

package/api/resources/commons/types/EventTriggerBase.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface EventTriggerBase {
+    /** The description of what the event trigger does, shown in the Maven Dashboard */
+    description: string;
+    /** The type of event trigger this app wishes to handle */
+    type: MavenAGI.EventTriggerType;
+}

package/api/resources/commons/types/EventTriggerBase.js

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

package/api/resources/commons/types/EventTriggerResponse.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         triggerId: {
+ *             referenceId: "store-in-snowflake",
+ *             appId: "snowflake",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.EventTrigger
+ *         },
+ *         description: "Stores conversation data in Snowflake",
+ *         type: MavenAGI.EventTriggerType.ConversationCreated
+ *     }
+ */
+export interface EventTriggerResponse extends MavenAGI.EventTriggerBase {
+    /** ID that uniquely identifies this event trigger */
+    triggerId: MavenAGI.EntityId;
+}

package/api/resources/commons/types/EventTriggerResponse.js

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

package/api/resources/commons/types/EventTriggerType.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type EventTriggerType = "CONVERSATION_CREATED" | "FEEDBACK_CREATED";
+export declare const EventTriggerType: {
+    readonly ConversationCreated: "CONVERSATION_CREATED";
+    readonly FeedbackCreated: "FEEDBACK_CREATED";
+};

package/api/resources/commons/types/EventTriggerType.js

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const EventTriggerType = {
+    ConversationCreated: "CONVERSATION_CREATED",
+    FeedbackCreated: "FEEDBACK_CREATED",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface Feedback extends MavenAGI.FeedbackBase {
+    /** The ID of the piece of feedback */
+    feedbackId: MavenAGI.EntityId;
+    /** The ID of the conversation the feedback is about */
+    conversationId: MavenAGI.EntityId;
+    /** The ID of the conversation message the feedback is about */
+    conversationMessageId: MavenAGI.EntityId;
+}

package/api/resources/commons/types/Feedback.js

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

package/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/api/resources/commons/types/FeedbackBase.js

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

package/api/resources/{conversation → commons}/types/FeedbackType.d.ts

@@ -4,8 +4,10 @@
 /**
  * The type of feedback
  */
-export declare type FeedbackType = "THUMBS_UP" | "THUMBS_DOWN";
+export declare type FeedbackType = "THUMBS_UP" | "THUMBS_DOWN" | "INSERT" | "HANDOFF";
 export declare const FeedbackType: {
     readonly ThumbsUp: "THUMBS_UP";
     readonly ThumbsDown: "THUMBS_DOWN";
+    readonly Insert: "INSERT";
+    readonly Handoff: "HANDOFF";
 };

package/{dist/api/resources/conversation → api/resources/commons}/types/FeedbackType.js

@@ -4,4 +4,6 @@
 export const FeedbackType = {
     ThumbsUp: "THUMBS_UP",
     ThumbsDown: "THUMBS_DOWN",
+    Insert: "INSERT",
+    Handoff: "HANDOFF",
 };

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface UserData {
+    /** The value of the user metadata */
+    value: string;
+    /** The visibility of the user metadata */
+    visibility: MavenAGI.VisibilityType;
+}

package/api/resources/commons/types/UserData.js

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

package/api/resources/commons/types/VisibilityType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type VisibilityType = "VISIBLE" | "PARTIALLY_VISIBLE" | "HIDDEN";
+export declare const VisibilityType: {
+    readonly Visible: "VISIBLE";
+    readonly PartiallyVisible: "PARTIALLY_VISIBLE";
+    readonly Hidden: "HIDDEN";
+};

package/api/resources/commons/types/VisibilityType.js

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const VisibilityType = {
+    Visible: "VISIBLE",
+    PartiallyVisible: "PARTIALLY_VISIBLE",
+    Hidden: "HIDDEN",
+};

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

@@ -1,2 +1,17 @@
 export * from "./ErrorMessage";
-export * from "./User";
+export * from "./EntityType";
+export * from "./EntityIdBase";
+export * from "./EntityId";
+export * from "./FeedbackBase";
+export * from "./FeedbackType";
+export * from "./Feedback";
+export * from "./AppUserIdentifier";
+export * from "./AppUserIdentifyingPropertyType";
+export * from "./AppUser";
+export * from "./UserData";
+export * from "./VisibilityType";
+export * from "./AppUserRequest";
+export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";

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

@@ -1,2 +1,17 @@
 export * from "./ErrorMessage";
-export * from "./User";
+export * from "./EntityType";
+export * from "./EntityIdBase";
+export * from "./EntityId";
+export * from "./FeedbackBase";
+export * from "./FeedbackType";
+export * from "./Feedback";
+export * from "./AppUserIdentifier";
+export * from "./AppUserIdentifyingPropertyType";
+export * from "./AppUser";
+export * from "./UserData";
+export * from "./VisibilityType";
+export * from "./AppUserRequest";
+export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";

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

@@ -9,50 +9,83 @@ 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.
      *
-     * @throws {@link MavenAGI.ConversationAlreadyExistsError}
-     * @throws {@link MavenAGI.InvalidConversationIdError}
-     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
-     * @throws {@link MavenAGI.EmptyConversationError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.initialize({
-     *         messages: [{}],
-     *         id: "string",
-     *         context: {}
+     *     await client.conversation.initialize({
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
+     *         messages: [{
+     *                 conversationMessageId: {
+     *                     referenceId: "string"
+     *                 },
+     *                 userId: {
+     *                     referenceId: "string"
+     *                 },
+     *                 text: "string",
+     *                 userMessageType: "USER",
+     *                 createdAt: "2024-01-15T09:30:00Z",
+     *                 updatedAt: "2024-01-15T09:30:00Z"
+     *             }],
+     *         responseConfig: {
+     *             capabilities: ["MARKDOWN"],
+     *             isCopilot: true,
+     *             responseLength: "SHORT"
+     *         },
+     *         subject: "string",
+     *         url: "string",
+     *         createdAt: "2024-01-15T09:30:00Z",
+     *         updatedAt: "2024-01-15T09:30:00Z",
+     *         tags: new Set(["string"]),
+     *         metadata: {
+     *             "string": "string"
+     *         }
      *     })
      */
     initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
      * Get a conversation
      *
-     * @param {string} conversationId - The ID of a conversation to get
+     * @param {string} conversationId - The ID of the conversation to get
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.ConversationNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.get("string")
+     *     await client.conversation.get("string")
      */
     get(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
@@ -62,39 +95,50 @@ export declare class Conversation {
      * @param {MavenAGI.ConversationMessageRequest[]} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.ConversationNotFoundError}
-     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.appendNewMessages("string", [{
+     *     await client.conversation.appendNewMessages("string", [{
+     *             conversationMessageId: {
+     *                 referenceId: "string"
+     *             },
+     *             userId: {
+     *                 referenceId: "string"
+     *             },
      *             text: "string",
-     *             userMessageType: MavenAGI.UserConversationMessageType.User,
-     *             id: "string",
-     *             context: {}
+     *             userMessageType: "USER",
+     *             createdAt: "2024-01-15T09:30:00Z",
+     *             updatedAt: "2024-01-15T09:30:00Z"
      *         }])
      */
     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
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.InvalidConversationIdError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.ask("string", {
-     *         id: "string",
-     *         text: "string",
-     *         context: {}
+     *     await client.conversation.ask("string", {
+     *         conversationMessageId: {
+     *             referenceId: "message-1"
+     *         },
+     *         userId: {
+     *             referenceId: "user-1"
+     *         },
+     *         text: "How do I reset my password?"
      *     })
      */
     ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Ask a question
+     * Ask a question with a streaming response. The response will be sent as a stream of events. The text portions of stream responses should be concatenated to form the full response text. Action and metadata events should overwrite past data and do not need concatenation.
      */
     askStream(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<core.Stream<MavenAGI.StreamResponse>>;
     /**
@@ -104,35 +148,96 @@ export declare class Conversation {
      * @param {MavenAGI.GenerateMavenSuggestionsRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.InvalidConversationIdError}
-     * @throws {@link MavenAGI.ConversationNotFoundError}
-     * @throws {@link MavenAGI.ConversationMessageNotFoundError}
-     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.generateMavenSuggestions("string", {
-     *         messageIds: ["string"]
+     *     await client.conversation.generateMavenSuggestions("string", {
+     *         conversationMessageIds: [{
+     *                 referenceId: "string"
+     *             }]
      *     })
      */
     generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * Uses an LLM flow to categorize the conversation. Experimental.
+     *
+     * @param {string} conversationId - The ID of the conversation to categorize
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.categorize("string")
+     */
+    categorize(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.CategorizationResponse>;
     /**
      * Create feedback
      *
      * @param {MavenAGI.FeedbackRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.InvalidFeedbackTypeError}
-     * @throws {@link MavenAGI.ConversationMessageNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.createFeedback({
+     *         feedbackId: {
+     *             referenceId: "string"
+     *         },
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
+     *         conversationMessageId: {
+     *             referenceId: "string"
+     *         },
+     *         type: "THUMBS_UP",
+     *         text: "string"
+     *     })
+     */
+    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.Feedback>;
+    /**
+     * Submit a filled out action form
+     *
+     * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
+     * @param {MavenAGI.SubmitActionFormRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.submitActionForm("string", {
+     *         actionFormId: "string",
+     *         parameters: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
+     */
+    submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    /**
+     * 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
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.createFeedback({
-     *         conversationMessageId: "string",
-     *         text: "string",
-     *         type: MavenAGI.FeedbackType.ThumbsUp
+     *     await client.conversation.addConversationMetadata("string", {
+     *         "string": "string"
      *     })
      */
-    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    addConversationMetadata(conversationId: string, request: Record<string, string>, requestOptions?: Conversation.RequestOptions): Promise<Record<string, string>>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }