mavenagi 1.0.12 → 1.0.15

package/reference.md

@@ -1492,6 +1492,92 @@ await client.conversation.generateMavenSuggestions("conversationId", {
 </dl>
 </details>
 
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">generateObject</a>(conversationId, { ...params }) -> MavenAGI.BotObjectResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Generate a structured object response based on a provided schema and user prompt.
+
+If the user question and object response already exist, they will be reused and not updated.
+
+Known Limitations:
+
+- Schema enforcement is best-effort and may not guarantee exact conformity.
+- This endpoint does not stream results. Use `askDataStream` (coming soon) for progressive rendering.
+  </dd>
+  </dl>
+  </dd>
+  </dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversation.generateObject("conversationId", {
+    conversationMessageId: {
+        referenceId: "referenceId",
+    },
+    userId: {
+        referenceId: "referenceId",
+    },
+    text: "text",
+    schema: "schema",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**conversationId:** `string` — The ID of a new or existing conversation to use as context for the object generation request
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.GenerateObjectRequest`
+
+</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">categorize</a>(conversationId) -> MavenAGI.CategorizationResponse</code></summary>
 <dl>
 <dd>

package/serialization/resources/commons/types/BotObjectResponse.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";
+export declare const BotObjectResponse: core.serialization.ObjectSchema<serializers.BotObjectResponse.Raw, MavenAGI.BotObjectResponse>;
+export declare namespace BotObjectResponse {
+    interface Raw {
+        label?: string | null;
+        object?: unknown;
+    }
+}

package/serialization/resources/commons/types/BotObjectResponse.js

@@ -0,0 +1,44 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotObjectResponse = void 0;
+const core = __importStar(require("../../../../core"));
+exports.BotObjectResponse = core.serialization.object({
+    label: core.serialization.string().optional(),
+    object: core.serialization.unknown(),
+});

package/serialization/resources/commons/types/BotResponse.d.ts

@@ -7,9 +7,10 @@ import * as core from "../../../../core";
 import { BotTextResponse } from "./BotTextResponse";
 import { BotActionFormResponse } from "./BotActionFormResponse";
 import { BotChartResponse } from "./BotChartResponse";
+import { BotObjectResponse } from "./BotObjectResponse";
 export declare const BotResponse: core.serialization.Schema<serializers.BotResponse.Raw, MavenAGI.BotResponse>;
 export declare namespace BotResponse {
-    type Raw = BotResponse.Text | BotResponse.ActionForm | BotResponse.Chart;
+    type Raw = BotResponse.Text | BotResponse.ActionForm | BotResponse.Chart | BotResponse.Object;
     interface Text extends BotTextResponse.Raw {
         type: "text";
     }
@@ -19,4 +20,7 @@ export declare namespace BotResponse {
     interface Chart extends BotChartResponse.Raw {
         type: "chart";
     }
+    interface Object extends BotObjectResponse.Raw {
+        type: "object";
+    }
 }

package/serialization/resources/commons/types/BotResponse.js

@@ -41,11 +41,13 @@ const core = __importStar(require("../../../../core"));
 const BotTextResponse_1 = require("./BotTextResponse");
 const BotActionFormResponse_1 = require("./BotActionFormResponse");
 const BotChartResponse_1 = require("./BotChartResponse");
+const BotObjectResponse_1 = require("./BotObjectResponse");
 exports.BotResponse = core.serialization
     .union("type", {
     text: BotTextResponse_1.BotTextResponse,
     actionForm: BotActionFormResponse_1.BotActionFormResponse,
     chart: BotChartResponse_1.BotChartResponse,
+    object: BotObjectResponse_1.BotObjectResponse,
 })
     .transform({
     transform: (value) => value,

package/serialization/resources/commons/types/NumberRange.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";
+export declare const NumberRange: core.serialization.ObjectSchema<serializers.NumberRange.Raw, MavenAGI.NumberRange>;
+export declare namespace NumberRange {
+    interface Raw {
+        greaterThanOrEqual?: number | null;
+        lessThan?: number | null;
+    }
+}

package/serialization/resources/commons/types/NumberRange.js

@@ -0,0 +1,44 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NumberRange = void 0;
+const core = __importStar(require("../../../../core"));
+exports.NumberRange = core.serialization.object({
+    greaterThanOrEqual: core.serialization.number().optional(),
+    lessThan: core.serialization.number().optional(),
+});

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

@@ -42,6 +42,7 @@ export * from "./BotMessage";
 export * from "./Source";
 export * from "./BotResponseMetadata";
 export * from "./BotResponse";
+export * from "./BotObjectResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
@@ -76,3 +77,4 @@ export * from "./InboxItemFixBase";
 export * from "./InboxItemFixAddDocument";
 export * from "./InboxItemFixDeactivateDocument";
 export * from "./InboxItemFixDeactivateKnowledgeBase";
+export * from "./NumberRange";

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

@@ -58,6 +58,7 @@ __exportStar(require("./BotMessage"), exports);
 __exportStar(require("./Source"), exports);
 __exportStar(require("./BotResponseMetadata"), exports);
 __exportStar(require("./BotResponse"), exports);
+__exportStar(require("./BotObjectResponse"), exports);
 __exportStar(require("./BotTextResponse"), exports);
 __exportStar(require("./BotActionFormResponse"), exports);
 __exportStar(require("./ActionFormField"), exports);
@@ -92,3 +93,4 @@ __exportStar(require("./InboxItemFixBase"), exports);
 __exportStar(require("./InboxItemFixAddDocument"), exports);
 __exportStar(require("./InboxItemFixDeactivateDocument"), exports);
 __exportStar(require("./InboxItemFixDeactivateKnowledgeBase"), exports);
+__exportStar(require("./NumberRange"), exports);

package/serialization/resources/conversation/types/ConversationField.d.ts

@@ -6,5 +6,5 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 export declare const ConversationField: core.serialization.Schema<serializers.ConversationField.Raw, MavenAGI.ConversationField>;
 export declare namespace ConversationField {
-    type Raw = "Category" | "FirstResponseTime" | "HandleTime" | "HumanAgents" | "App" | "Sentiment" | "QualityReason" | "ResolutionStatus" | "Quality" | "Users" | "ResponseLength" | "ThumbsUpCount" | "ThumbsDownCount" | "InsertCount" | "Tags" | "UserMessageCount" | "Languages" | "Actions" | "IncompleteActions" | "Sources" | "CreatedAt";
+    type Raw = "Category" | "FirstResponseTime" | "HandleTime" | "HumanAgents" | "HumanAgentsWithInserts" | "App" | "Sentiment" | "QualityReason" | "ResolutionStatus" | "Quality" | "Users" | "ResponseLength" | "ThumbsUpCount" | "ThumbsDownCount" | "InsertCount" | "Tags" | "UserMessageCount" | "Languages" | "Actions" | "IncompleteActions" | "Sources" | "CreatedAt";
 }

package/serialization/resources/conversation/types/ConversationField.js

@@ -43,6 +43,7 @@ exports.ConversationField = core.serialization.enum_([
     "FirstResponseTime",
     "HandleTime",
     "HumanAgents",
+    "HumanAgentsWithInserts",
     "App",
     "Sentiment",
     "QualityReason",

package/serialization/resources/conversation/types/ConversationFilter.d.ts

@@ -11,6 +11,7 @@ import { QualityReason } from "../../commons/types/QualityReason";
 import { ResponseLength } from "../../commons/types/ResponseLength";
 import { Sentiment } from "../../commons/types/Sentiment";
 import { ResolutionStatus } from "./ResolutionStatus";
+import { NumberRange } from "../../commons/types/NumberRange";
 export declare const ConversationFilter: core.serialization.ObjectSchema<serializers.ConversationFilter.Raw, MavenAGI.ConversationFilter>;
 export declare namespace ConversationFilter {
     interface Raw {
@@ -23,6 +24,7 @@ export declare namespace ConversationFilter {
         incompleteActions?: EntityIdFilter.Raw[] | null;
         feedback?: FeedbackType.Raw[] | null;
         humanAgents?: string[] | null;
+        humanAgentsWithInserts?: string[] | null;
         languages?: string[] | null;
         quality?: Quality.Raw[] | null;
         qualityReason?: QualityReason.Raw[] | null;
@@ -31,5 +33,6 @@ export declare namespace ConversationFilter {
         tags?: string[] | null;
         resolutionStatus?: ResolutionStatus.Raw[] | null;
         resolvedByMaven?: boolean | null;
+        userMessageCount?: NumberRange.Raw | null;
     }
 }

package/serialization/resources/conversation/types/ConversationFilter.js

@@ -45,6 +45,7 @@ const QualityReason_1 = require("../../commons/types/QualityReason");
 const ResponseLength_1 = require("../../commons/types/ResponseLength");
 const Sentiment_1 = require("../../commons/types/Sentiment");
 const ResolutionStatus_1 = require("./ResolutionStatus");
+const NumberRange_1 = require("../../commons/types/NumberRange");
 exports.ConversationFilter = core.serialization.object({
     search: core.serialization.string().optional(),
     createdAfter: core.serialization.date().optional(),
@@ -55,6 +56,7 @@ exports.ConversationFilter = core.serialization.object({
     incompleteActions: core.serialization.list(EntityIdFilter_1.EntityIdFilter).optional(),
     feedback: core.serialization.list(FeedbackType_1.FeedbackType).optional(),
     humanAgents: core.serialization.list(core.serialization.string()).optional(),
+    humanAgentsWithInserts: core.serialization.list(core.serialization.string()).optional(),
     languages: core.serialization.list(core.serialization.string()).optional(),
     quality: core.serialization.list(Quality_1.Quality).optional(),
     qualityReason: core.serialization.list(QualityReason_1.QualityReason).optional(),
@@ -63,4 +65,5 @@ exports.ConversationFilter = core.serialization.object({
     tags: core.serialization.list(core.serialization.string()).optional(),
     resolutionStatus: core.serialization.list(ResolutionStatus_1.ResolutionStatus).optional(),
     resolvedByMaven: core.serialization.boolean().optional(),
+    userMessageCount: NumberRange_1.NumberRange.optional(),
 });

package/serialization/resources/conversation/types/FeedbackField.d.ts

@@ -6,5 +6,5 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 export declare const FeedbackField: core.serialization.Schema<serializers.FeedbackField.Raw, MavenAGI.FeedbackField>;
 export declare namespace FeedbackField {
-    type Raw = "Type" | "CreatedBy" | "CreatedAt";
+    type Raw = "Type" | "CreatedBy" | "CreatedAt" | "App";
 }

package/serialization/resources/conversation/types/FeedbackField.js

@@ -38,4 +38,4 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FeedbackField = void 0;
 const core = __importStar(require("../../../../core"));
-exports.FeedbackField = core.serialization.enum_(["Type", "CreatedBy", "CreatedAt"]);
+exports.FeedbackField = core.serialization.enum_(["Type", "CreatedBy", "CreatedAt", "App"]);

package/serialization/resources/conversation/types/FeedbackFilter.d.ts

@@ -11,6 +11,8 @@ export declare namespace FeedbackFilter {
         search?: string | null;
         createdAfter?: string | null;
         createdBefore?: string | null;
+        users?: string[] | null;
+        apps?: string[] | null;
         types?: FeedbackType.Raw[] | null;
     }
 }

package/serialization/resources/conversation/types/FeedbackFilter.js

@@ -43,5 +43,7 @@ exports.FeedbackFilter = core.serialization.object({
     search: core.serialization.string().optional(),
     createdAfter: core.serialization.date().optional(),
     createdBefore: core.serialization.date().optional(),
+    users: core.serialization.list(core.serialization.string()).optional(),
+    apps: core.serialization.list(core.serialization.string()).optional(),
     types: core.serialization.list(FeedbackType_1.FeedbackType).optional(),
 });

package/serialization/resources/conversation/types/GenerateObjectRequest.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 { AskRequest } from "./AskRequest";
+export declare const GenerateObjectRequest: core.serialization.ObjectSchema<serializers.GenerateObjectRequest.Raw, MavenAGI.GenerateObjectRequest>;
+export declare namespace GenerateObjectRequest {
+    interface Raw extends AskRequest.Raw {
+        schema: string;
+    }
+}

package/serialization/resources/conversation/types/GenerateObjectRequest.js

@@ -0,0 +1,46 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateObjectRequest = void 0;
+const core = __importStar(require("../../../../core"));
+const AskRequest_1 = require("./AskRequest");
+exports.GenerateObjectRequest = core.serialization
+    .object({
+    schema: core.serialization.string(),
+})
+    .extend(AskRequest_1.AskRequest);

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

@@ -5,6 +5,7 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./SubmitActionFormRequest";
 export * from "./FeedbackRequest";
+export * from "./GenerateObjectRequest";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
 export * from "./AskStreamActionEvent";

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

@@ -21,6 +21,7 @@ __exportStar(require("./ConversationRequest"), exports);
 __exportStar(require("./ConversationMessageRequest"), exports);
 __exportStar(require("./SubmitActionFormRequest"), exports);
 __exportStar(require("./FeedbackRequest"), exports);
+__exportStar(require("./GenerateObjectRequest"), exports);
 __exportStar(require("./StreamResponse"), exports);
 __exportStar(require("./AskStreamTextEvent"), exports);
 __exportStar(require("./AskStreamActionEvent"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.12";
+export declare const SDK_VERSION = "1.0.15";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.0.12";
+exports.SDK_VERSION = "1.0.15";