mavenagi 0.0.0-alpha.15 → 0.0.0-alpha.17

package/dist/serialization/resources/conversation/types/ConversationAnalysis.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 { Sentiment } from "./Sentiment";
+export declare const ConversationAnalysis: core.serialization.ObjectSchema<serializers.ConversationAnalysis.Raw, MavenAGI.ConversationAnalysis>;
+export declare namespace ConversationAnalysis {
+    interface Raw {
+        userRequest?: string | null;
+        agentResponse?: string | null;
+        sentiment: Sentiment.Raw;
+    }
+}

package/dist/serialization/resources/conversation/types/ConversationAnalysis.js

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import { Sentiment } from "./Sentiment";
+export const ConversationAnalysis = core.serialization.object({
+    userRequest: core.serialization.string().optional(),
+    agentResponse: core.serialization.string().optional(),
+    sentiment: Sentiment,
+});

package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts

@@ -6,11 +6,13 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { ConversationMessageResponse } from "./ConversationMessageResponse";
+import { ConversationAnalysis } from "./ConversationAnalysis";
 import { ConversationBase } from "./ConversationBase";
 export declare const ConversationResponse: core.serialization.ObjectSchema<serializers.ConversationResponse.Raw, MavenAGI.ConversationResponse>;
 export declare namespace ConversationResponse {
     interface Raw extends ConversationBase.Raw {
         conversationId: EntityId.Raw;
         messages: ConversationMessageResponse.Raw[];
+        analysis: ConversationAnalysis.Raw;
     }
 }

package/dist/serialization/resources/conversation/types/ConversationResponse.js

@@ -4,10 +4,12 @@
 import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { ConversationMessageResponse } from "./ConversationMessageResponse";
+import { ConversationAnalysis } from "./ConversationAnalysis";
 import { ConversationBase } from "./ConversationBase";
 export const ConversationResponse = core.serialization
     .object({
     conversationId: EntityId,
     messages: core.serialization.list(ConversationMessageResponse),
+    analysis: ConversationAnalysis,
 })
     .extend(ConversationBase);

package/dist/serialization/resources/conversation/types/ResponseConfig.d.ts

@@ -9,8 +9,8 @@ import { ResponseLength } from "./ResponseLength";
 export declare const ResponseConfig: core.serialization.ObjectSchema<serializers.ResponseConfig.Raw, MavenAGI.ResponseConfig>;
 export declare namespace ResponseConfig {
     interface Raw {
-        capabilities?: Capability.Raw[] | null;
-        isCopilot?: boolean | null;
-        responseLength?: ResponseLength.Raw | null;
+        capabilities: Capability.Raw[];
+        isCopilot: boolean;
+        responseLength: ResponseLength.Raw;
     }
 }

package/dist/serialization/resources/conversation/types/ResponseConfig.js

@@ -5,7 +5,7 @@ import * as core from "../../../../core";
 import { Capability } from "./Capability";
 import { ResponseLength } from "./ResponseLength";
 export const ResponseConfig = core.serialization.object({
-    capabilities: core.serialization.list(Capability).optional(),
-    isCopilot: core.serialization.boolean().optional(),
-    responseLength: ResponseLength.optional(),
+    capabilities: core.serialization.list(Capability),
+    isCopilot: core.serialization.boolean(),
+    responseLength: ResponseLength,
 });

package/dist/serialization/resources/conversation/types/Sentiment.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 Sentiment: core.serialization.Schema<serializers.Sentiment.Raw, MavenAGI.Sentiment>;
+export declare namespace Sentiment {
+    type Raw = "POSITIVE" | "NEGATIVE" | "NEUTRAL" | "MIXED" | "UNKNOWN";
+}

package/dist/serialization/resources/conversation/types/Sentiment.js

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+export const Sentiment = core.serialization.enum_(["POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED", "UNKNOWN"]);

package/dist/serialization/resources/conversation/types/StreamResponse.d.ts

@@ -5,15 +5,19 @@ import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { AskStreamTextEvent } from "./AskStreamTextEvent";
+import { AskStreamActionEvent } from "./AskStreamActionEvent";
 import { AskStreamMetadataEvent } from "./AskStreamMetadataEvent";
 import { AskStreamStartEvent } from "./AskStreamStartEvent";
 import { AskStreamEndEvent } from "./AskStreamEndEvent";
 export declare const StreamResponse: core.serialization.Schema<serializers.StreamResponse.Raw, MavenAGI.StreamResponse>;
 export declare namespace StreamResponse {
-    type Raw = StreamResponse.Text | StreamResponse.Metadata | StreamResponse.Start | StreamResponse.End;
+    type Raw = StreamResponse.Text | StreamResponse.Action | StreamResponse.Metadata | StreamResponse.Start | StreamResponse.End;
     interface Text extends AskStreamTextEvent.Raw {
         eventType: "text";
     }
+    interface Action extends AskStreamActionEvent.Raw {
+        eventType: "action";
+    }
     interface Metadata extends AskStreamMetadataEvent.Raw {
         eventType: "metadata";
     }

package/dist/serialization/resources/conversation/types/StreamResponse.js

@@ -3,12 +3,14 @@
  */
 import * as core from "../../../../core";
 import { AskStreamTextEvent } from "./AskStreamTextEvent";
+import { AskStreamActionEvent } from "./AskStreamActionEvent";
 import { AskStreamMetadataEvent } from "./AskStreamMetadataEvent";
 import { AskStreamStartEvent } from "./AskStreamStartEvent";
 import { AskStreamEndEvent } from "./AskStreamEndEvent";
 export const StreamResponse = core.serialization
     .union("eventType", {
     text: AskStreamTextEvent,
+    action: AskStreamActionEvent,
     metadata: AskStreamMetadataEvent,
     start: AskStreamStartEvent,
     end: AskStreamEndEvent,

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

@@ -9,6 +9,7 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./ConversationMessageBase";
 export * from "./ConversationMessageResponse";
+export * from "./ConversationAnalysis";
 export * from "./UserMessageBase";
 export * from "./UserMessage";
 export * from "./BotMessage";
@@ -19,11 +20,14 @@ export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./SubmitActionFormRequest";
 export * from "./UserConversationMessageType";
+export * from "./Sentiment";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
+export * from "./AskStreamActionEvent";
 export * from "./AskStreamMetadataEvent";
 export * from "./AskStreamStartEvent";
 export * from "./AskStreamEndEvent";
 export * from "./Source";
+export * from "./CategorizationResponse";

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

@@ -9,6 +9,7 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./ConversationMessageBase";
 export * from "./ConversationMessageResponse";
+export * from "./ConversationAnalysis";
 export * from "./UserMessageBase";
 export * from "./UserMessage";
 export * from "./BotMessage";
@@ -19,11 +20,14 @@ export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./SubmitActionFormRequest";
 export * from "./UserConversationMessageType";
+export * from "./Sentiment";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
+export * from "./AskStreamActionEvent";
 export * from "./AskStreamMetadataEvent";
 export * from "./AskStreamStartEvent";
 export * from "./AskStreamEndEvent";
 export * from "./Source";
+export * from "./CategorizationResponse";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mavenagi",
-    "version": "0.0.0-alpha.15",
+    "version": "0.0.0-alpha.17",
     "private": false,
     "repository": "https://github.com/mavenagi/mavenagi-node",
     "main": "./index.js",

package/reference.md

@@ -519,12 +519,12 @@ Ask a question
 ```typescript
 await client.conversation.ask("string", {
     conversationMessageId: {
-        referenceId: "string",
+        referenceId: "message-1",
     },
     userId: {
-        referenceId: "string",
+        referenceId: "user-1",
     },
-    text: "string",
+    text: "How do I reset my password?",
 });
 ```
 
@@ -580,7 +580,7 @@ await client.conversation.ask("string", {
 <dl>
 <dd>
 
-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.
 
 </dd>
 </dl>
@@ -596,14 +596,14 @@ Ask a question
 <dd>
 
 ```typescript
-await client.conversation.askStream("string", {
+await client.conversation.askStream("conversation-0", {
     conversationMessageId: {
-        referenceId: "string",
+        referenceId: "message-1",
     },
     userId: {
-        referenceId: "string",
+        referenceId: "user-1",
     },
-    text: "string",
+    text: "How do I reset my password?",
 });
 ```
 
@@ -724,6 +724,69 @@ await client.conversation.generateMavenSuggestions("string", {
 </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>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Uses an LLM flow to categorize the conversation. Experimental.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversation.categorize("string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**conversationId:** `string` — The ID of the conversation to categorize
+
+</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">createFeedback</a>({ ...params }) -> MavenAGI.Feedback</code></summary>
 <dl>
 <dd>

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

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import { BotActionFormResponse } from "./BotActionFormResponse";
+export const AskStreamActionEvent = core.serialization.object({}).extend(BotActionFormResponse);

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

@@ -6,5 +6,5 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 export declare const Capability: core.serialization.Schema<serializers.Capability.Raw, MavenAGI.Capability>;
 export declare namespace Capability {
-    type Raw = "MARKDOWN" | "FORMS";
+    type Raw = "MARKDOWN" | "FORMS" | "IMAGES";
 }

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

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as core from "../../../../core";
-export const Capability = core.serialization.enum_(["MARKDOWN", "FORMS"]);
+export const Capability = core.serialization.enum_(["MARKDOWN", "FORMS", "IMAGES"]);

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

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+export const CategorizationResponse = core.serialization.object({
+    category: core.serialization.string().optional(),
+});

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

@@ -0,0 +1,15 @@
+/**
+ * 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 { Sentiment } from "./Sentiment";
+export declare const ConversationAnalysis: core.serialization.ObjectSchema<serializers.ConversationAnalysis.Raw, MavenAGI.ConversationAnalysis>;
+export declare namespace ConversationAnalysis {
+    interface Raw {
+        userRequest?: string | null;
+        agentResponse?: string | null;
+        sentiment: Sentiment.Raw;
+    }
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+import { Sentiment } from "./Sentiment";
+export const ConversationAnalysis = core.serialization.object({
+    userRequest: core.serialization.string().optional(),
+    agentResponse: core.serialization.string().optional(),
+    sentiment: Sentiment,
+});

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

@@ -6,11 +6,13 @@ import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { ConversationMessageResponse } from "./ConversationMessageResponse";
+import { ConversationAnalysis } from "./ConversationAnalysis";
 import { ConversationBase } from "./ConversationBase";
 export declare const ConversationResponse: core.serialization.ObjectSchema<serializers.ConversationResponse.Raw, MavenAGI.ConversationResponse>;
 export declare namespace ConversationResponse {
     interface Raw extends ConversationBase.Raw {
         conversationId: EntityId.Raw;
         messages: ConversationMessageResponse.Raw[];
+        analysis: ConversationAnalysis.Raw;
     }
 }

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

@@ -4,10 +4,12 @@
 import * as core from "../../../../core";
 import { EntityId } from "../../commons/types/EntityId";
 import { ConversationMessageResponse } from "./ConversationMessageResponse";
+import { ConversationAnalysis } from "./ConversationAnalysis";
 import { ConversationBase } from "./ConversationBase";
 export const ConversationResponse = core.serialization
     .object({
     conversationId: EntityId,
     messages: core.serialization.list(ConversationMessageResponse),
+    analysis: ConversationAnalysis,
 })
     .extend(ConversationBase);

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

@@ -9,8 +9,8 @@ import { ResponseLength } from "./ResponseLength";
 export declare const ResponseConfig: core.serialization.ObjectSchema<serializers.ResponseConfig.Raw, MavenAGI.ResponseConfig>;
 export declare namespace ResponseConfig {
     interface Raw {
-        capabilities?: Capability.Raw[] | null;
-        isCopilot?: boolean | null;
-        responseLength?: ResponseLength.Raw | null;
+        capabilities: Capability.Raw[];
+        isCopilot: boolean;
+        responseLength: ResponseLength.Raw;
     }
 }

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

@@ -5,7 +5,7 @@ import * as core from "../../../../core";
 import { Capability } from "./Capability";
 import { ResponseLength } from "./ResponseLength";
 export const ResponseConfig = core.serialization.object({
-    capabilities: core.serialization.list(Capability).optional(),
-    isCopilot: core.serialization.boolean().optional(),
-    responseLength: ResponseLength.optional(),
+    capabilities: core.serialization.list(Capability),
+    isCopilot: core.serialization.boolean(),
+    responseLength: ResponseLength,
 });

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

@@ -0,0 +1,10 @@
+/**
+ * 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 Sentiment: core.serialization.Schema<serializers.Sentiment.Raw, MavenAGI.Sentiment>;
+export declare namespace Sentiment {
+    type Raw = "POSITIVE" | "NEGATIVE" | "NEUTRAL" | "MIXED" | "UNKNOWN";
+}

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

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../core";
+export const Sentiment = core.serialization.enum_(["POSITIVE", "NEGATIVE", "NEUTRAL", "MIXED", "UNKNOWN"]);

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

@@ -5,15 +5,19 @@ import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { AskStreamTextEvent } from "./AskStreamTextEvent";
+import { AskStreamActionEvent } from "./AskStreamActionEvent";
 import { AskStreamMetadataEvent } from "./AskStreamMetadataEvent";
 import { AskStreamStartEvent } from "./AskStreamStartEvent";
 import { AskStreamEndEvent } from "./AskStreamEndEvent";
 export declare const StreamResponse: core.serialization.Schema<serializers.StreamResponse.Raw, MavenAGI.StreamResponse>;
 export declare namespace StreamResponse {
-    type Raw = StreamResponse.Text | StreamResponse.Metadata | StreamResponse.Start | StreamResponse.End;
+    type Raw = StreamResponse.Text | StreamResponse.Action | StreamResponse.Metadata | StreamResponse.Start | StreamResponse.End;
     interface Text extends AskStreamTextEvent.Raw {
         eventType: "text";
     }
+    interface Action extends AskStreamActionEvent.Raw {
+        eventType: "action";
+    }
     interface Metadata extends AskStreamMetadataEvent.Raw {
         eventType: "metadata";
     }

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

@@ -3,12 +3,14 @@
  */
 import * as core from "../../../../core";
 import { AskStreamTextEvent } from "./AskStreamTextEvent";
+import { AskStreamActionEvent } from "./AskStreamActionEvent";
 import { AskStreamMetadataEvent } from "./AskStreamMetadataEvent";
 import { AskStreamStartEvent } from "./AskStreamStartEvent";
 import { AskStreamEndEvent } from "./AskStreamEndEvent";
 export const StreamResponse = core.serialization
     .union("eventType", {
     text: AskStreamTextEvent,
+    action: AskStreamActionEvent,
     metadata: AskStreamMetadataEvent,
     start: AskStreamStartEvent,
     end: AskStreamEndEvent,

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

@@ -9,6 +9,7 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./ConversationMessageBase";
 export * from "./ConversationMessageResponse";
+export * from "./ConversationAnalysis";
 export * from "./UserMessageBase";
 export * from "./UserMessage";
 export * from "./BotMessage";
@@ -19,11 +20,14 @@ export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./SubmitActionFormRequest";
 export * from "./UserConversationMessageType";
+export * from "./Sentiment";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
+export * from "./AskStreamActionEvent";
 export * from "./AskStreamMetadataEvent";
 export * from "./AskStreamStartEvent";
 export * from "./AskStreamEndEvent";
 export * from "./Source";
+export * from "./CategorizationResponse";

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

@@ -9,6 +9,7 @@ export * from "./ConversationRequest";
 export * from "./ConversationMessageRequest";
 export * from "./ConversationMessageBase";
 export * from "./ConversationMessageResponse";
+export * from "./ConversationAnalysis";
 export * from "./UserMessageBase";
 export * from "./UserMessage";
 export * from "./BotMessage";
@@ -19,11 +20,14 @@ export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
 export * from "./SubmitActionFormRequest";
 export * from "./UserConversationMessageType";
+export * from "./Sentiment";
 export * from "./BotConversationMessageType";
 export * from "./FeedbackRequest";
 export * from "./StreamResponse";
 export * from "./AskStreamTextEvent";
+export * from "./AskStreamActionEvent";
 export * from "./AskStreamMetadataEvent";
 export * from "./AskStreamStartEvent";
 export * from "./AskStreamEndEvent";
 export * from "./Source";
+export * from "./CategorizationResponse";