mavenagi 0.0.0-alpha.12 → 0.0.0-alpha.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/README.md +8 -1
  2. package/api/resources/actions/client/Client.js +3 -3
  3. package/api/resources/commons/types/AppUser.d.ts +3 -2
  4. package/api/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  5. package/api/resources/commons/types/AppUserRequest.d.ts +19 -1
  6. package/api/resources/commons/types/AppUserResponse.d.ts +34 -2
  7. package/api/resources/commons/types/Feedback.d.ts +12 -0
  8. package/api/resources/commons/types/UserData.d.ts +1 -1
  9. package/api/resources/commons/types/index.d.ts +4 -2
  10. package/api/resources/commons/types/index.js +4 -2
  11. package/api/resources/conversation/client/Client.d.ts +21 -19
  12. package/api/resources/conversation/client/Client.js +35 -28
  13. package/api/resources/conversation/types/AskRequest.d.ts +2 -4
  14. package/api/resources/conversation/types/ConversationBase.d.ts +12 -0
  15. package/api/resources/conversation/types/ConversationMessageBase.d.ts +4 -3
  16. package/api/resources/conversation/types/ConversationRequest.d.ts +0 -2
  17. package/api/resources/conversation/types/ConversationResponse.d.ts +0 -2
  18. package/api/resources/conversation/types/SubmitActionFormRequest.d.ts +1 -3
  19. package/api/resources/conversation/types/UserMessageBase.d.ts +2 -0
  20. package/api/resources/conversation/types/index.d.ts +0 -2
  21. package/api/resources/conversation/types/index.js +0 -2
  22. package/api/resources/knowledge/client/Client.js +7 -7
  23. package/api/resources/triggers/client/Client.js +3 -3
  24. package/api/resources/triggers/types/index.d.ts +0 -3
  25. package/api/resources/triggers/types/index.js +0 -3
  26. package/api/resources/users/client/Client.d.ts +18 -14
  27. package/api/resources/users/client/Client.js +21 -17
  28. package/dist/api/resources/actions/client/Client.js +3 -3
  29. package/dist/api/resources/commons/types/AppUser.d.ts +3 -2
  30. package/dist/api/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  31. package/dist/api/resources/commons/types/AppUserRequest.d.ts +19 -1
  32. package/dist/api/resources/commons/types/AppUserResponse.d.ts +34 -2
  33. package/dist/api/resources/commons/types/Feedback.d.ts +12 -0
  34. package/dist/api/resources/commons/types/UserData.d.ts +1 -1
  35. package/dist/api/resources/commons/types/index.d.ts +4 -2
  36. package/dist/api/resources/commons/types/index.js +4 -2
  37. package/dist/api/resources/conversation/client/Client.d.ts +21 -19
  38. package/dist/api/resources/conversation/client/Client.js +35 -28
  39. package/dist/api/resources/conversation/types/AskRequest.d.ts +2 -4
  40. package/dist/api/resources/conversation/types/ConversationBase.d.ts +12 -0
  41. package/dist/api/resources/conversation/types/ConversationMessageBase.d.ts +4 -3
  42. package/dist/api/resources/conversation/types/ConversationRequest.d.ts +0 -2
  43. package/dist/api/resources/conversation/types/ConversationResponse.d.ts +0 -2
  44. package/dist/api/resources/conversation/types/SubmitActionFormRequest.d.ts +1 -3
  45. package/dist/api/resources/conversation/types/UserMessageBase.d.ts +2 -0
  46. package/dist/api/resources/conversation/types/index.d.ts +0 -2
  47. package/dist/api/resources/conversation/types/index.js +0 -2
  48. package/dist/api/resources/knowledge/client/Client.js +7 -7
  49. package/dist/api/resources/triggers/client/Client.js +3 -3
  50. package/dist/api/resources/triggers/types/index.d.ts +0 -3
  51. package/dist/api/resources/triggers/types/index.js +0 -3
  52. package/dist/api/resources/users/client/Client.d.ts +18 -14
  53. package/dist/api/resources/users/client/Client.js +21 -17
  54. package/dist/serialization/resources/commons/types/AppUser.d.ts +3 -3
  55. package/dist/serialization/resources/commons/types/AppUser.js +3 -3
  56. package/dist/serialization/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  57. package/dist/serialization/resources/commons/types/AppUserIdentifier.js +1 -1
  58. package/dist/serialization/resources/commons/types/AppUserRequest.d.ts +1 -1
  59. package/dist/serialization/resources/commons/types/AppUserRequest.js +1 -1
  60. package/dist/serialization/resources/commons/types/AppUserResponse.d.ts +2 -1
  61. package/dist/serialization/resources/commons/types/AppUserResponse.js +2 -1
  62. package/{serialization/resources/triggers → dist/serialization/resources/commons}/types/EventTriggerResponse.d.ts +1 -1
  63. package/{serialization/resources/triggers → dist/serialization/resources/commons}/types/EventTriggerResponse.js +1 -1
  64. package/dist/serialization/resources/commons/types/Feedback.d.ts +16 -0
  65. package/dist/serialization/resources/commons/types/Feedback.js +13 -0
  66. package/dist/serialization/resources/commons/types/UserData.d.ts +1 -1
  67. package/dist/serialization/resources/commons/types/UserData.js +1 -1
  68. package/dist/serialization/resources/commons/types/index.d.ts +4 -2
  69. package/dist/serialization/resources/commons/types/index.js +4 -2
  70. package/dist/serialization/resources/conversation/types/AskRequest.d.ts +1 -4
  71. package/dist/serialization/resources/conversation/types/AskRequest.js +1 -4
  72. package/dist/serialization/resources/conversation/types/ConversationBase.d.ts +6 -0
  73. package/dist/serialization/resources/conversation/types/ConversationBase.js +6 -0
  74. package/dist/serialization/resources/conversation/types/ConversationMessageBase.d.ts +2 -2
  75. package/dist/serialization/resources/conversation/types/ConversationMessageBase.js +2 -2
  76. package/dist/serialization/resources/conversation/types/ConversationRequest.d.ts +0 -2
  77. package/dist/serialization/resources/conversation/types/ConversationRequest.js +0 -2
  78. package/dist/serialization/resources/conversation/types/ConversationResponse.d.ts +0 -2
  79. package/dist/serialization/resources/conversation/types/ConversationResponse.js +0 -2
  80. package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +0 -2
  81. package/dist/serialization/resources/conversation/types/SubmitActionFormRequest.js +0 -2
  82. package/dist/serialization/resources/conversation/types/UserMessageBase.d.ts +2 -0
  83. package/dist/serialization/resources/conversation/types/UserMessageBase.js +2 -0
  84. package/dist/serialization/resources/conversation/types/index.d.ts +0 -2
  85. package/dist/serialization/resources/conversation/types/index.js +0 -2
  86. package/dist/serialization/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
  87. package/dist/serialization/resources/triggers/types/EventTriggerRequest.js +1 -1
  88. package/dist/serialization/resources/triggers/types/index.d.ts +0 -3
  89. package/dist/serialization/resources/triggers/types/index.js +0 -3
  90. package/package.json +1 -1
  91. package/reference.md +43 -34
  92. package/serialization/resources/commons/types/AppUser.d.ts +3 -3
  93. package/serialization/resources/commons/types/AppUser.js +3 -3
  94. package/serialization/resources/commons/types/AppUserIdentifier.d.ts +1 -1
  95. package/serialization/resources/commons/types/AppUserIdentifier.js +1 -1
  96. package/serialization/resources/commons/types/AppUserRequest.d.ts +1 -1
  97. package/serialization/resources/commons/types/AppUserRequest.js +1 -1
  98. package/serialization/resources/commons/types/AppUserResponse.d.ts +2 -1
  99. package/serialization/resources/commons/types/AppUserResponse.js +2 -1
  100. package/{dist/serialization/resources/triggers → serialization/resources/commons}/types/EventTriggerResponse.d.ts +1 -1
  101. package/{dist/serialization/resources/triggers → serialization/resources/commons}/types/EventTriggerResponse.js +1 -1
  102. package/serialization/resources/commons/types/Feedback.d.ts +16 -0
  103. package/serialization/resources/commons/types/Feedback.js +13 -0
  104. package/serialization/resources/commons/types/UserData.d.ts +1 -1
  105. package/serialization/resources/commons/types/UserData.js +1 -1
  106. package/serialization/resources/commons/types/index.d.ts +4 -2
  107. package/serialization/resources/commons/types/index.js +4 -2
  108. package/serialization/resources/conversation/types/AskRequest.d.ts +1 -4
  109. package/serialization/resources/conversation/types/AskRequest.js +1 -4
  110. package/serialization/resources/conversation/types/ConversationBase.d.ts +6 -0
  111. package/serialization/resources/conversation/types/ConversationBase.js +6 -0
  112. package/serialization/resources/conversation/types/ConversationMessageBase.d.ts +2 -2
  113. package/serialization/resources/conversation/types/ConversationMessageBase.js +2 -2
  114. package/serialization/resources/conversation/types/ConversationRequest.d.ts +0 -2
  115. package/serialization/resources/conversation/types/ConversationRequest.js +0 -2
  116. package/serialization/resources/conversation/types/ConversationResponse.d.ts +0 -2
  117. package/serialization/resources/conversation/types/ConversationResponse.js +0 -2
  118. package/serialization/resources/conversation/types/SubmitActionFormRequest.d.ts +0 -2
  119. package/serialization/resources/conversation/types/SubmitActionFormRequest.js +0 -2
  120. package/serialization/resources/conversation/types/UserMessageBase.d.ts +2 -0
  121. package/serialization/resources/conversation/types/UserMessageBase.js +2 -0
  122. package/serialization/resources/conversation/types/index.d.ts +0 -2
  123. package/serialization/resources/conversation/types/index.js +0 -2
  124. package/serialization/resources/triggers/types/EventTriggerRequest.d.ts +1 -1
  125. package/serialization/resources/triggers/types/EventTriggerRequest.js +1 -1
  126. package/serialization/resources/triggers/types/index.d.ts +0 -3
  127. package/serialization/resources/triggers/types/index.js +0 -3
  128. package/api/resources/commons/types/AppUserIdentification.d.ts +0 -8
  129. package/api/resources/commons/types/User.d.ts +0 -10
  130. package/api/resources/conversation/types/ConversationContext.d.ts +0 -20
  131. package/api/resources/conversation/types/ConversationContext.js +0 -4
  132. package/api/resources/conversation/types/ConversationMessageContext.d.ts +0 -12
  133. package/api/resources/conversation/types/ConversationMessageContext.js +0 -4
  134. package/dist/api/resources/commons/types/AppUserIdentification.d.ts +0 -8
  135. package/dist/api/resources/commons/types/AppUserIdentification.js +0 -4
  136. package/dist/api/resources/commons/types/User.d.ts +0 -10
  137. package/dist/api/resources/commons/types/User.js +0 -4
  138. package/dist/api/resources/conversation/types/ConversationContext.d.ts +0 -20
  139. package/dist/api/resources/conversation/types/ConversationContext.js +0 -4
  140. package/dist/api/resources/conversation/types/ConversationMessageContext.d.ts +0 -12
  141. package/dist/api/resources/conversation/types/ConversationMessageContext.js +0 -4
  142. package/dist/serialization/resources/commons/types/AppUserIdentification.d.ts +0 -13
  143. package/dist/serialization/resources/commons/types/AppUserIdentification.js +0 -8
  144. package/dist/serialization/resources/commons/types/User.d.ts +0 -15
  145. package/dist/serialization/resources/commons/types/User.js +0 -10
  146. package/dist/serialization/resources/conversation/types/ConversationContext.d.ts +0 -20
  147. package/dist/serialization/resources/conversation/types/ConversationContext.js +0 -15
  148. package/dist/serialization/resources/conversation/types/ConversationMessageContext.d.ts +0 -16
  149. package/dist/serialization/resources/conversation/types/ConversationMessageContext.js +0 -11
  150. package/serialization/resources/commons/types/AppUserIdentification.d.ts +0 -13
  151. package/serialization/resources/commons/types/AppUserIdentification.js +0 -8
  152. package/serialization/resources/commons/types/User.d.ts +0 -15
  153. package/serialization/resources/commons/types/User.js +0 -10
  154. package/serialization/resources/conversation/types/ConversationContext.d.ts +0 -20
  155. package/serialization/resources/conversation/types/ConversationContext.js +0 -15
  156. package/serialization/resources/conversation/types/ConversationMessageContext.d.ts +0 -16
  157. package/serialization/resources/conversation/types/ConversationMessageContext.js +0 -11
  158. /package/api/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  159. /package/api/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  160. /package/api/resources/{triggers → commons}/types/EventTriggerResponse.d.ts +0 -0
  161. /package/api/resources/{triggers → commons}/types/EventTriggerResponse.js +0 -0
  162. /package/api/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  163. /package/api/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
  164. /package/api/resources/commons/types/{AppUserIdentification.js → Feedback.js} +0 -0
  165. /package/dist/api/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  166. /package/dist/api/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  167. /package/dist/api/resources/{triggers → commons}/types/EventTriggerResponse.d.ts +0 -0
  168. /package/dist/api/resources/{triggers → commons}/types/EventTriggerResponse.js +0 -0
  169. /package/dist/api/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  170. /package/dist/api/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
  171. /package/{api/resources/commons/types/User.js → dist/api/resources/commons/types/Feedback.js} +0 -0
  172. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  173. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  174. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  175. /package/dist/serialization/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
  176. /package/serialization/resources/{triggers → commons}/types/EventTriggerBase.d.ts +0 -0
  177. /package/serialization/resources/{triggers → commons}/types/EventTriggerBase.js +0 -0
  178. /package/serialization/resources/{triggers → commons}/types/EventTriggerType.d.ts +0 -0
  179. /package/serialization/resources/{triggers → commons}/types/EventTriggerType.js +0 -0
@@ -6,13 +6,11 @@ import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
7
  import { EntityIdBase } from "../../commons/types/EntityIdBase";
8
8
  import { ConversationMessageRequest } from "./ConversationMessageRequest";
9
- import { ConversationContext } from "./ConversationContext";
10
9
  import { ConversationBase } from "./ConversationBase";
11
10
  export declare const ConversationRequest: core.serialization.ObjectSchema<serializers.ConversationRequest.Raw, MavenAGI.ConversationRequest>;
12
11
  export declare namespace ConversationRequest {
13
12
  interface Raw extends ConversationBase.Raw {
14
13
  conversationId: EntityIdBase.Raw;
15
14
  messages: ConversationMessageRequest.Raw[];
16
- context?: ConversationContext.Raw | null;
17
15
  }
18
16
  }
@@ -4,12 +4,10 @@
4
4
  import * as core from "../../../../core";
5
5
  import { EntityIdBase } from "../../commons/types/EntityIdBase";
6
6
  import { ConversationMessageRequest } from "./ConversationMessageRequest";
7
- import { ConversationContext } from "./ConversationContext";
8
7
  import { ConversationBase } from "./ConversationBase";
9
8
  export const ConversationRequest = core.serialization
10
9
  .object({
11
10
  conversationId: EntityIdBase,
12
11
  messages: core.serialization.list(ConversationMessageRequest),
13
- context: ConversationContext.optional(),
14
12
  })
15
13
  .extend(ConversationBase);
@@ -6,13 +6,11 @@ import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
7
  import { EntityId } from "../../commons/types/EntityId";
8
8
  import { ConversationMessageResponse } from "./ConversationMessageResponse";
9
- import { ConversationContext } from "./ConversationContext";
10
9
  import { ConversationBase } from "./ConversationBase";
11
10
  export declare const ConversationResponse: core.serialization.ObjectSchema<serializers.ConversationResponse.Raw, MavenAGI.ConversationResponse>;
12
11
  export declare namespace ConversationResponse {
13
12
  interface Raw extends ConversationBase.Raw {
14
13
  conversationId: EntityId.Raw;
15
14
  messages: ConversationMessageResponse.Raw[];
16
- context: ConversationContext.Raw;
17
15
  }
18
16
  }
@@ -4,12 +4,10 @@
4
4
  import * as core from "../../../../core";
5
5
  import { EntityId } from "../../commons/types/EntityId";
6
6
  import { ConversationMessageResponse } from "./ConversationMessageResponse";
7
- import { ConversationContext } from "./ConversationContext";
8
7
  import { ConversationBase } from "./ConversationBase";
9
8
  export const ConversationResponse = core.serialization
10
9
  .object({
11
10
  conversationId: EntityId,
12
11
  messages: core.serialization.list(ConversationMessageResponse),
13
- context: ConversationContext,
14
12
  })
15
13
  .extend(ConversationBase);
@@ -4,12 +4,10 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
- import { User } from "../../commons/types/User";
8
7
  export declare const SubmitActionFormRequest: core.serialization.ObjectSchema<serializers.SubmitActionFormRequest.Raw, MavenAGI.SubmitActionFormRequest>;
9
8
  export declare namespace SubmitActionFormRequest {
10
9
  interface Raw {
11
10
  actionFormId: string;
12
- userContext: User.Raw;
13
11
  parameters: Record<string, unknown>;
14
12
  }
15
13
  }
@@ -2,9 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as core from "../../../../core";
5
- import { User } from "../../commons/types/User";
6
5
  export const SubmitActionFormRequest = core.serialization.object({
7
6
  actionFormId: core.serialization.string(),
8
- userContext: User,
9
7
  parameters: core.serialization.record(core.serialization.string(), core.serialization.unknown()),
10
8
  });
@@ -4,11 +4,13 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
+ import { EntityIdBase } from "../../commons/types/EntityIdBase";
7
8
  import { UserConversationMessageType } from "./UserConversationMessageType";
8
9
  import { ConversationMessageBase } from "./ConversationMessageBase";
9
10
  export declare const UserMessageBase: core.serialization.ObjectSchema<serializers.UserMessageBase.Raw, MavenAGI.UserMessageBase>;
10
11
  export declare namespace UserMessageBase {
11
12
  interface Raw extends ConversationMessageBase.Raw {
13
+ userId: EntityIdBase.Raw;
12
14
  text: string;
13
15
  userMessageType: UserConversationMessageType.Raw;
14
16
  }
@@ -2,10 +2,12 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as core from "../../../../core";
5
+ import { EntityIdBase } from "../../commons/types/EntityIdBase";
5
6
  import { UserConversationMessageType } from "./UserConversationMessageType";
6
7
  import { ConversationMessageBase } from "./ConversationMessageBase";
7
8
  export const UserMessageBase = core.serialization
8
9
  .object({
10
+ userId: EntityIdBase,
9
11
  text: core.serialization.string(),
10
12
  userMessageType: UserConversationMessageType,
11
13
  })
@@ -18,8 +18,6 @@ export * from "./BotTextResponse";
18
18
  export * from "./BotActionFormResponse";
19
19
  export * from "./ActionFormField";
20
20
  export * from "./SubmitActionFormRequest";
21
- export * from "./ConversationContext";
22
- export * from "./ConversationMessageContext";
23
21
  export * from "./UserConversationMessageType";
24
22
  export * from "./BotConversationMessageType";
25
23
  export * from "./FeedbackRequest";
@@ -18,8 +18,6 @@ export * from "./BotTextResponse";
18
18
  export * from "./BotActionFormResponse";
19
19
  export * from "./ActionFormField";
20
20
  export * from "./SubmitActionFormRequest";
21
- export * from "./ConversationContext";
22
- export * from "./ConversationMessageContext";
23
21
  export * from "./UserConversationMessageType";
24
22
  export * from "./BotConversationMessageType";
25
23
  export * from "./FeedbackRequest";
@@ -5,7 +5,7 @@ import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
7
  import { EntityIdBase } from "../../commons/types/EntityIdBase";
8
- import { EventTriggerBase } from "./EventTriggerBase";
8
+ import { EventTriggerBase } from "../../commons/types/EventTriggerBase";
9
9
  export declare const EventTriggerRequest: core.serialization.ObjectSchema<serializers.EventTriggerRequest.Raw, MavenAGI.EventTriggerRequest>;
10
10
  export declare namespace EventTriggerRequest {
11
11
  interface Raw extends EventTriggerBase.Raw {
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import * as core from "../../../../core";
5
5
  import { EntityIdBase } from "../../commons/types/EntityIdBase";
6
- import { EventTriggerBase } from "./EventTriggerBase";
6
+ import { EventTriggerBase } from "../../commons/types/EventTriggerBase";
7
7
  export const EventTriggerRequest = core.serialization
8
8
  .object({
9
9
  triggerId: EntityIdBase,
@@ -1,4 +1 @@
1
- export * from "./EventTriggerBase";
2
1
  export * from "./EventTriggerRequest";
3
- export * from "./EventTriggerResponse";
4
- export * from "./EventTriggerType";
@@ -1,4 +1 @@
1
- export * from "./EventTriggerBase";
2
1
  export * from "./EventTriggerRequest";
3
- export * from "./EventTriggerResponse";
4
- export * from "./EventTriggerType";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mavenagi",
3
- "version": "0.0.0-alpha.12",
3
+ "version": "0.0.0-alpha.14",
4
4
  "private": false,
5
5
  "repository": "https://github.com/mavenagi/mavenagi-node",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -216,7 +216,7 @@ await client.actions.delete("get-balance");
216
216
  <dl>
217
217
  <dd>
218
218
 
219
- Pre-populate a new conversation with messages
219
+ Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
220
220
 
221
221
  </dd>
222
222
  </dl>
@@ -237,12 +237,19 @@ await client.conversation.initialize({
237
237
  referenceId: "string",
238
238
  },
239
239
  messages: [{}],
240
- context: {},
241
240
  responseConfig: {
242
241
  capabilities: [MavenAGI.Capability.Markdown],
243
242
  isCopilot: true,
244
243
  responseLength: MavenAGI.ResponseLength.Short,
245
244
  },
245
+ subject: "string",
246
+ url: "string",
247
+ createdAt: new Date("2024-01-15T09:30:00.000Z"),
248
+ updatedAt: new Date("2024-01-15T09:30:00.000Z"),
249
+ tags: new Set(["string"]),
250
+ metadata: {
251
+ string: "string",
252
+ },
246
253
  });
247
254
  ```
248
255
 
@@ -374,9 +381,13 @@ await client.conversation.appendNewMessages("string", [
374
381
  conversationMessageId: {
375
382
  referenceId: "string",
376
383
  },
384
+ userId: {
385
+ referenceId: "string",
386
+ },
377
387
  text: "string",
378
388
  userMessageType: MavenAGI.UserConversationMessageType.User,
379
- context: {},
389
+ createdAt: new Date("2024-01-15T09:30:00.000Z"),
390
+ updatedAt: new Date("2024-01-15T09:30:00.000Z"),
380
391
  },
381
392
  ]);
382
393
  ```
@@ -433,7 +444,7 @@ await client.conversation.appendNewMessages("string", [
433
444
  <dl>
434
445
  <dd>
435
446
 
436
- Ask a question in a conversation
447
+ Ask a question
437
448
 
438
449
  </dd>
439
450
  </dl>
@@ -453,9 +464,10 @@ await client.conversation.ask("string", {
453
464
  conversationMessageId: {
454
465
  referenceId: "string",
455
466
  },
467
+ userId: {
468
+ referenceId: "string",
469
+ },
456
470
  text: "string",
457
- context: {},
458
- responseConfig: {},
459
471
  });
460
472
  ```
461
473
 
@@ -531,9 +543,10 @@ await client.conversation.askStream("string", {
531
543
  conversationMessageId: {
532
544
  referenceId: "string",
533
545
  },
546
+ userId: {
547
+ referenceId: "string",
548
+ },
534
549
  text: "string",
535
- context: {},
536
- responseConfig: {},
537
550
  });
538
551
  ```
539
552
 
@@ -654,7 +667,7 @@ await client.conversation.generateMavenSuggestions("string", {
654
667
  </dl>
655
668
  </details>
656
669
 
657
- <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> void</code></summary>
670
+ <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> MavenAGI.Feedback</code></summary>
658
671
  <dl>
659
672
  <dd>
660
673
 
@@ -759,16 +772,6 @@ Submit a filled out action form
759
772
  ```typescript
760
773
  await client.conversation.submitActionForm("string", {
761
774
  actionFormId: "string",
762
- userContext: {
763
- name: "string",
764
- id: {
765
- string: "string",
766
- },
767
- email: "string",
768
- context: {
769
- string: "string",
770
- },
771
- },
772
775
  parameters: {
773
776
  string: {
774
777
  key: "value",
@@ -829,7 +832,7 @@ await client.conversation.submitActionForm("string", {
829
832
  <dl>
830
833
  <dd>
831
834
 
832
- Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
835
+ Add metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
833
836
 
834
837
  </dd>
835
838
  </dl>
@@ -1586,7 +1589,7 @@ await client.triggers.delete("store-in-snowflake");
1586
1589
 
1587
1590
  ## Users
1588
1591
 
1589
- <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">upsertAppUser</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>
1592
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>
1590
1593
  <dl>
1591
1594
  <dd>
1592
1595
 
@@ -1598,7 +1601,7 @@ await client.triggers.delete("store-in-snowflake");
1598
1601
  <dl>
1599
1602
  <dd>
1600
1603
 
1601
- Create a new user or update an existing one
1604
+ Update a user or create it if it doesn't exist.
1602
1605
 
1603
1606
  </dd>
1604
1607
  </dl>
@@ -1614,15 +1617,21 @@ Create a new user or update an existing one
1614
1617
  <dd>
1615
1618
 
1616
1619
  ```typescript
1617
- await client.users.upsertAppUser({
1618
- appUserId: {
1619
- referenceId: "string",
1620
- },
1621
- userIdentifiers: {
1622
- identifiers: new Set([{}]),
1620
+ await client.users.createOrUpdate({
1621
+ userId: {
1622
+ referenceId: "user-0",
1623
1623
  },
1624
- metadata: {
1625
- string: {},
1624
+ identifiers: new Set([
1625
+ {
1626
+ value: "joe@myapp.com",
1627
+ type: MavenAGI.AppUserIdentifyingPropertyType.Email,
1628
+ },
1629
+ ]),
1630
+ data: {
1631
+ name: {
1632
+ value: "Joe",
1633
+ visibility: MavenAGI.VisibilityType.Visible,
1634
+ },
1626
1635
  },
1627
1636
  });
1628
1637
  ```
@@ -1659,7 +1668,7 @@ await client.users.upsertAppUser({
1659
1668
  </dl>
1660
1669
  </details>
1661
1670
 
1662
- <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getAppUser</a>(userId) -> MavenAGI.AppUserResponse</code></summary>
1671
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">get</a>(userId) -> MavenAGI.AppUserResponse</code></summary>
1663
1672
  <dl>
1664
1673
  <dd>
1665
1674
 
@@ -1671,7 +1680,7 @@ await client.users.upsertAppUser({
1671
1680
  <dl>
1672
1681
  <dd>
1673
1682
 
1674
- Get a user
1683
+ Get a user by its supplied ID
1675
1684
 
1676
1685
  </dd>
1677
1686
  </dl>
@@ -1687,7 +1696,7 @@ Get a user
1687
1696
  <dd>
1688
1697
 
1689
1698
  ```typescript
1690
- await client.users.getAppUser("string");
1699
+ await client.users.get("user-0");
1691
1700
  ```
1692
1701
 
1693
1702
  </dd>
@@ -1703,7 +1712,7 @@ await client.users.getAppUser("string");
1703
1712
  <dl>
1704
1713
  <dd>
1705
1714
 
1706
- **userId:** `string` — Externally supplied unique ID of the user
1715
+ **userId:** `string` — The reference ID of the user to get. All other entity ID fields are inferred from the request.
1707
1716
 
1708
1717
  </dd>
1709
1718
  </dl>
@@ -4,12 +4,12 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
- import { AppUserIdentification } from "./AppUserIdentification";
7
+ import { AppUserIdentifier } from "./AppUserIdentifier";
8
8
  import { UserData } from "./UserData";
9
9
  export declare const AppUser: core.serialization.ObjectSchema<serializers.AppUser.Raw, MavenAGI.AppUser>;
10
10
  export declare namespace AppUser {
11
11
  interface Raw {
12
- userIdentifiers?: AppUserIdentification.Raw | null;
13
- metadata?: Record<string, UserData.Raw> | null;
12
+ identifiers: AppUserIdentifier.Raw[];
13
+ data: Record<string, UserData.Raw>;
14
14
  }
15
15
  }
@@ -2,9 +2,9 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as core from "../../../../core";
5
- import { AppUserIdentification } from "./AppUserIdentification";
5
+ import { AppUserIdentifier } from "./AppUserIdentifier";
6
6
  import { UserData } from "./UserData";
7
7
  export const AppUser = core.serialization.object({
8
- userIdentifiers: AppUserIdentification.optional(),
9
- metadata: core.serialization.record(core.serialization.string(), UserData).optional(),
8
+ identifiers: core.serialization.list(AppUserIdentifier),
9
+ data: core.serialization.record(core.serialization.string(), UserData),
10
10
  });
@@ -9,6 +9,6 @@ export declare const AppUserIdentifier: core.serialization.ObjectSchema<serializ
9
9
  export declare namespace AppUserIdentifier {
10
10
  interface Raw {
11
11
  value: string;
12
- userIdentifyingPropertyType: AppUserIdentifyingPropertyType.Raw;
12
+ type: AppUserIdentifyingPropertyType.Raw;
13
13
  }
14
14
  }
@@ -5,5 +5,5 @@ import * as core from "../../../../core";
5
5
  import { AppUserIdentifyingPropertyType } from "./AppUserIdentifyingPropertyType";
6
6
  export const AppUserIdentifier = core.serialization.object({
7
7
  value: core.serialization.string(),
8
- userIdentifyingPropertyType: AppUserIdentifyingPropertyType,
8
+ type: AppUserIdentifyingPropertyType,
9
9
  });
@@ -9,6 +9,6 @@ import { AppUser } from "./AppUser";
9
9
  export declare const AppUserRequest: core.serialization.ObjectSchema<serializers.AppUserRequest.Raw, MavenAGI.AppUserRequest>;
10
10
  export declare namespace AppUserRequest {
11
11
  interface Raw extends AppUser.Raw {
12
- appUserId: EntityIdBase.Raw;
12
+ userId: EntityIdBase.Raw;
13
13
  }
14
14
  }
@@ -6,6 +6,6 @@ import { EntityIdBase } from "./EntityIdBase";
6
6
  import { AppUser } from "./AppUser";
7
7
  export const AppUserRequest = core.serialization
8
8
  .object({
9
- appUserId: EntityIdBase,
9
+ userId: EntityIdBase,
10
10
  })
11
11
  .extend(AppUser);
@@ -9,6 +9,7 @@ import { AppUser } from "./AppUser";
9
9
  export declare const AppUserResponse: core.serialization.ObjectSchema<serializers.AppUserResponse.Raw, MavenAGI.AppUserResponse>;
10
10
  export declare namespace AppUserResponse {
11
11
  interface Raw extends AppUser.Raw {
12
- appUserId: EntityId.Raw;
12
+ userId: EntityId.Raw;
13
+ allUserData: Record<string, Record<string, string>>;
13
14
  }
14
15
  }
@@ -6,6 +6,7 @@ import { EntityId } from "./EntityId";
6
6
  import { AppUser } from "./AppUser";
7
7
  export const AppUserResponse = core.serialization
8
8
  .object({
9
- appUserId: EntityId,
9
+ userId: EntityId,
10
+ allUserData: core.serialization.record(core.serialization.string(), core.serialization.record(core.serialization.string(), core.serialization.string())),
10
11
  })
11
12
  .extend(AppUser);
@@ -4,7 +4,7 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
- import { EntityId } from "../../commons/types/EntityId";
7
+ import { EntityId } from "./EntityId";
8
8
  import { EventTriggerBase } from "./EventTriggerBase";
9
9
  export declare const EventTriggerResponse: core.serialization.ObjectSchema<serializers.EventTriggerResponse.Raw, MavenAGI.EventTriggerResponse>;
10
10
  export declare namespace EventTriggerResponse {
@@ -2,7 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as core from "../../../../core";
5
- import { EntityId } from "../../commons/types/EntityId";
5
+ import { EntityId } from "./EntityId";
6
6
  import { EventTriggerBase } from "./EventTriggerBase";
7
7
  export const EventTriggerResponse = core.serialization
8
8
  .object({
@@ -0,0 +1,16 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as MavenAGI from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ import { EntityId } from "./EntityId";
8
+ import { FeedbackBase } from "./FeedbackBase";
9
+ export declare const Feedback: core.serialization.ObjectSchema<serializers.Feedback.Raw, MavenAGI.Feedback>;
10
+ export declare namespace Feedback {
11
+ interface Raw extends FeedbackBase.Raw {
12
+ feedbackId: EntityId.Raw;
13
+ conversationId: EntityId.Raw;
14
+ conversationMessageId: EntityId.Raw;
15
+ }
16
+ }
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as core from "../../../../core";
5
+ import { EntityId } from "./EntityId";
6
+ import { FeedbackBase } from "./FeedbackBase";
7
+ export const Feedback = core.serialization
8
+ .object({
9
+ feedbackId: EntityId,
10
+ conversationId: EntityId,
11
+ conversationMessageId: EntityId,
12
+ })
13
+ .extend(FeedbackBase);
@@ -9,6 +9,6 @@ export declare const UserData: core.serialization.ObjectSchema<serializers.UserD
9
9
  export declare namespace UserData {
10
10
  interface Raw {
11
11
  value: string;
12
- visibility?: VisibilityType.Raw | null;
12
+ visibility: VisibilityType.Raw;
13
13
  }
14
14
  }
@@ -5,5 +5,5 @@ import * as core from "../../../../core";
5
5
  import { VisibilityType } from "./VisibilityType";
6
6
  export const UserData = core.serialization.object({
7
7
  value: core.serialization.string(),
8
- visibility: VisibilityType.optional(),
8
+ visibility: VisibilityType,
9
9
  });
@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
2
2
  export * from "./EntityType";
3
3
  export * from "./EntityIdBase";
4
4
  export * from "./EntityId";
5
- export * from "./User";
6
5
  export * from "./FeedbackBase";
7
6
  export * from "./FeedbackType";
8
- export * from "./AppUserIdentification";
7
+ export * from "./Feedback";
9
8
  export * from "./AppUserIdentifier";
10
9
  export * from "./AppUserIdentifyingPropertyType";
11
10
  export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
13
12
  export * from "./VisibilityType";
14
13
  export * from "./AppUserRequest";
15
14
  export * from "./AppUserResponse";
15
+ export * from "./EventTriggerBase";
16
+ export * from "./EventTriggerResponse";
17
+ export * from "./EventTriggerType";
@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
2
2
  export * from "./EntityType";
3
3
  export * from "./EntityIdBase";
4
4
  export * from "./EntityId";
5
- export * from "./User";
6
5
  export * from "./FeedbackBase";
7
6
  export * from "./FeedbackType";
8
- export * from "./AppUserIdentification";
7
+ export * from "./Feedback";
9
8
  export * from "./AppUserIdentifier";
10
9
  export * from "./AppUserIdentifyingPropertyType";
11
10
  export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
13
12
  export * from "./VisibilityType";
14
13
  export * from "./AppUserRequest";
15
14
  export * from "./AppUserResponse";
15
+ export * from "./EventTriggerBase";
16
+ export * from "./EventTriggerResponse";
17
+ export * from "./EventTriggerType";
@@ -5,14 +5,11 @@ import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
7
  import { EntityIdBase } from "../../commons/types/EntityIdBase";
8
- import { ConversationMessageContext } from "./ConversationMessageContext";
9
- import { ResponseConfig } from "./ResponseConfig";
10
8
  export declare const AskRequest: core.serialization.ObjectSchema<serializers.AskRequest.Raw, MavenAGI.AskRequest>;
11
9
  export declare namespace AskRequest {
12
10
  interface Raw {
13
11
  conversationMessageId: EntityIdBase.Raw;
12
+ userId: EntityIdBase.Raw;
14
13
  text: string;
15
- context?: ConversationMessageContext.Raw | null;
16
- responseConfig?: ResponseConfig.Raw | null;
17
14
  }
18
15
  }
@@ -3,11 +3,8 @@
3
3
  */
4
4
  import * as core from "../../../../core";
5
5
  import { EntityIdBase } from "../../commons/types/EntityIdBase";
6
- import { ConversationMessageContext } from "./ConversationMessageContext";
7
- import { ResponseConfig } from "./ResponseConfig";
8
6
  export const AskRequest = core.serialization.object({
9
7
  conversationMessageId: EntityIdBase,
8
+ userId: EntityIdBase,
10
9
  text: core.serialization.string(),
11
- context: ConversationMessageContext.optional(),
12
- responseConfig: ResponseConfig.optional(),
13
10
  });
@@ -9,5 +9,11 @@ export declare const ConversationBase: core.serialization.ObjectSchema<serialize
9
9
  export declare namespace ConversationBase {
10
10
  interface Raw {
11
11
  responseConfig?: ResponseConfig.Raw | null;
12
+ subject?: string | null;
13
+ url?: string | null;
14
+ createdAt?: string | null;
15
+ updatedAt?: string | null;
16
+ tags?: string[] | null;
17
+ metadata?: Record<string, string> | null;
12
18
  }
13
19
  }
@@ -5,4 +5,10 @@ import * as core from "../../../../core";
5
5
  import { ResponseConfig } from "./ResponseConfig";
6
6
  export const ConversationBase = core.serialization.object({
7
7
  responseConfig: ResponseConfig.optional(),
8
+ subject: core.serialization.string().optional(),
9
+ url: core.serialization.string().optional(),
10
+ createdAt: core.serialization.date().optional(),
11
+ updatedAt: core.serialization.date().optional(),
12
+ tags: core.serialization.set(core.serialization.string()).optional(),
13
+ metadata: core.serialization.record(core.serialization.string(), core.serialization.string()).optional(),
8
14
  });
@@ -4,10 +4,10 @@
4
4
  import * as serializers from "../../../index";
5
5
  import * as MavenAGI from "../../../../api/index";
6
6
  import * as core from "../../../../core";
7
- import { ConversationMessageContext } from "./ConversationMessageContext";
8
7
  export declare const ConversationMessageBase: core.serialization.ObjectSchema<serializers.ConversationMessageBase.Raw, MavenAGI.ConversationMessageBase>;
9
8
  export declare namespace ConversationMessageBase {
10
9
  interface Raw {
11
- context?: ConversationMessageContext.Raw | null;
10
+ createdAt?: string | null;
11
+ updatedAt?: string | null;
12
12
  }
13
13
  }