mavenagi 1.0.4 → 1.0.6

package/errors/index.js

@@ -1,2 +1,7 @@
-export { MavenAGIError } from "./MavenAGIError";
-export { MavenAGITimeoutError } from "./MavenAGITimeoutError";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MavenAGITimeoutError = exports.MavenAGIError = void 0;
+var MavenAGIError_1 = require("./MavenAGIError");
+Object.defineProperty(exports, "MavenAGIError", { enumerable: true, get: function () { return MavenAGIError_1.MavenAGIError; } });
+var MavenAGITimeoutError_1 = require("./MavenAGITimeoutError");
+Object.defineProperty(exports, "MavenAGITimeoutError", { enumerable: true, get: function () { return MavenAGITimeoutError_1.MavenAGITimeoutError; } });

package/index.js

@@ -1,4 +1,34 @@
-export * as MavenAGI from "./api";
-export { MavenAGIClient } from "./Client";
-export { MavenAGIEnvironment } from "./environments";
-export { MavenAGIError, MavenAGITimeoutError } from "./errors";
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MavenAGITimeoutError = exports.MavenAGIError = exports.MavenAGIEnvironment = exports.MavenAGIClient = exports.MavenAGI = void 0;
+exports.MavenAGI = __importStar(require("./api"));
+var Client_1 = require("./Client");
+Object.defineProperty(exports, "MavenAGIClient", { enumerable: true, get: function () { return Client_1.MavenAGIClient; } });
+var environments_1 = require("./environments");
+Object.defineProperty(exports, "MavenAGIEnvironment", { enumerable: true, get: function () { return environments_1.MavenAGIEnvironment; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "MavenAGIError", { enumerable: true, get: function () { return errors_1.MavenAGIError; } });
+Object.defineProperty(exports, "MavenAGITimeoutError", { enumerable: true, get: function () { return errors_1.MavenAGITimeoutError; } });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mavenagi",
-    "version": "1.0.4",
+    "version": "1.0.6",
     "private": false,
     "repository": "https://github.com/mavenagi/mavenagi-node",
     "main": "./index.js",
@@ -25,7 +25,6 @@
         "@types/qs": "6.9.8",
         "@types/node-fetch": "2.6.9",
         "@types/readable-stream": "^4.0.15",
-        "fetch-mock-jest": "^1.5.1",
         "webpack": "^5.94.0",
         "ts-loader": "^9.3.1",
         "jest": "29.7.0",

package/reference.md

@@ -213,6 +213,104 @@ await client.actions.delete("get-balance");
 </dl>
 </details>
 
+## Analytics
+
+<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.analytics.getConversationTable({
+    conversationFilter: {
+        languages: ["en", "es"],
+    },
+    timeGrouping: "DAY",
+    fieldGroupings: [
+        {
+            field: "Category",
+        },
+    ],
+    columnDefinitions: [
+        {
+            header: "count",
+            metric: {
+                type: "count",
+            },
+        },
+        {
+            header: "avg_first_response_time",
+            metric: {
+                type: "average",
+                targetField: "FirstResponseTime",
+            },
+        },
+        {
+            header: "percentile_handle_time",
+            metric: {
+                type: "percentile",
+                targetField: "HandleTime",
+                percentiles: [25, 75],
+            },
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationTableRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Analytics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## AppSettings
 
 <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
@@ -422,6 +520,85 @@ await client.conversation.get("conversationId");
 </dl>
 </details>
 
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">delete</a>(conversationId, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversation.delete("conversation-0", {
+    reason: "GDPR deletion request 1234.",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**conversationId:** `string` — The ID of the conversation to delete
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationDeleteRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Conversation.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">appendNewMessages</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
 <dl>
 <dd>
@@ -434,7 +611,7 @@ await client.conversation.get("conversationId");
 <dl>
 <dd>
 
-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.
+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.
 
 </dd>
 </dl>
@@ -516,8 +693,17 @@ await client.conversation.appendNewMessages("conversationId", [
 <dl>
 <dd>
 
-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.
 </dd>
 </dl>
 </dd>
@@ -546,6 +732,10 @@ await client.conversation.ask("conversation-0", {
             content: "iVBORw0KGgo...",
         },
     ],
+    transientData: {
+        userToken: "abcdef123",
+        queryApiKey: "foobar456",
+    },
 });
 ```
 
@@ -601,8 +791,21 @@ await client.conversation.ask("conversation-0", {
 <dl>
 <dd>
 
-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.
 </dd>
 </dl>
 </dd>
@@ -617,7 +820,7 @@ Ask a question with a streaming response. The response will be sent as a stream
 <dd>
 
 ```typescript
-await client.conversation.askStream("conversation-0", {
+const response = await client.conversation.askStream("conversation-0", {
     conversationMessageId: {
         referenceId: "message-0",
     },
@@ -631,7 +834,14 @@ await client.conversation.askStream("conversation-0", {
             content: "iVBORw0KGgo...",
         },
     ],
+    transientData: {
+        userToken: "abcdef123",
+        queryApiKey: "foobar456",
+    },
 });
+for await (const item of response) {
+    console.log(item);
+}
 ```
 
 </dd>
@@ -686,7 +896,7 @@ await client.conversation.askStream("conversation-0", {
 <dl>
 <dd>
 
-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.
 
 </dd>
 </dl>
@@ -1889,7 +2099,7 @@ await client.users.createOrUpdate({
 </dl>
 </details>
 
-<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">get</a>(userId) -> MavenAGI.AppUserResponse</code></summary>
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">get</a>(userId, { ...params }) -> MavenAGI.AppUserResponse</code></summary>
 <dl>
 <dd>
 
@@ -1941,6 +2151,14 @@ await client.users.get("user-0");
 <dl>
 <dd>
 
+**request:** `MavenAGI.UserGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Users.RequestOptions`
 
 </dd>

package/serialization/index.js

@@ -1 +1,17 @@
-export * from "./resources";
+"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("./resources"), exports);

package/serialization/resources/actions/index.js

@@ -1 +1,17 @@
-export * from "./types";
+"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("./types"), exports);

package/serialization/resources/actions/types/ActionRequest.d.ts

@@ -5,7 +5,7 @@ import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityIdBase } from "../../commons/types/EntityIdBase";
-import { ActionBase } from "./ActionBase";
+import { ActionBase } from "../../commons/types/ActionBase";
 export declare const ActionRequest: core.serialization.ObjectSchema<serializers.ActionRequest.Raw, MavenAGI.ActionRequest>;
 export declare namespace ActionRequest {
     interface Raw extends ActionBase.Raw {

package/serialization/resources/actions/types/ActionRequest.js

@@ -1,11 +1,37 @@
+"use strict";
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as core from "../../../../core";
-import { EntityIdBase } from "../../commons/types/EntityIdBase";
-import { ActionBase } from "./ActionBase";
-export const ActionRequest = core.serialization
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionRequest = void 0;
+const core = __importStar(require("../../../../core"));
+const EntityIdBase_1 = require("../../commons/types/EntityIdBase");
+const ActionBase_1 = require("../../commons/types/ActionBase");
+exports.ActionRequest = core.serialization
     .object({
-    actionId: EntityIdBase,
+    actionId: EntityIdBase_1.EntityIdBase,
 })
-    .extend(ActionBase);
+    .extend(ActionBase_1.ActionBase);

package/serialization/resources/actions/types/index.d.ts

@@ -1,13 +1 @@
-export * from "./ActionBase";
-export * from "./ActionParameter";
 export * from "./ActionRequest";
-export * from "./ActionResponse";
-export * from "./Precondition";
-export * from "./PreconditionOperator";
-export * from "./PreconditionBase";
-export * from "./MetadataPrecondition";
-export * from "./ConversationPrecondition";
-export * from "./PreconditionGroupOperator";
-export * from "./PreconditionGroup";
-export * from "./TagsPrecondition";
-export * from "./ConversationExecutedActionPrecondition";

package/serialization/resources/actions/types/index.js

@@ -1,13 +1,17 @@
-export * from "./ActionBase";
-export * from "./ActionParameter";
-export * from "./ActionRequest";
-export * from "./ActionResponse";
-export * from "./Precondition";
-export * from "./PreconditionOperator";
-export * from "./PreconditionBase";
-export * from "./MetadataPrecondition";
-export * from "./ConversationPrecondition";
-export * from "./PreconditionGroupOperator";
-export * from "./PreconditionGroup";
-export * from "./TagsPrecondition";
-export * from "./ConversationExecutedActionPrecondition";
+"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("./ActionRequest"), exports);

package/serialization/resources/analytics/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/serialization/resources/analytics/index.js

@@ -0,0 +1,17 @@
+"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("./types"), exports);

package/serialization/resources/analytics/types/Average.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { BasicMetric } from "./BasicMetric";
+export declare const Average: core.serialization.ObjectSchema<serializers.Average.Raw, MavenAGI.Average>;
+export declare namespace Average {
+    interface Raw extends BasicMetric.Raw {
+    }
+}

package/serialization/resources/analytics/types/Average.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Average = void 0;
+const core = __importStar(require("../../../../core"));
+const BasicMetric_1 = require("./BasicMetric");
+exports.Average = core.serialization
+    .object({})
+    .extend(BasicMetric_1.BasicMetric);

package/serialization/resources/analytics/types/BasicMetric.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { ConversationField } from "../../conversation/types/ConversationField";
+export declare const BasicMetric: core.serialization.ObjectSchema<serializers.BasicMetric.Raw, MavenAGI.BasicMetric>;
+export declare namespace BasicMetric {
+    interface Raw {
+        targetField: ConversationField.Raw;
+    }
+}

package/serialization/resources/analytics/types/BasicMetric.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicMetric = void 0;
+const core = __importStar(require("../../../../core"));
+const ConversationField_1 = require("../../conversation/types/ConversationField");
+exports.BasicMetric = core.serialization.object({
+    targetField: ConversationField_1.ConversationField,
+});

package/serialization/resources/analytics/types/ColumnDefinition.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { Metric } from "./Metric";
+export declare const ColumnDefinition: core.serialization.ObjectSchema<serializers.ColumnDefinition.Raw, MavenAGI.ColumnDefinition>;
+export declare namespace ColumnDefinition {
+    interface Raw {
+        header: string;
+        metric: Metric.Raw;
+    }
+}