mavenagi 1.0.1 → 1.0.3

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 (37) hide show
  1. package/README.md +13 -15
  2. package/api/resources/actions/client/Client.js +6 -6
  3. package/api/resources/appSettings/client/Client.js +2 -2
  4. package/api/resources/commons/types/Feedback.d.ts +11 -0
  5. package/api/resources/conversation/client/Client.d.ts +30 -35
  6. package/api/resources/conversation/client/Client.js +50 -55
  7. package/api/resources/conversation/client/requests/ConversationGetRequest.d.ts +1 -3
  8. package/api/resources/conversation/types/FeedbackRequest.d.ts +5 -0
  9. package/api/resources/knowledge/client/Client.js +14 -14
  10. package/api/resources/translations/client/Client.js +2 -2
  11. package/api/resources/triggers/client/Client.js +6 -6
  12. package/api/resources/users/client/Client.js +4 -4
  13. package/dist/api/resources/actions/client/Client.js +6 -6
  14. package/dist/api/resources/appSettings/client/Client.js +2 -2
  15. package/dist/api/resources/commons/types/Feedback.d.ts +11 -0
  16. package/dist/api/resources/conversation/client/Client.d.ts +30 -35
  17. package/dist/api/resources/conversation/client/Client.js +50 -55
  18. package/dist/api/resources/conversation/client/requests/ConversationGetRequest.d.ts +1 -3
  19. package/dist/api/resources/conversation/types/FeedbackRequest.d.ts +5 -0
  20. package/dist/api/resources/knowledge/client/Client.js +14 -14
  21. package/dist/api/resources/translations/client/Client.js +2 -2
  22. package/dist/api/resources/triggers/client/Client.js +6 -6
  23. package/dist/api/resources/users/client/Client.js +4 -4
  24. package/dist/serialization/resources/commons/types/Feedback.d.ts +2 -0
  25. package/dist/serialization/resources/commons/types/Feedback.js +2 -0
  26. package/dist/serialization/resources/conversation/types/FeedbackRequest.d.ts +1 -0
  27. package/dist/serialization/resources/conversation/types/FeedbackRequest.js +1 -0
  28. package/dist/version.d.ts +1 -1
  29. package/dist/version.js +1 -1
  30. package/package.json +1 -1
  31. package/reference.md +33 -33
  32. package/serialization/resources/commons/types/Feedback.d.ts +2 -0
  33. package/serialization/resources/commons/types/Feedback.js +2 -0
  34. package/serialization/resources/conversation/types/FeedbackRequest.d.ts +1 -0
  35. package/serialization/resources/conversation/types/FeedbackRequest.js +1 -0
  36. package/version.d.ts +1 -1
  37. package/version.js +1 -1
package/reference.md CHANGED
@@ -302,22 +302,20 @@ Initialize a new conversation. Only required if the ask request wishes to supply
302
302
  ```typescript
303
303
  await client.conversation.initialize({
304
304
  conversationId: {
305
- referenceId: "string",
306
- },
307
- messages: [{}],
308
- responseConfig: {
309
- capabilities: ["MARKDOWN"],
310
- isCopilot: true,
311
- responseLength: "SHORT",
312
- },
313
- subject: "string",
314
- url: "string",
315
- createdAt: new Date("2024-01-15T09:30:00.000Z"),
316
- updatedAt: new Date("2024-01-15T09:30:00.000Z"),
317
- tags: new Set(["string"]),
318
- metadata: {
319
- string: "string",
305
+ referenceId: "referenceId",
320
306
  },
307
+ messages: [
308
+ {
309
+ conversationMessageId: {
310
+ referenceId: "referenceId",
311
+ },
312
+ },
313
+ {
314
+ conversationMessageId: {
315
+ referenceId: "referenceId",
316
+ },
317
+ },
318
+ ],
321
319
  });
322
320
  ```
323
321
 
@@ -381,9 +379,7 @@ Get a conversation
381
379
  <dd>
382
380
 
383
381
  ```typescript
384
- await client.conversation.get("string", {
385
- appId: "string",
386
- });
382
+ await client.conversation.get("conversationId");
387
383
  ```
388
384
 
389
385
  </dd>
@@ -454,18 +450,16 @@ Append messages to an existing conversation. The conversation must be initialize
454
450
  <dd>
455
451
 
456
452
  ```typescript
457
- await client.conversation.appendNewMessages("string", [
453
+ await client.conversation.appendNewMessages("conversationId", [
458
454
  {
459
455
  conversationMessageId: {
460
- referenceId: "string",
456
+ referenceId: "referenceId",
461
457
  },
462
- userId: {
463
- referenceId: "string",
458
+ },
459
+ {
460
+ conversationMessageId: {
461
+ referenceId: "referenceId",
464
462
  },
465
- text: "string",
466
- userMessageType: "USER",
467
- createdAt: new Date("2024-01-15T09:30:00.000Z"),
468
- updatedAt: new Date("2024-01-15T09:30:00.000Z"),
469
463
  },
470
464
  ]);
471
465
  ```
@@ -708,10 +702,13 @@ Generate a response suggestion for each requested message id in a conversation
708
702
  <dd>
709
703
 
710
704
  ```typescript
711
- await client.conversation.generateMavenSuggestions("string", {
705
+ await client.conversation.generateMavenSuggestions("conversationId", {
712
706
  conversationMessageIds: [
713
707
  {
714
- referenceId: "string",
708
+ referenceId: "referenceId",
709
+ },
710
+ {
711
+ referenceId: "referenceId",
715
712
  },
716
713
  ],
717
714
  });
@@ -785,7 +782,7 @@ Uses an LLM flow to categorize the conversation. Experimental.
785
782
  <dd>
786
783
 
787
784
  ```typescript
788
- await client.conversation.categorize("string");
785
+ await client.conversation.categorize("conversationId");
789
786
  ```
790
787
 
791
788
  </dd>
@@ -852,6 +849,9 @@ await client.conversation.createFeedback({
852
849
  feedbackId: {
853
850
  referenceId: "feedback-0",
854
851
  },
852
+ userId: {
853
+ referenceId: "user-0",
854
+ },
855
855
  conversationId: {
856
856
  referenceId: "conversation-0",
857
857
  },
@@ -923,10 +923,10 @@ Submit a filled out action form
923
923
  <dd>
924
924
 
925
925
  ```typescript
926
- await client.conversation.submitActionForm("string", {
927
- actionFormId: "string",
926
+ await client.conversation.submitActionForm("conversationId", {
927
+ actionFormId: "actionFormId",
928
928
  parameters: {
929
- string: {
929
+ parameters: {
930
930
  key: "value",
931
931
  },
932
932
  },
@@ -1001,7 +1001,7 @@ Add metadata to an existing conversation. If a metadata field already exists, it
1001
1001
  <dd>
1002
1002
 
1003
1003
  ```typescript
1004
- await client.conversation.addConversationMetadata("string", {
1004
+ await client.conversation.addConversationMetadata("conversationId", {
1005
1005
  string: "string",
1006
1006
  });
1007
1007
  ```
@@ -12,5 +12,7 @@ export declare namespace Feedback {
12
12
  feedbackId: EntityId.Raw;
13
13
  conversationId: EntityId.Raw;
14
14
  conversationMessageId: EntityId.Raw;
15
+ userId?: EntityId.Raw | null;
16
+ createdAt?: string | null;
15
17
  }
16
18
  }
@@ -9,5 +9,7 @@ export const Feedback = core.serialization
9
9
  feedbackId: EntityId,
10
10
  conversationId: EntityId,
11
11
  conversationMessageId: EntityId,
12
+ userId: EntityId.optional(),
13
+ createdAt: core.serialization.date().optional(),
12
14
  })
13
15
  .extend(FeedbackBase);
@@ -12,5 +12,6 @@ export declare namespace FeedbackRequest {
12
12
  feedbackId: EntityIdBase.Raw;
13
13
  conversationId: EntityIdBase.Raw;
14
14
  conversationMessageId: EntityIdBase.Raw;
15
+ userId?: EntityIdBase.Raw | null;
15
16
  }
16
17
  }
@@ -9,5 +9,6 @@ export const FeedbackRequest = core.serialization
9
9
  feedbackId: EntityIdBase,
10
10
  conversationId: EntityIdBase,
11
11
  conversationMessageId: EntityIdBase,
12
+ userId: EntityIdBase.optional(),
12
13
  })
13
14
  .extend(FeedbackBase);
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.0.1";
1
+ export declare const SDK_VERSION = "1.0.3";
package/version.js CHANGED
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.0.1";
1
+ export const SDK_VERSION = "1.0.3";