mavenagi 1.0.4 → 1.0.6

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

@@ -1,6 +1,8 @@
 export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
+export * from "./EntityIdWithoutAgent";
+export * from "./EntityIdFilter";
 export * from "./EntityId";
 export * from "./FeedbackBase";
 export * from "./FeedbackType";
@@ -16,3 +18,41 @@ export * from "./EventTriggerBase";
 export * from "./EventTriggerResponse";
 export * from "./EventTriggerType";
 export * from "./ActionParameterType";
+export * from "./ActionEnumOption";
+export * from "./Sentiment";
+export * from "./ConversationSummary";
+export * from "./ConversationAnalysis";
+export * from "./ResponseLength";
+export * from "./Capability";
+export * from "./ResponseConfig";
+export * from "./ConversationBase";
+export * from "./ConversationResponse";
+export * from "./ConversationMessageResponse";
+export * from "./ConversationMessageBase";
+export * from "./UserConversationMessageType";
+export * from "./UserMessageBase";
+export * from "./UserMessageAttachment";
+export * from "./UserMessage";
+export * from "./BotConversationMessageType";
+export * from "./BotMessage";
+export * from "./Source";
+export * from "./BotResponseMetadata";
+export * from "./BotResponse";
+export * from "./BotTextResponse";
+export * from "./BotActionFormResponse";
+export * from "./ActionFormField";
+export * from "./BotChartResponse";
+export * from "./ChartSpecSchema";
+export * from "./ActionBase";
+export * from "./ActionParameter";
+export * from "./ActionResponse";
+export * from "./Precondition";
+export * from "./PreconditionOperator";
+export * from "./PreconditionBase";
+export * from "./MetadataPrecondition";
+export * from "./ConversationPrecondition";
+export * from "./ResponseConfigPrecondition";
+export * from "./PreconditionGroupOperator";
+export * from "./PreconditionGroup";
+export * from "./TagsPrecondition";
+export * from "./ConversationExecutedActionPrecondition";

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

@@ -1,18 +1,74 @@
-export * from "./ErrorMessage";
-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";
-export * from "./ActionParameterType";
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ErrorMessage"), exports);
+__exportStar(require("./EntityType"), exports);
+__exportStar(require("./EntityIdBase"), exports);
+__exportStar(require("./EntityIdWithoutAgent"), exports);
+__exportStar(require("./EntityIdFilter"), exports);
+__exportStar(require("./EntityId"), exports);
+__exportStar(require("./FeedbackBase"), exports);
+__exportStar(require("./FeedbackType"), exports);
+__exportStar(require("./Feedback"), exports);
+__exportStar(require("./AppUserIdentifier"), exports);
+__exportStar(require("./AppUserIdentifyingPropertyType"), exports);
+__exportStar(require("./AppUser"), exports);
+__exportStar(require("./UserData"), exports);
+__exportStar(require("./VisibilityType"), exports);
+__exportStar(require("./AppUserRequest"), exports);
+__exportStar(require("./AppUserResponse"), exports);
+__exportStar(require("./EventTriggerBase"), exports);
+__exportStar(require("./EventTriggerResponse"), exports);
+__exportStar(require("./EventTriggerType"), exports);
+__exportStar(require("./ActionParameterType"), exports);
+__exportStar(require("./ActionEnumOption"), exports);
+__exportStar(require("./Sentiment"), exports);
+__exportStar(require("./ConversationSummary"), exports);
+__exportStar(require("./ConversationAnalysis"), exports);
+__exportStar(require("./ResponseLength"), exports);
+__exportStar(require("./Capability"), exports);
+__exportStar(require("./ResponseConfig"), exports);
+__exportStar(require("./ConversationBase"), exports);
+__exportStar(require("./ConversationResponse"), exports);
+__exportStar(require("./ConversationMessageResponse"), exports);
+__exportStar(require("./ConversationMessageBase"), exports);
+__exportStar(require("./UserConversationMessageType"), exports);
+__exportStar(require("./UserMessageBase"), exports);
+__exportStar(require("./UserMessageAttachment"), exports);
+__exportStar(require("./UserMessage"), exports);
+__exportStar(require("./BotConversationMessageType"), exports);
+__exportStar(require("./BotMessage"), exports);
+__exportStar(require("./Source"), exports);
+__exportStar(require("./BotResponseMetadata"), exports);
+__exportStar(require("./BotResponse"), exports);
+__exportStar(require("./BotTextResponse"), exports);
+__exportStar(require("./BotActionFormResponse"), exports);
+__exportStar(require("./ActionFormField"), exports);
+__exportStar(require("./BotChartResponse"), exports);
+__exportStar(require("./ChartSpecSchema"), exports);
+__exportStar(require("./ActionBase"), exports);
+__exportStar(require("./ActionParameter"), exports);
+__exportStar(require("./ActionResponse"), exports);
+__exportStar(require("./Precondition"), exports);
+__exportStar(require("./PreconditionOperator"), exports);
+__exportStar(require("./PreconditionBase"), exports);
+__exportStar(require("./MetadataPrecondition"), exports);
+__exportStar(require("./ConversationPrecondition"), exports);
+__exportStar(require("./ResponseConfigPrecondition"), exports);
+__exportStar(require("./PreconditionGroupOperator"), exports);
+__exportStar(require("./PreconditionGroup"), exports);
+__exportStar(require("./TagsPrecondition"), exports);
+__exportStar(require("./ConversationExecutedActionPrecondition"), exports);

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

@@ -26,6 +26,8 @@ export declare namespace Conversation {
         organizationId?: string;
         /** Override the X-Agent-Id header */
         agentId?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Conversation {
@@ -74,7 +76,30 @@ export declare class Conversation {
      */
     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.
+     * Wipes a conversation of all user data.
+     * The conversation ID will still exist and non-user specific data will still be retained.
+     * Attempts to modify or add messages to the conversation will throw an error.
+     *
+     * <Warning>This is a destructive operation and cannot be undone. <br/><br/>
+     * The exact fields cleared include: the conversation subject, userRequest, agentResponse.
+     * As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
+     *
+     * @param {string} conversationId - The ID of the conversation to delete
+     * @param {MavenAGI.ConversationDeleteRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.delete("conversation-0", {
+     *         reason: "GDPR deletion request 1234."
+     *     })
+     */
+    delete(conversationId: string, request: MavenAGI.ConversationDeleteRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    /**
+     * 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. Messages do not allow modification.
      *
      * @param {string} conversationId - The ID of the conversation to append messages to
      * @param {MavenAGI.ConversationMessageRequest[]} request
@@ -97,7 +122,15 @@ export declare class Conversation {
      */
     appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Ask a question
+     * Get an answer from Maven for a given user question. If the user question or its answer already exists,
+     * they will be reused and will not be updated. Messages do not allow modification once generated.
+     *
+     * Concurrency Behavior:
+     * - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
+     * - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
+     *
+     * Known Limitation:
+     * - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
      *
      * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
      * @param {MavenAGI.AskRequest} request
@@ -119,16 +152,32 @@ export declare class Conversation {
      *         attachments: [{
      *                 type: "image/png",
      *                 content: "iVBORw0KGgo..."
-     *             }]
+     *             }],
+     *         transientData: {
+     *             "userToken": "abcdef123",
+     *             "queryApiKey": "foobar456"
+     *         }
      *     })
      */
     ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * 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.
+     * Get an answer from Maven for a given user 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.
+     *
+     * If the user question or its answer already exists, they will be reused and will not be updated.
+     * Messages do not allow modification once generated.
+     *
+     * Concurrency Behavior:
+     * - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
+     * - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
+     *
+     * Known Limitation:
+     * - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
      */
     askStream(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<core.Stream<MavenAGI.StreamResponse>>;
     /**
-     * Generate a response suggestion for each requested message id in a conversation
+     * This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
      *
      * @param {string} conversationId - The ID of a conversation the messages belong to
      * @param {MavenAGI.GenerateMavenSuggestionsRequest} request