@credal/sdk 0.0.3 → 0.0.5

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 (75) hide show
  1. package/README.md +168 -0
  2. package/api/resources/copilots/client/Client.d.ts +15 -0
  3. package/api/resources/copilots/client/Client.js +62 -2
  4. package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +32 -0
  5. package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +5 -0
  6. package/api/resources/copilots/client/requests/index.d.ts +1 -0
  7. package/api/resources/copilots/types/FeedbackEnum.d.ts +8 -0
  8. package/api/resources/copilots/types/FeedbackEnum.js +10 -0
  9. package/api/resources/copilots/types/MessageFeedback.d.ts +8 -0
  10. package/api/resources/copilots/types/MessageFeedback.js +5 -0
  11. package/api/resources/copilots/types/MessageReply.d.ts +2 -0
  12. package/api/resources/copilots/types/ReferencedSource.d.ts +10 -0
  13. package/api/resources/copilots/types/ReferencedSource.js +5 -0
  14. package/api/resources/copilots/types/index.d.ts +3 -0
  15. package/api/resources/copilots/types/index.js +3 -0
  16. package/api/resources/documentCatalog/client/Client.js +2 -2
  17. package/api/resources/documentCollections/client/Client.js +1 -1
  18. package/api/resources/permissionsService/client/Client.js +3 -3
  19. package/api/resources/search/client/Client.js +1 -1
  20. package/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  21. package/api/resources/users/client/Client.js +1 -1
  22. package/dist/api/resources/copilots/client/Client.d.ts +15 -0
  23. package/dist/api/resources/copilots/client/Client.js +62 -2
  24. package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +32 -0
  25. package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +5 -0
  26. package/dist/api/resources/copilots/client/requests/index.d.ts +1 -0
  27. package/dist/api/resources/copilots/types/FeedbackEnum.d.ts +8 -0
  28. package/dist/api/resources/copilots/types/FeedbackEnum.js +10 -0
  29. package/dist/api/resources/copilots/types/MessageFeedback.d.ts +8 -0
  30. package/dist/api/resources/copilots/types/MessageFeedback.js +5 -0
  31. package/dist/api/resources/copilots/types/MessageReply.d.ts +2 -0
  32. package/dist/api/resources/copilots/types/ReferencedSource.d.ts +10 -0
  33. package/dist/api/resources/copilots/types/ReferencedSource.js +5 -0
  34. package/dist/api/resources/copilots/types/index.d.ts +3 -0
  35. package/dist/api/resources/copilots/types/index.js +3 -0
  36. package/dist/api/resources/documentCatalog/client/Client.js +2 -2
  37. package/dist/api/resources/documentCollections/client/Client.js +1 -1
  38. package/dist/api/resources/permissionsService/client/Client.js +3 -3
  39. package/dist/api/resources/search/client/Client.js +1 -1
  40. package/dist/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  41. package/dist/api/resources/users/client/Client.js +1 -1
  42. package/dist/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +15 -0
  43. package/dist/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +36 -0
  44. package/dist/serialization/resources/copilots/client/requests/index.d.ts +1 -0
  45. package/dist/serialization/resources/copilots/client/requests/index.js +3 -1
  46. package/dist/serialization/resources/copilots/types/FeedbackEnum.d.ts +10 -0
  47. package/dist/serialization/resources/copilots/types/FeedbackEnum.js +31 -0
  48. package/dist/serialization/resources/copilots/types/MessageFeedback.d.ts +14 -0
  49. package/dist/serialization/resources/copilots/types/MessageFeedback.js +35 -0
  50. package/dist/serialization/resources/copilots/types/MessageReply.d.ts +3 -0
  51. package/dist/serialization/resources/copilots/types/MessageReply.js +3 -0
  52. package/dist/serialization/resources/copilots/types/ReferencedSource.d.ts +16 -0
  53. package/dist/serialization/resources/copilots/types/ReferencedSource.js +37 -0
  54. package/dist/serialization/resources/copilots/types/index.d.ts +3 -0
  55. package/dist/serialization/resources/copilots/types/index.js +3 -0
  56. package/dist/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  57. package/dist/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.js +1 -1
  58. package/package.json +1 -1
  59. package/reference.md +70 -0
  60. package/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +15 -0
  61. package/serialization/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js +36 -0
  62. package/serialization/resources/copilots/client/requests/index.d.ts +1 -0
  63. package/serialization/resources/copilots/client/requests/index.js +3 -1
  64. package/serialization/resources/copilots/types/FeedbackEnum.d.ts +10 -0
  65. package/serialization/resources/copilots/types/FeedbackEnum.js +31 -0
  66. package/serialization/resources/copilots/types/MessageFeedback.d.ts +14 -0
  67. package/serialization/resources/copilots/types/MessageFeedback.js +35 -0
  68. package/serialization/resources/copilots/types/MessageReply.d.ts +3 -0
  69. package/serialization/resources/copilots/types/MessageReply.js +3 -0
  70. package/serialization/resources/copilots/types/ReferencedSource.d.ts +16 -0
  71. package/serialization/resources/copilots/types/ReferencedSource.js +37 -0
  72. package/serialization/resources/copilots/types/index.d.ts +3 -0
  73. package/serialization/resources/copilots/types/index.js +3 -0
  74. package/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  75. package/serialization/resources/search/client/requests/SearchDocumentCollectionRequest.js +1 -1
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.FeedbackEnum = void 0;
7
+ exports.FeedbackEnum = {
8
+ Positive: "POSITIVE",
9
+ Negative: "NEGATIVE",
10
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Credal from "../../../index";
5
+ export interface MessageFeedback {
6
+ feedback: Credal.FeedbackEnum;
7
+ suggestedAnswer?: string;
8
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -9,4 +9,6 @@ export interface MessageReply {
9
9
  warnings: string[];
10
10
  activitySourceIdsForAudit: string[];
11
11
  insertedAuditLog: Credal.InsertedAuditLog;
12
+ referencedSources: Credal.ReferencedSource[];
13
+ messageId: string;
12
14
  }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Credal from "../../../index";
5
+ export interface ReferencedSource {
6
+ id: string;
7
+ externalResourceId: Credal.ExternalResourceId;
8
+ name: string;
9
+ url?: string;
10
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -2,7 +2,10 @@ export * from "./CreateConversationResponse";
2
2
  export * from "./SendAgentMessageResponse";
3
3
  export * from "./SendMessageResponse";
4
4
  export * from "./MessageReply";
5
+ export * from "./ReferencedSource";
5
6
  export * from "./ResponseChunk";
6
7
  export * from "./InsertedAuditLog";
7
8
  export * from "./MessageBlocked";
8
9
  export * from "./PolicyTrigger";
10
+ export * from "./FeedbackEnum";
11
+ export * from "./MessageFeedback";
@@ -18,7 +18,10 @@ __exportStar(require("./CreateConversationResponse"), exports);
18
18
  __exportStar(require("./SendAgentMessageResponse"), exports);
19
19
  __exportStar(require("./SendMessageResponse"), exports);
20
20
  __exportStar(require("./MessageReply"), exports);
21
+ __exportStar(require("./ReferencedSource"), exports);
21
22
  __exportStar(require("./ResponseChunk"), exports);
22
23
  __exportStar(require("./InsertedAuditLog"), exports);
23
24
  __exportStar(require("./MessageBlocked"), exports);
24
25
  __exportStar(require("./PolicyTrigger"), exports);
26
+ __exportStar(require("./FeedbackEnum"), exports);
27
+ __exportStar(require("./MessageFeedback"), exports);
@@ -71,7 +71,7 @@ class DocumentCatalog {
71
71
  Authorization: yield this._getAuthorizationHeader(),
72
72
  "X-Fern-Language": "JavaScript",
73
73
  "X-Fern-SDK-Name": "@credal/sdk",
74
- "X-Fern-SDK-Version": "0.0.3",
74
+ "X-Fern-SDK-Version": "0.0.5",
75
75
  "X-Fern-Runtime": core.RUNTIME.type,
76
76
  "X-Fern-Runtime-Version": core.RUNTIME.version,
77
77
  },
@@ -154,7 +154,7 @@ class DocumentCatalog {
154
154
  Authorization: yield this._getAuthorizationHeader(),
155
155
  "X-Fern-Language": "JavaScript",
156
156
  "X-Fern-SDK-Name": "@credal/sdk",
157
- "X-Fern-SDK-Version": "0.0.3",
157
+ "X-Fern-SDK-Version": "0.0.5",
158
158
  "X-Fern-Runtime": core.RUNTIME.type,
159
159
  "X-Fern-Runtime-Version": core.RUNTIME.version,
160
160
  },
@@ -78,7 +78,7 @@ class DocumentCollections {
78
78
  Authorization: yield this._getAuthorizationHeader(),
79
79
  "X-Fern-Language": "JavaScript",
80
80
  "X-Fern-SDK-Name": "@credal/sdk",
81
- "X-Fern-SDK-Version": "0.0.3",
81
+ "X-Fern-SDK-Version": "0.0.5",
82
82
  "X-Fern-Runtime": core.RUNTIME.type,
83
83
  "X-Fern-Runtime-Version": core.RUNTIME.version,
84
84
  },
@@ -74,7 +74,7 @@ class PermissionsService {
74
74
  Authorization: yield this._getAuthorizationHeader(),
75
75
  "X-Fern-Language": "JavaScript",
76
76
  "X-Fern-SDK-Name": "@credal/sdk",
77
- "X-Fern-SDK-Version": "0.0.3",
77
+ "X-Fern-SDK-Version": "0.0.5",
78
78
  "X-Fern-Runtime": core.RUNTIME.type,
79
79
  "X-Fern-Runtime-Version": core.RUNTIME.version,
80
80
  },
@@ -145,7 +145,7 @@ class PermissionsService {
145
145
  Authorization: yield this._getAuthorizationHeader(),
146
146
  "X-Fern-Language": "JavaScript",
147
147
  "X-Fern-SDK-Name": "@credal/sdk",
148
- "X-Fern-SDK-Version": "0.0.3",
148
+ "X-Fern-SDK-Version": "0.0.5",
149
149
  "X-Fern-Runtime": core.RUNTIME.type,
150
150
  "X-Fern-Runtime-Version": core.RUNTIME.version,
151
151
  },
@@ -207,7 +207,7 @@ class PermissionsService {
207
207
  Authorization: yield this._getAuthorizationHeader(),
208
208
  "X-Fern-Language": "JavaScript",
209
209
  "X-Fern-SDK-Name": "@credal/sdk",
210
- "X-Fern-SDK-Version": "0.0.3",
210
+ "X-Fern-SDK-Version": "0.0.5",
211
211
  "X-Fern-Runtime": core.RUNTIME.type,
212
212
  "X-Fern-Runtime-Version": core.RUNTIME.version,
213
213
  },
@@ -84,7 +84,7 @@ class Search {
84
84
  Authorization: yield this._getAuthorizationHeader(),
85
85
  "X-Fern-Language": "JavaScript",
86
86
  "X-Fern-SDK-Name": "@credal/sdk",
87
- "X-Fern-SDK-Version": "0.0.3",
87
+ "X-Fern-SDK-Version": "0.0.5",
88
88
  "X-Fern-Runtime": core.RUNTIME.type,
89
89
  "X-Fern-Runtime-Version": core.RUNTIME.version,
90
90
  },
@@ -35,7 +35,7 @@ export interface SearchDocumentCollectionRequest {
35
35
  * The structured query filters to apply to the search query.
36
36
  *
37
37
  */
38
- structuredQueryFilters: Credal.SingleFieldFilter[];
38
+ structuredQueryFilters?: Credal.SingleFieldFilter[];
39
39
  searchOptions?: Credal.DocumentCollectionSearchOptions;
40
40
  /**
41
41
  * Legacy metadata filter expression to apply to the search query. Use structuredQueryFilters instead.
@@ -79,7 +79,7 @@ class Users {
79
79
  Authorization: yield this._getAuthorizationHeader(),
80
80
  "X-Fern-Language": "JavaScript",
81
81
  "X-Fern-SDK-Name": "@credal/sdk",
82
- "X-Fern-SDK-Version": "0.0.3",
82
+ "X-Fern-SDK-Version": "0.0.5",
83
83
  "X-Fern-Runtime": core.RUNTIME.type,
84
84
  "X-Fern-Runtime-Version": core.RUNTIME.version,
85
85
  },
@@ -0,0 +1,15 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../../index";
5
+ import * as Credal from "../../../../../api/index";
6
+ import * as core from "../../../../../core";
7
+ import { MessageFeedback } from "../../types/MessageFeedback";
8
+ export declare const ProvideMessageFeedbackRequest: core.serialization.Schema<serializers.ProvideMessageFeedbackRequest.Raw, Credal.ProvideMessageFeedbackRequest>;
9
+ export declare namespace ProvideMessageFeedbackRequest {
10
+ interface Raw {
11
+ userEmail: string;
12
+ messageId: string;
13
+ messageFeedback: MessageFeedback.Raw;
14
+ }
15
+ }
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ProvideMessageFeedbackRequest = void 0;
30
+ const core = __importStar(require("../../../../../core"));
31
+ const MessageFeedback_1 = require("../../types/MessageFeedback");
32
+ exports.ProvideMessageFeedbackRequest = core.serialization.object({
33
+ userEmail: core.serialization.string(),
34
+ messageId: core.serialization.string(),
35
+ messageFeedback: MessageFeedback_1.MessageFeedback,
36
+ });
@@ -1,2 +1,3 @@
1
1
  export { CreateConversationRequest } from "./CreateConversationRequest";
2
+ export { ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest";
2
3
  export { SendMessageRequest } from "./SendMessageRequest";
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SendMessageRequest = exports.CreateConversationRequest = void 0;
3
+ exports.SendMessageRequest = exports.ProvideMessageFeedbackRequest = exports.CreateConversationRequest = void 0;
4
4
  var CreateConversationRequest_1 = require("./CreateConversationRequest");
5
5
  Object.defineProperty(exports, "CreateConversationRequest", { enumerable: true, get: function () { return CreateConversationRequest_1.CreateConversationRequest; } });
6
+ var ProvideMessageFeedbackRequest_1 = require("./ProvideMessageFeedbackRequest");
7
+ Object.defineProperty(exports, "ProvideMessageFeedbackRequest", { enumerable: true, get: function () { return ProvideMessageFeedbackRequest_1.ProvideMessageFeedbackRequest; } });
6
8
  var SendMessageRequest_1 = require("./SendMessageRequest");
7
9
  Object.defineProperty(exports, "SendMessageRequest", { enumerable: true, get: function () { return SendMessageRequest_1.SendMessageRequest; } });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as Credal from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ export declare const FeedbackEnum: core.serialization.Schema<serializers.FeedbackEnum.Raw, Credal.FeedbackEnum>;
8
+ export declare namespace FeedbackEnum {
9
+ type Raw = "POSITIVE" | "NEGATIVE";
10
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.FeedbackEnum = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ exports.FeedbackEnum = core.serialization.enum_(["POSITIVE", "NEGATIVE"]);
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as Credal from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ import { FeedbackEnum } from "./FeedbackEnum";
8
+ export declare const MessageFeedback: core.serialization.ObjectSchema<serializers.MessageFeedback.Raw, Credal.MessageFeedback>;
9
+ export declare namespace MessageFeedback {
10
+ interface Raw {
11
+ feedback: FeedbackEnum.Raw;
12
+ suggestedAnswer?: string | null;
13
+ }
14
+ }
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.MessageFeedback = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ const FeedbackEnum_1 = require("./FeedbackEnum");
32
+ exports.MessageFeedback = core.serialization.object({
33
+ feedback: FeedbackEnum_1.FeedbackEnum,
34
+ suggestedAnswer: core.serialization.string().optional(),
35
+ });
@@ -7,6 +7,7 @@ import * as core from "../../../../core";
7
7
  import { PolicyTrigger } from "./PolicyTrigger";
8
8
  import { ResponseChunk } from "./ResponseChunk";
9
9
  import { InsertedAuditLog } from "./InsertedAuditLog";
10
+ import { ReferencedSource } from "./ReferencedSource";
10
11
  export declare const MessageReply: core.serialization.ObjectSchema<serializers.MessageReply.Raw, Credal.MessageReply>;
11
12
  export declare namespace MessageReply {
12
13
  interface Raw {
@@ -16,5 +17,7 @@ export declare namespace MessageReply {
16
17
  warnings: string[];
17
18
  activitySourceIdsForAudit: string[];
18
19
  inserted_audit_log: InsertedAuditLog.Raw;
20
+ referencedSources: ReferencedSource.Raw[];
21
+ messageId: string;
19
22
  }
20
23
  }
@@ -31,6 +31,7 @@ const core = __importStar(require("../../../../core"));
31
31
  const PolicyTrigger_1 = require("./PolicyTrigger");
32
32
  const ResponseChunk_1 = require("./ResponseChunk");
33
33
  const InsertedAuditLog_1 = require("./InsertedAuditLog");
34
+ const ReferencedSource_1 = require("./ReferencedSource");
34
35
  exports.MessageReply = core.serialization.object({
35
36
  policyTriggers: core.serialization.property("policy_triggers", core.serialization.list(PolicyTrigger_1.PolicyTrigger)),
36
37
  conversationId: core.serialization.string(),
@@ -38,4 +39,6 @@ exports.MessageReply = core.serialization.object({
38
39
  warnings: core.serialization.list(core.serialization.string()),
39
40
  activitySourceIdsForAudit: core.serialization.list(core.serialization.string()),
40
41
  insertedAuditLog: core.serialization.property("inserted_audit_log", InsertedAuditLog_1.InsertedAuditLog),
42
+ referencedSources: core.serialization.list(ReferencedSource_1.ReferencedSource),
43
+ messageId: core.serialization.string(),
41
44
  });
@@ -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 Credal from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ import { ExternalResourceId } from "../../common/types/ExternalResourceId";
8
+ export declare const ReferencedSource: core.serialization.ObjectSchema<serializers.ReferencedSource.Raw, Credal.ReferencedSource>;
9
+ export declare namespace ReferencedSource {
10
+ interface Raw {
11
+ id: string;
12
+ externalResourceId: ExternalResourceId.Raw;
13
+ name: string;
14
+ url?: string | null;
15
+ }
16
+ }
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ReferencedSource = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ const ExternalResourceId_1 = require("../../common/types/ExternalResourceId");
32
+ exports.ReferencedSource = core.serialization.object({
33
+ id: core.serialization.string(),
34
+ externalResourceId: ExternalResourceId_1.ExternalResourceId,
35
+ name: core.serialization.string(),
36
+ url: core.serialization.string().optional(),
37
+ });
@@ -2,7 +2,10 @@ export * from "./CreateConversationResponse";
2
2
  export * from "./SendAgentMessageResponse";
3
3
  export * from "./SendMessageResponse";
4
4
  export * from "./MessageReply";
5
+ export * from "./ReferencedSource";
5
6
  export * from "./ResponseChunk";
6
7
  export * from "./InsertedAuditLog";
7
8
  export * from "./MessageBlocked";
8
9
  export * from "./PolicyTrigger";
10
+ export * from "./FeedbackEnum";
11
+ export * from "./MessageFeedback";
@@ -18,7 +18,10 @@ __exportStar(require("./CreateConversationResponse"), exports);
18
18
  __exportStar(require("./SendAgentMessageResponse"), exports);
19
19
  __exportStar(require("./SendMessageResponse"), exports);
20
20
  __exportStar(require("./MessageReply"), exports);
21
+ __exportStar(require("./ReferencedSource"), exports);
21
22
  __exportStar(require("./ResponseChunk"), exports);
22
23
  __exportStar(require("./InsertedAuditLog"), exports);
23
24
  __exportStar(require("./MessageBlocked"), exports);
24
25
  __exportStar(require("./PolicyTrigger"), exports);
26
+ __exportStar(require("./FeedbackEnum"), exports);
27
+ __exportStar(require("./MessageFeedback"), exports);
@@ -12,7 +12,7 @@ export declare namespace SearchDocumentCollectionRequest {
12
12
  documentCollectionId: string;
13
13
  searchQuery: string;
14
14
  userEmail: string;
15
- structuredQueryFilters: SingleFieldFilter.Raw[];
15
+ structuredQueryFilters?: SingleFieldFilter.Raw[] | null;
16
16
  searchOptions?: DocumentCollectionSearchOptions.Raw | null;
17
17
  metadataFilterExpression?: string | null;
18
18
  }
@@ -34,7 +34,7 @@ exports.SearchDocumentCollectionRequest = core.serialization.object({
34
34
  documentCollectionId: core.serialization.string(),
35
35
  searchQuery: core.serialization.string(),
36
36
  userEmail: core.serialization.string(),
37
- structuredQueryFilters: core.serialization.list(SingleFieldFilter_1.SingleFieldFilter),
37
+ structuredQueryFilters: core.serialization.list(SingleFieldFilter_1.SingleFieldFilter).optional(),
38
38
  searchOptions: DocumentCollectionSearchOptions_1.DocumentCollectionSearchOptions.optional(),
39
39
  metadataFilterExpression: core.serialization.string().optional(),
40
40
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@credal/sdk",
3
- "version": "0.0.3",
3
+ "version": "0.0.5",
4
4
  "private": false,
5
5
  "repository": "https://github.com/credal-ai/credal-typescript-sdk",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -85,6 +85,76 @@ await credal.copilots.createConversation({
85
85
  </dl>
86
86
  </details>
87
87
 
88
+ <details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">provideMessageFeedback</a>({ ...params }) -> void</code> </summary>
89
+
90
+ <dl>
91
+
92
+ <dd>
93
+
94
+ #### 🔌 Usage
95
+
96
+ <dl>
97
+
98
+ <dd>
99
+
100
+ <dl>
101
+
102
+ <dd>
103
+
104
+ ```ts
105
+ await credal.copilots.provideMessageFeedback({
106
+ userEmail: "ravin@credal.ai",
107
+ messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
108
+ messageFeedback: {
109
+ feedback: Credal.FeedbackEnum.Negative,
110
+ suggestedAnswer: "Yes, Credal is SOC 2 compliant.",
111
+ },
112
+ });
113
+ ```
114
+
115
+ </dd>
116
+
117
+ </dl>
118
+
119
+ </dd>
120
+
121
+ </dl>
122
+
123
+ #### ⚙️ Parameters
124
+
125
+ <dl>
126
+
127
+ <dd>
128
+
129
+ <dl>
130
+
131
+ <dd>
132
+
133
+ **request: `Credal.ProvideMessageFeedbackRequest`**
134
+
135
+ </dd>
136
+
137
+ </dl>
138
+
139
+ <dl>
140
+
141
+ <dd>
142
+
143
+ **requestOptions: `Copilots.RequestOptions`**
144
+
145
+ </dd>
146
+
147
+ </dl>
148
+
149
+ </dd>
150
+
151
+ </dl>
152
+
153
+ </dd>
154
+
155
+ </dl>
156
+ </details>
157
+
88
158
  <details><summary> <code>credal.copilots.<a href="./src/api/resources/copilots/client/Client.ts">sendMessage</a>({ ...params }) -> Credal.SendAgentMessageResponse</code> </summary>
89
159
 
90
160
  <dl>
@@ -0,0 +1,15 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../../index";
5
+ import * as Credal from "../../../../../api/index";
6
+ import * as core from "../../../../../core";
7
+ import { MessageFeedback } from "../../types/MessageFeedback";
8
+ export declare const ProvideMessageFeedbackRequest: core.serialization.Schema<serializers.ProvideMessageFeedbackRequest.Raw, Credal.ProvideMessageFeedbackRequest>;
9
+ export declare namespace ProvideMessageFeedbackRequest {
10
+ interface Raw {
11
+ userEmail: string;
12
+ messageId: string;
13
+ messageFeedback: MessageFeedback.Raw;
14
+ }
15
+ }
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ProvideMessageFeedbackRequest = void 0;
30
+ const core = __importStar(require("../../../../../core"));
31
+ const MessageFeedback_1 = require("../../types/MessageFeedback");
32
+ exports.ProvideMessageFeedbackRequest = core.serialization.object({
33
+ userEmail: core.serialization.string(),
34
+ messageId: core.serialization.string(),
35
+ messageFeedback: MessageFeedback_1.MessageFeedback,
36
+ });
@@ -1,2 +1,3 @@
1
1
  export { CreateConversationRequest } from "./CreateConversationRequest";
2
+ export { ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest";
2
3
  export { SendMessageRequest } from "./SendMessageRequest";
@@ -1,7 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SendMessageRequest = exports.CreateConversationRequest = void 0;
3
+ exports.SendMessageRequest = exports.ProvideMessageFeedbackRequest = exports.CreateConversationRequest = void 0;
4
4
  var CreateConversationRequest_1 = require("./CreateConversationRequest");
5
5
  Object.defineProperty(exports, "CreateConversationRequest", { enumerable: true, get: function () { return CreateConversationRequest_1.CreateConversationRequest; } });
6
+ var ProvideMessageFeedbackRequest_1 = require("./ProvideMessageFeedbackRequest");
7
+ Object.defineProperty(exports, "ProvideMessageFeedbackRequest", { enumerable: true, get: function () { return ProvideMessageFeedbackRequest_1.ProvideMessageFeedbackRequest; } });
6
8
  var SendMessageRequest_1 = require("./SendMessageRequest");
7
9
  Object.defineProperty(exports, "SendMessageRequest", { enumerable: true, get: function () { return SendMessageRequest_1.SendMessageRequest; } });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as Credal from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ export declare const FeedbackEnum: core.serialization.Schema<serializers.FeedbackEnum.Raw, Credal.FeedbackEnum>;
8
+ export declare namespace FeedbackEnum {
9
+ type Raw = "POSITIVE" | "NEGATIVE";
10
+ }