mavenagi 1.2.4 → 1.2.6

package/reference.md

@@ -238,7 +238,17 @@ All other fields will overwrite the existing value on the action only if provide
 <dd>
 
 ```typescript
-await client.actions.patch("actionReferenceId");
+await client.actions.patch("get-balance", {
+    instructions: "Use this action when the user asks about their account balance or remaining credits.",
+    llmInclusionStatus: "WHEN_RELEVANT",
+    segmentId: {
+        referenceId: "premium-users",
+        appId: "my-billing-system",
+        organizationId: "acme",
+        agentId: "support",
+        type: "SEGMENT",
+    },
+});
 ```
 
 </dd>
@@ -927,7 +937,7 @@ This endpoint requires additional permissions. Contact support to request access
 <dd>
 
 ```typescript
-await client.agents.patch("organizationReferenceId", "agentReferenceId", {});
+await client.agents.patch("organizationReferenceId", "agentReferenceId");
 ```
 
 </dd>
@@ -1224,6 +1234,94 @@ await client.analytics.getConversationChart({
 </dl>
 </details>
 
+<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">exportConversationTable</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Export the conversation analytics table to a CSV file.
+
+This outputs the current table view defined by the request. For most programmatic use cases, prefer `getConversationTable` and format client-side. The CSV format may change and should not be relied upon by code consumers. A maximum of 10,000 rows can be exported at a time.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.analytics.exportConversationTable({
+    fieldGroupings: [
+        {
+            field: "Category",
+        },
+        {
+            field: "Category",
+        },
+    ],
+    columnDefinitions: [
+        {
+            metric: {
+                type: "count",
+            },
+            header: "header",
+        },
+        {
+            metric: {
+                type: "count",
+            },
+            header: "header",
+        },
+    ],
+});
+```
+
+</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>
+
 <details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getFeedbackTable</a>({ ...params }) -> MavenAGI.FeedbackTableResponse</code></summary>
 <dl>
 <dd>
@@ -2591,7 +2689,11 @@ await client.conversation.createFeedback({
 <dl>
 <dd>
 
-Submit a filled out action form
+Submit a filled out action form.
+Action forms can not be submitted more than once, attempting to do so will result in an error.
+
+Additionally, form submission is only allowed when the form is the last message in the conversation.
+Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
 
 </dd>
 </dl>
@@ -2877,6 +2979,74 @@ await client.conversation.search({});
 </dl>
 </details>
 
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">export</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Export conversations to a CSV file.
+
+This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
+
+For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
+The CSV format may change over time and should not be relied upon by code consumers.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversation.export({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationsSearchRequest`
+
+</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">deliverMessage</a>({ ...params }) -> MavenAGI.DeliverMessageResponse</code></summary>
 <dl>
 <dd>
@@ -3173,6 +3343,71 @@ await client.events.get("eventId", {
 </dl>
 </details>
 
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">export</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Export events to a CSV file.
+
+This will output a summary of each event that matches the supplied filter. A maximum of 10,000 events can be exported at a time. For most use cases it is recommended to use the search API instead and convert the JSON response to your desired format. The CSV format may change over time and should not be relied upon by code consumers.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.events.export({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.EventsSearchRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Events.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Inbox
 
 <details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
@@ -3735,6 +3970,82 @@ await client.knowledge.getKnowledgeBase("help-center");
 </dl>
 </details>
 
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">refreshKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Request that a knowledge base refresh itself.
+
+Knowledge bases refresh on a schedule determined by the `refreshFrequency` field.
+They can also be refreshed on demand by calling this endpoint.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.knowledge.refreshKnowledgeBase("help-center", {
+    appId: "readme",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to refresh. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.KnowledgeBaseRefreshRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Knowledge.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">patchKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
 <dl>
 <dd>
@@ -3766,7 +4077,17 @@ All other fields will overwrite the existing value on the knowledge base only if
 <dd>
 
 ```typescript
-await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId");
+await client.knowledge.patchKnowledgeBase("help-center", {
+    name: "Updated Help Center",
+    tags: new Set(["tag1", "tag2", "tag3"]),
+    segmentId: {
+        referenceId: "premium-users",
+        appId: "readme",
+        organizationId: "acme",
+        agentId: "support",
+        type: "SEGMENT",
+    },
+});
 ```
 
 </dd>

package/serialization/resources/agentCapabilities/types/ActionCapability.js

@@ -42,7 +42,7 @@ const AgentCapabilityBase_1 = require("./AgentCapabilityBase");
 exports.ActionCapability = core.serialization
     .object({
     userInteractionRequired: core.serialization.boolean(),
-    buttonName: core.serialization.string().nullable(),
+    buttonName: core.serialization.string().optional(),
     userFormParameters: core.serialization.list(ActionParameter_1.ActionParameter),
     precondition: core.serialization.lazy(() => serializers.Precondition).optional(),
     descriptionOverride: core.serialization.string().optional(),

package/serialization/resources/agents/client/index.d.ts

@@ -1 +1,2 @@
 export * as list from "./list";
+export * from "./requests";

package/serialization/resources/agents/client/index.js

@@ -32,6 +32,10 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+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 });
 exports.list = void 0;
 exports.list = __importStar(require("./list"));
+__exportStar(require("./requests"), exports);

package/serialization/resources/agents/client/requests/AgentPatchRequest.d.ts

@@ -0,0 +1,21 @@
+import * as serializers from "../../../../index";
+import * as MavenAGI from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { AgentEnvironment } from "../../types/AgentEnvironment";
+import { PiiCategory } from "../../types/PiiCategory";
+import { LlmPersona } from "../../../commons/types/LlmPersona";
+export declare const AgentPatchRequest: core.serialization.Schema<serializers.AgentPatchRequest.Raw, MavenAGI.AgentPatchRequest>;
+export declare namespace AgentPatchRequest {
+    interface Raw {
+        name?: string | null;
+        environment?: AgentEnvironment.Raw | null;
+        defaultTimezone?: string | null;
+        enabledPiiCategories?: PiiCategory.Raw[] | null;
+        systemFallbackMessage?: (string | null | undefined) | null;
+        persona?: LlmPersona.Raw | null;
+        additionalPromptText?: (string | null | undefined) | null;
+        categoryGenerationPromptText?: (string | null | undefined) | null;
+        contentSafetyViolationResponsePromptText?: (string | null | undefined) | null;
+        rejectQuestionsWithoutKnowledge?: boolean | null;
+    }
+}

package/serialization/resources/agents/client/requests/AgentPatchRequest.js

@@ -0,0 +1,53 @@
+"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.AgentPatchRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+const AgentEnvironment_1 = require("../../types/AgentEnvironment");
+const PiiCategory_1 = require("../../types/PiiCategory");
+const LlmPersona_1 = require("../../../commons/types/LlmPersona");
+exports.AgentPatchRequest = core.serialization.object({
+    name: core.serialization.string().optional(),
+    environment: AgentEnvironment_1.AgentEnvironment.optional(),
+    defaultTimezone: core.serialization.string().optional(),
+    enabledPiiCategories: core.serialization.set(PiiCategory_1.PiiCategory).optional(),
+    systemFallbackMessage: core.serialization.string().optionalNullable(),
+    persona: LlmPersona_1.LlmPersona.optional(),
+    additionalPromptText: core.serialization.string().optionalNullable(),
+    categoryGenerationPromptText: core.serialization.string().optionalNullable(),
+    contentSafetyViolationResponsePromptText: core.serialization.string().optionalNullable(),
+    rejectQuestionsWithoutKnowledge: core.serialization.boolean().optional(),
+});

package/serialization/resources/agents/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { AgentPatchRequest } from "./AgentPatchRequest";

package/serialization/resources/agents/client/requests/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentPatchRequest = void 0;
+var AgentPatchRequest_1 = require("./AgentPatchRequest");
+Object.defineProperty(exports, "AgentPatchRequest", { enumerable: true, get: function () { return AgentPatchRequest_1.AgentPatchRequest; } });

package/serialization/resources/agents/types/Agent.d.ts

@@ -4,6 +4,7 @@ import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { AgentEnvironment } from "./AgentEnvironment";
 import { PiiCategory } from "./PiiCategory";
+import { AgentPrompting } from "./AgentPrompting";
 export declare const Agent: core.serialization.ObjectSchema<serializers.Agent.Raw, MavenAGI.Agent>;
 export declare namespace Agent {
     interface Raw {
@@ -13,5 +14,7 @@ export declare namespace Agent {
         environment: AgentEnvironment.Raw;
         defaultTimezone: string;
         enabledPiiCategories: PiiCategory.Raw[];
+        systemFallbackMessage?: string | null;
+        prompting: AgentPrompting.Raw;
     }
 }

package/serialization/resources/agents/types/Agent.js

@@ -39,6 +39,7 @@ const core = __importStar(require("../../../../core"));
 const EntityId_1 = require("../../commons/types/EntityId");
 const AgentEnvironment_1 = require("./AgentEnvironment");
 const PiiCategory_1 = require("./PiiCategory");
+const AgentPrompting_1 = require("./AgentPrompting");
 exports.Agent = core.serialization.object({
     agentId: EntityId_1.EntityId,
     name: core.serialization.string(),
@@ -46,4 +47,6 @@ exports.Agent = core.serialization.object({
     environment: AgentEnvironment_1.AgentEnvironment,
     defaultTimezone: core.serialization.string(),
     enabledPiiCategories: core.serialization.set(PiiCategory_1.PiiCategory),
+    systemFallbackMessage: core.serialization.string().optional(),
+    prompting: AgentPrompting_1.AgentPrompting,
 });

package/serialization/resources/agents/types/AgentPrompting.d.ts

@@ -0,0 +1,14 @@
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { LlmPersona } from "../../commons/types/LlmPersona";
+export declare const AgentPrompting: core.serialization.ObjectSchema<serializers.AgentPrompting.Raw, MavenAGI.AgentPrompting>;
+export declare namespace AgentPrompting {
+    interface Raw {
+        persona: LlmPersona.Raw;
+        additionalPromptText?: string | null;
+        categoryGenerationPromptText?: string | null;
+        contentSafetyViolationResponsePromptText?: string | null;
+        rejectQuestionsWithoutKnowledge: boolean;
+    }
+}

package/serialization/resources/agents/types/AgentPrompting.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.AgentPrompting = void 0;
+const core = __importStar(require("../../../../core"));
+const LlmPersona_1 = require("../../commons/types/LlmPersona");
+exports.AgentPrompting = core.serialization.object({
+    persona: LlmPersona_1.LlmPersona,
+    additionalPromptText: core.serialization.string().optional(),
+    categoryGenerationPromptText: core.serialization.string().optional(),
+    contentSafetyViolationResponsePromptText: core.serialization.string().optional(),
+    rejectQuestionsWithoutKnowledge: core.serialization.boolean(),
+});

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

@@ -2,8 +2,8 @@ export * from "./PiiCategory";
 export * from "./AgentEnvironment";
 export * from "./Agent";
 export * from "./CreateAgentRequest";
-export * from "./AgentPatchRequest";
 export * from "./AgentsSearchRequest";
 export * from "./AgentField";
 export * from "./AgentFilter";
 export * from "./AgentsSearchResponse";
+export * from "./AgentPrompting";

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

@@ -18,8 +18,8 @@ __exportStar(require("./PiiCategory"), exports);
 __exportStar(require("./AgentEnvironment"), exports);
 __exportStar(require("./Agent"), exports);
 __exportStar(require("./CreateAgentRequest"), exports);
-__exportStar(require("./AgentPatchRequest"), exports);
 __exportStar(require("./AgentsSearchRequest"), exports);
 __exportStar(require("./AgentField"), exports);
 __exportStar(require("./AgentFilter"), exports);
 __exportStar(require("./AgentsSearchResponse"), exports);
+__exportStar(require("./AgentPrompting"), exports);

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

@@ -2,6 +2,7 @@ import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityId } from "./EntityId";
+import { UserDataWithReference } from "./UserDataWithReference";
 import { AppUser } from "./AppUser";
 export declare const AppUserResponse: core.serialization.ObjectSchema<serializers.AppUserResponse.Raw, MavenAGI.AppUserResponse>;
 export declare namespace AppUserResponse {
@@ -10,5 +11,6 @@ export declare namespace AppUserResponse {
         agentUserId: string;
         allUserData: Record<string, Record<string, string>>;
         defaultUserData: Record<string, string>;
+        agentUserData: Record<string, UserDataWithReference.Raw[]>;
     }
 }

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

@@ -37,6 +37,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppUserResponse = void 0;
 const core = __importStar(require("../../../../core"));
 const EntityId_1 = require("./EntityId");
+const UserDataWithReference_1 = require("./UserDataWithReference");
 const AppUser_1 = require("./AppUser");
 exports.AppUserResponse = core.serialization
     .object({
@@ -44,5 +45,6 @@ exports.AppUserResponse = core.serialization
     agentUserId: core.serialization.string(),
     allUserData: core.serialization.record(core.serialization.string(), core.serialization.record(core.serialization.string(), core.serialization.string())),
     defaultUserData: core.serialization.record(core.serialization.string(), core.serialization.string()),
+    agentUserData: core.serialization.record(core.serialization.string(), core.serialization.list(UserDataWithReference_1.UserDataWithReference)),
 })
     .extend(AppUser_1.AppUser);

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

@@ -17,5 +17,7 @@ export declare namespace ConversationSummary {
         humanAgents: string[];
         humanAgentsWithInserts: string[];
         users: string[];
+        lastUserMessage?: string | null;
+        lastBotMessage?: string | null;
     }
 }

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

@@ -50,4 +50,6 @@ exports.ConversationSummary = core.serialization.object({
     humanAgents: core.serialization.list(core.serialization.string()),
     humanAgentsWithInserts: core.serialization.list(core.serialization.string()),
     users: core.serialization.list(core.serialization.string()),
+    lastUserMessage: core.serialization.string().optional(),
+    lastBotMessage: core.serialization.string().optional(),
 });

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

@@ -6,6 +6,7 @@ import { EntityId } from "./EntityId";
 export declare const SimulationContext: core.serialization.ObjectSchema<serializers.SimulationContext.Raw, MavenAGI.SimulationContext>;
 export declare namespace SimulationContext {
     interface Raw {
+        additionalPromptText?: string | null;
         persona?: LlmPersona.Raw | null;
         availableKnowledgeBases?: EntityId.Raw[] | null;
     }

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

@@ -39,6 +39,7 @@ const core = __importStar(require("../../../../core"));
 const LlmPersona_1 = require("./LlmPersona");
 const EntityId_1 = require("./EntityId");
 exports.SimulationContext = core.serialization.object({
+    additionalPromptText: core.serialization.string().optional(),
     persona: LlmPersona_1.LlmPersona.optional(),
     availableKnowledgeBases: core.serialization.list(EntityId_1.EntityId).optional(),
 });