mavenagi 0.0.0-alpha.8 → 1.0.0

package/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.
@@ -34,13 +43,22 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.initialize({
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
      *         messages: [{}],
-     *         context: {},
-     *         id: "string",
      *         responseConfig: {
-     *             capabilities: [MavenAGI.Capability.Markdown],
+     *             capabilities: ["MARKDOWN"],
      *             isCopilot: true,
-     *             responseLength: MavenAGI.ResponseLength.Short
+     *             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"
      *         }
      *     })
      */
@@ -49,6 +67,7 @@ export declare class Conversation {
      * Get a conversation
      *
      * @param {string} conversationId - The ID of the conversation to get
+     * @param {MavenAGI.ConversationGetRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -56,9 +75,11 @@ export declare class Conversation {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.conversation.get("string")
+     *     await client.conversation.get("string", {
+     *         appId: "string"
+     *     })
      */
-    get(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
+    get(conversationId: string, request?: MavenAGI.ConversationGetRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
      * Append messages to an existing conversation. The conversation must be initialized first. If a message with the same id already exists, it will be ignored.
      *
@@ -72,15 +93,21 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.appendNewMessages("string", [{
+     *             conversationMessageId: {
+     *                 referenceId: "string"
+     *             },
+     *             userId: {
+     *                 referenceId: "string"
+     *             },
      *             text: "string",
-     *             userMessageType: MavenAGI.UserConversationMessageType.User,
-     *             id: "string",
-     *             context: {}
+     *             userMessageType: "USER",
+     *             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
@@ -91,16 +118,23 @@ export declare class Conversation {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.conversation.ask("string", {
-     *         id: "string",
-     *         text: "string",
-     *         context: {},
-     *         responseConfig: {}
+     *     await client.conversation.ask("conversation-0", {
+     *         conversationMessageId: {
+     *             referenceId: "message-0"
+     *         },
+     *         userId: {
+     *             referenceId: "user-0"
+     *         },
+     *         text: "How do I reset my password?",
+     *         attachments: [{
+     *                 type: "image/png",
+     *                 content: "iVBORw0KGgo..."
+     *             }]
      *     })
      */
     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>>;
     /**
@@ -116,12 +150,28 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.generateMavenSuggestions("string", {
-     *         messageIds: ["string"]
+     *         conversationMessageIds: [{
+     *                 referenceId: "string"
+     *             }]
      *     })
      */
     generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Create feedback
+     * 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>;
+    /**
+     * Update feedback or create it if it doesn't exist
      *
      * @param {MavenAGI.FeedbackRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
@@ -132,14 +182,20 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.createFeedback({
-     *         id: "string",
-     *         conversationId: "string",
-     *         conversationMessageId: "string",
-     *         type: MavenAGI.FeedbackType.ThumbsUp,
-     *         text: "string"
+     *         feedbackId: {
+     *             referenceId: "feedback-0"
+     *         },
+     *         conversationId: {
+     *             referenceId: "conversation-0"
+     *         },
+     *         conversationMessageId: {
+     *             referenceId: "message-1"
+     *         },
+     *         type: "THUMBS_UP",
+     *         text: "Great answer!"
      *     })
      */
-    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
      *
@@ -154,16 +210,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"
@@ -173,7 +219,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