@credal/sdk 0.0.14 → 0.0.16

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 (166) hide show
  1. package/Client.d.ts +3 -0
  2. package/api/resources/copilots/client/Client.d.ts +13 -10
  3. package/api/resources/copilots/client/Client.js +52 -40
  4. package/api/resources/copilots/client/requests/CreateCopilotRequest.d.ts +1 -1
  5. package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +1 -1
  6. package/api/resources/copilots/types/DataFilter.d.ts +1 -1
  7. package/api/resources/copilots/types/FinalChunk.d.ts +1 -1
  8. package/api/resources/copilots/types/StreamingChunk.d.ts +15 -1
  9. package/api/resources/documentCatalog/client/Client.d.ts +7 -4
  10. package/api/resources/documentCatalog/client/Client.js +13 -13
  11. package/api/resources/documentCollections/client/Client.d.ts +14 -11
  12. package/api/resources/documentCollections/client/Client.js +39 -29
  13. package/api/resources/documentCollections/client/requests/AddDocumentsToCollectionRequest.d.ts +2 -2
  14. package/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts +1 -1
  15. package/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.d.ts +2 -2
  16. package/api/resources/permissionsService/client/Client.d.ts +8 -5
  17. package/api/resources/permissionsService/client/Client.js +20 -14
  18. package/api/resources/permissionsService/client/requests/CheckBulkResourcesAuthorizationForUserRequest.d.ts +1 -1
  19. package/api/resources/permissionsService/client/requests/CheckResourceAuthorizationForUserRequest.d.ts +1 -1
  20. package/api/resources/search/client/Client.d.ts +5 -2
  21. package/api/resources/search/client/Client.js +7 -7
  22. package/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  23. package/api/resources/users/client/Client.d.ts +4 -1
  24. package/api/resources/users/client/Client.js +5 -3
  25. package/core/fetcher/Fetcher.d.ts +4 -1
  26. package/core/fetcher/Fetcher.js +19 -176
  27. package/core/fetcher/createRequestUrl.d.ts +1 -0
  28. package/core/fetcher/createRequestUrl.js +13 -0
  29. package/core/fetcher/getFetchFn.d.ts +4 -0
  30. package/core/fetcher/getFetchFn.js +59 -0
  31. package/core/fetcher/getRequestBody.d.ts +7 -0
  32. package/core/fetcher/getRequestBody.js +23 -0
  33. package/core/fetcher/getResponseBody.d.ts +1 -0
  34. package/core/fetcher/getResponseBody.js +55 -0
  35. package/core/fetcher/makeRequest.d.ts +1 -0
  36. package/core/fetcher/makeRequest.js +42 -0
  37. package/core/fetcher/requestWithRetries.d.ts +1 -0
  38. package/core/fetcher/requestWithRetries.js +41 -0
  39. package/core/fetcher/signals.d.ts +12 -0
  40. package/core/fetcher/signals.js +37 -0
  41. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  42. package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  43. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +22 -0
  44. package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +124 -0
  45. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  46. package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  47. package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  48. package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +50 -0
  49. package/core/runtime/runtime.d.ts +2 -1
  50. package/core/runtime/runtime.js +12 -1
  51. package/core/schemas/Schema.d.ts +8 -4
  52. package/core/schemas/Schema.js +1 -0
  53. package/core/schemas/builders/bigint/bigint.d.ts +2 -0
  54. package/core/schemas/builders/bigint/bigint.js +50 -0
  55. package/core/schemas/builders/bigint/index.d.ts +1 -0
  56. package/core/schemas/builders/bigint/index.js +5 -0
  57. package/core/schemas/builders/index.d.ts +1 -0
  58. package/core/schemas/builders/index.js +1 -0
  59. package/core/schemas/builders/lazy/lazy.d.ts +2 -2
  60. package/core/schemas/builders/lazy/lazy.js +8 -19
  61. package/core/schemas/builders/lazy/lazyObject.js +1 -10
  62. package/core/schemas/builders/list/list.js +31 -44
  63. package/core/schemas/builders/object/object.js +90 -111
  64. package/core/schemas/builders/object/types.d.ts +2 -2
  65. package/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  66. package/core/schemas/builders/record/record.js +49 -60
  67. package/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  68. package/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  69. package/core/schemas/builders/set/set.js +6 -15
  70. package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  71. package/core/schemas/builders/union/union.js +51 -62
  72. package/core/schemas/utils/getErrorMessageForIncorrectType.js +4 -0
  73. package/core/schemas/utils/maybeSkipValidation.js +3 -12
  74. package/core/streaming-fetcher/Stream.js +6 -6
  75. package/dist/Client.d.ts +3 -0
  76. package/dist/api/resources/copilots/client/Client.d.ts +13 -10
  77. package/dist/api/resources/copilots/client/Client.js +52 -40
  78. package/dist/api/resources/copilots/client/requests/CreateCopilotRequest.d.ts +1 -1
  79. package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts +1 -1
  80. package/dist/api/resources/copilots/types/DataFilter.d.ts +1 -1
  81. package/dist/api/resources/copilots/types/FinalChunk.d.ts +1 -1
  82. package/dist/api/resources/copilots/types/StreamingChunk.d.ts +15 -1
  83. package/dist/api/resources/documentCatalog/client/Client.d.ts +7 -4
  84. package/dist/api/resources/documentCatalog/client/Client.js +13 -13
  85. package/dist/api/resources/documentCollections/client/Client.d.ts +14 -11
  86. package/dist/api/resources/documentCollections/client/Client.js +39 -29
  87. package/dist/api/resources/documentCollections/client/requests/AddDocumentsToCollectionRequest.d.ts +2 -2
  88. package/dist/api/resources/documentCollections/client/requests/CreateCollectionRequest.d.ts +1 -1
  89. package/dist/api/resources/documentCollections/client/requests/RemoveDocumentsFromCollectionRequest.d.ts +2 -2
  90. package/dist/api/resources/permissionsService/client/Client.d.ts +8 -5
  91. package/dist/api/resources/permissionsService/client/Client.js +20 -14
  92. package/dist/api/resources/permissionsService/client/requests/CheckBulkResourcesAuthorizationForUserRequest.d.ts +1 -1
  93. package/dist/api/resources/permissionsService/client/requests/CheckResourceAuthorizationForUserRequest.d.ts +1 -1
  94. package/dist/api/resources/search/client/Client.d.ts +5 -2
  95. package/dist/api/resources/search/client/Client.js +7 -7
  96. package/dist/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts +1 -1
  97. package/dist/api/resources/users/client/Client.d.ts +4 -1
  98. package/dist/api/resources/users/client/Client.js +5 -3
  99. package/dist/core/fetcher/Fetcher.d.ts +4 -1
  100. package/dist/core/fetcher/Fetcher.js +19 -176
  101. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  102. package/dist/core/fetcher/createRequestUrl.js +13 -0
  103. package/dist/core/fetcher/getFetchFn.d.ts +4 -0
  104. package/dist/core/fetcher/getFetchFn.js +59 -0
  105. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  106. package/dist/core/fetcher/getRequestBody.js +23 -0
  107. package/dist/core/fetcher/getResponseBody.d.ts +1 -0
  108. package/dist/core/fetcher/getResponseBody.js +55 -0
  109. package/dist/core/fetcher/makeRequest.d.ts +1 -0
  110. package/dist/core/fetcher/makeRequest.js +42 -0
  111. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  112. package/dist/core/fetcher/requestWithRetries.js +41 -0
  113. package/dist/core/fetcher/signals.d.ts +12 -0
  114. package/dist/core/fetcher/signals.js +37 -0
  115. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +30 -0
  116. package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +247 -0
  117. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +22 -0
  118. package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +124 -0
  119. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +31 -0
  120. package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +229 -0
  121. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +18 -0
  122. package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +50 -0
  123. package/dist/core/runtime/runtime.d.ts +2 -1
  124. package/dist/core/runtime/runtime.js +12 -1
  125. package/dist/core/schemas/Schema.d.ts +8 -4
  126. package/dist/core/schemas/Schema.js +1 -0
  127. package/dist/core/schemas/builders/bigint/bigint.d.ts +2 -0
  128. package/dist/core/schemas/builders/bigint/bigint.js +50 -0
  129. package/dist/core/schemas/builders/bigint/index.d.ts +1 -0
  130. package/dist/core/schemas/builders/bigint/index.js +5 -0
  131. package/dist/core/schemas/builders/index.d.ts +1 -0
  132. package/dist/core/schemas/builders/index.js +1 -0
  133. package/dist/core/schemas/builders/lazy/lazy.d.ts +2 -2
  134. package/dist/core/schemas/builders/lazy/lazy.js +8 -19
  135. package/dist/core/schemas/builders/lazy/lazyObject.js +1 -10
  136. package/dist/core/schemas/builders/list/list.js +31 -44
  137. package/dist/core/schemas/builders/object/object.js +90 -111
  138. package/dist/core/schemas/builders/object/types.d.ts +2 -2
  139. package/dist/core/schemas/builders/object-like/getObjectLikeUtils.js +3 -12
  140. package/dist/core/schemas/builders/record/record.js +49 -60
  141. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.d.ts +2 -2
  142. package/dist/core/schemas/builders/schema-utils/getSchemaUtils.js +18 -21
  143. package/dist/core/schemas/builders/set/set.js +6 -15
  144. package/dist/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js +21 -32
  145. package/dist/core/schemas/builders/union/union.js +51 -62
  146. package/dist/core/schemas/utils/getErrorMessageForIncorrectType.js +4 -0
  147. package/dist/core/schemas/utils/maybeSkipValidation.js +3 -12
  148. package/dist/core/streaming-fetcher/Stream.js +6 -6
  149. package/dist/serialization/resources/copilots/types/DataFilter.d.ts +1 -1
  150. package/dist/serialization/resources/copilots/types/DataFilter.js +1 -1
  151. package/dist/serialization/resources/copilots/types/FinalChunk.d.ts +1 -1
  152. package/dist/serialization/resources/copilots/types/FinalChunk.js +1 -1
  153. package/dist/serialization/resources/copilots/types/StreamingChunk.d.ts +13 -1
  154. package/dist/serialization/resources/copilots/types/StreamingChunk.js +11 -1
  155. package/dist/version.d.ts +1 -0
  156. package/dist/version.js +4 -0
  157. package/package.json +12 -2
  158. package/reference.md +155 -534
  159. package/serialization/resources/copilots/types/DataFilter.d.ts +1 -1
  160. package/serialization/resources/copilots/types/DataFilter.js +1 -1
  161. package/serialization/resources/copilots/types/FinalChunk.d.ts +1 -1
  162. package/serialization/resources/copilots/types/FinalChunk.js +1 -1
  163. package/serialization/resources/copilots/types/StreamingChunk.d.ts +13 -1
  164. package/serialization/resources/copilots/types/StreamingChunk.js +11 -1
  165. package/version.d.ts +1 -0
  166. package/version.js +4 -0
@@ -55,12 +55,12 @@ class Copilots {
55
55
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
56
56
  *
57
57
  * @example
58
- * await credal.copilots.createCopilot({
58
+ * await client.copilots.createCopilot({
59
59
  * name: "Customer Copilot",
60
60
  * description: "This copilot is used to answer customer requests based on internal documentation.",
61
61
  * collaborators: [{
62
62
  * email: "test@gmail.com",
63
- * role: Credal.Role.Editor
63
+ * role: "editor"
64
64
  * }]
65
65
  * })
66
66
  */
@@ -74,18 +74,20 @@ class Copilots {
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.14",
77
+ "X-Fern-SDK-Version": "0.0.16",
78
+ "User-Agent": "@credal/sdk/0.0.16",
78
79
  "X-Fern-Runtime": core.RUNTIME.type,
79
80
  "X-Fern-Runtime-Version": core.RUNTIME.version,
80
81
  },
81
82
  contentType: "application/json",
82
- body: yield serializers.CreateCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
83
+ requestType: "json",
84
+ body: serializers.CreateCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
83
85
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
84
86
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
85
87
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
86
88
  });
87
89
  if (_response.ok) {
88
- return yield serializers.CreateCopilotResponse.parseOrThrow(_response.body, {
90
+ return serializers.CreateCopilotResponse.parseOrThrow(_response.body, {
89
91
  unrecognizedObjectKeys: "passthrough",
90
92
  allowUnrecognizedUnionMembers: true,
91
93
  allowUnrecognizedEnumValues: true,
@@ -120,7 +122,7 @@ class Copilots {
120
122
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
121
123
  *
122
124
  * @example
123
- * await credal.copilots.createConversation({
125
+ * await client.copilots.createConversation({
124
126
  * agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
125
127
  * userEmail: "ravin@credal.ai"
126
128
  * })
@@ -135,18 +137,20 @@ class Copilots {
135
137
  Authorization: yield this._getAuthorizationHeader(),
136
138
  "X-Fern-Language": "JavaScript",
137
139
  "X-Fern-SDK-Name": "@credal/sdk",
138
- "X-Fern-SDK-Version": "0.0.14",
140
+ "X-Fern-SDK-Version": "0.0.16",
141
+ "User-Agent": "@credal/sdk/0.0.16",
139
142
  "X-Fern-Runtime": core.RUNTIME.type,
140
143
  "X-Fern-Runtime-Version": core.RUNTIME.version,
141
144
  },
142
145
  contentType: "application/json",
143
- body: yield serializers.CreateConversationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
146
+ requestType: "json",
147
+ body: serializers.CreateConversationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
144
148
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
145
149
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
146
150
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
147
151
  });
148
152
  if (_response.ok) {
149
- return yield serializers.CreateConversationResponse.parseOrThrow(_response.body, {
153
+ return serializers.CreateConversationResponse.parseOrThrow(_response.body, {
150
154
  unrecognizedObjectKeys: "passthrough",
151
155
  allowUnrecognizedUnionMembers: true,
152
156
  allowUnrecognizedEnumValues: true,
@@ -179,12 +183,12 @@ class Copilots {
179
183
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
180
184
  *
181
185
  * @example
182
- * await credal.copilots.provideMessageFeedback({
186
+ * await client.copilots.provideMessageFeedback({
183
187
  * userEmail: "ravin@credal.ai",
184
188
  * messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
185
189
  * agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
186
190
  * messageFeedback: {
187
- * feedback: Credal.FeedbackEnum.Negative,
191
+ * feedback: "NEGATIVE",
188
192
  * suggestedAnswer: "Yes, Credal is SOC 2 compliant."
189
193
  * }
190
194
  * })
@@ -199,14 +203,14 @@ class Copilots {
199
203
  Authorization: yield this._getAuthorizationHeader(),
200
204
  "X-Fern-Language": "JavaScript",
201
205
  "X-Fern-SDK-Name": "@credal/sdk",
202
- "X-Fern-SDK-Version": "0.0.14",
206
+ "X-Fern-SDK-Version": "0.0.16",
207
+ "User-Agent": "@credal/sdk/0.0.16",
203
208
  "X-Fern-Runtime": core.RUNTIME.type,
204
209
  "X-Fern-Runtime-Version": core.RUNTIME.version,
205
210
  },
206
211
  contentType: "application/json",
207
- body: yield serializers.ProvideMessageFeedbackRequest.jsonOrThrow(request, {
208
- unrecognizedObjectKeys: "strip",
209
- }),
212
+ requestType: "json",
213
+ body: serializers.ProvideMessageFeedbackRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
210
214
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
211
215
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
212
216
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -240,7 +244,7 @@ class Copilots {
240
244
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
241
245
  *
242
246
  * @example
243
- * await credal.copilots.sendMessage({
247
+ * await client.copilots.sendMessage({
244
248
  * agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
245
249
  * message: "Is Credal SOC 2 compliant?",
246
250
  * userEmail: "ravin@credal.ai",
@@ -263,18 +267,20 @@ class Copilots {
263
267
  Authorization: yield this._getAuthorizationHeader(),
264
268
  "X-Fern-Language": "JavaScript",
265
269
  "X-Fern-SDK-Name": "@credal/sdk",
266
- "X-Fern-SDK-Version": "0.0.14",
270
+ "X-Fern-SDK-Version": "0.0.16",
271
+ "User-Agent": "@credal/sdk/0.0.16",
267
272
  "X-Fern-Runtime": core.RUNTIME.type,
268
273
  "X-Fern-Runtime-Version": core.RUNTIME.version,
269
274
  },
270
275
  contentType: "application/json",
271
- body: yield serializers.SendMessageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
276
+ requestType: "json",
277
+ body: serializers.SendMessageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
272
278
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
273
279
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
274
280
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
275
281
  });
276
282
  if (_response.ok) {
277
- return yield serializers.SendAgentMessageResponse.parseOrThrow(_response.body, {
283
+ return serializers.SendAgentMessageResponse.parseOrThrow(_response.body, {
278
284
  unrecognizedObjectKeys: "passthrough",
279
285
  allowUnrecognizedUnionMembers: true,
280
286
  allowUnrecognizedEnumValues: true,
@@ -315,13 +321,15 @@ class Copilots {
315
321
  Authorization: yield this._getAuthorizationHeader(),
316
322
  "X-Fern-Language": "JavaScript",
317
323
  "X-Fern-SDK-Name": "@credal/sdk",
318
- "X-Fern-SDK-Version": "0.0.14",
324
+ "X-Fern-SDK-Version": "0.0.16",
325
+ "User-Agent": "@credal/sdk/0.0.16",
319
326
  "X-Fern-Runtime": core.RUNTIME.type,
320
327
  "X-Fern-Runtime-Version": core.RUNTIME.version,
321
328
  },
322
329
  contentType: "application/json",
323
- body: yield serializers.StreamMessageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
324
- responseType: "streaming",
330
+ requestType: "json",
331
+ body: serializers.StreamMessageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
332
+ responseType: "sse",
325
333
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
326
334
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
327
335
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -330,7 +338,7 @@ class Copilots {
330
338
  return new core.Stream({
331
339
  stream: _response.body,
332
340
  parse: (data) => __awaiter(this, void 0, void 0, function* () {
333
- return yield serializers.StreamingChunk.parseOrThrow(data, {
341
+ return serializers.StreamingChunk.parseOrThrow(data, {
334
342
  unrecognizedObjectKeys: "passthrough",
335
343
  allowUnrecognizedUnionMembers: true,
336
344
  allowUnrecognizedEnumValues: true,
@@ -372,7 +380,7 @@ class Copilots {
372
380
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
373
381
  *
374
382
  * @example
375
- * await credal.copilots.addCollectionToCopilot({
383
+ * await client.copilots.addCollectionToCopilot({
376
384
  * copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
377
385
  * collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
378
386
  * })
@@ -387,14 +395,14 @@ class Copilots {
387
395
  Authorization: yield this._getAuthorizationHeader(),
388
396
  "X-Fern-Language": "JavaScript",
389
397
  "X-Fern-SDK-Name": "@credal/sdk",
390
- "X-Fern-SDK-Version": "0.0.14",
398
+ "X-Fern-SDK-Version": "0.0.16",
399
+ "User-Agent": "@credal/sdk/0.0.16",
391
400
  "X-Fern-Runtime": core.RUNTIME.type,
392
401
  "X-Fern-Runtime-Version": core.RUNTIME.version,
393
402
  },
394
403
  contentType: "application/json",
395
- body: yield serializers.AddCollectionToCopilotRequest.jsonOrThrow(request, {
396
- unrecognizedObjectKeys: "strip",
397
- }),
404
+ requestType: "json",
405
+ body: serializers.AddCollectionToCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
398
406
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
399
407
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
400
408
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -430,7 +438,7 @@ class Copilots {
430
438
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
431
439
  *
432
440
  * @example
433
- * await credal.copilots.removeCollectionFromCopilot({
441
+ * await client.copilots.removeCollectionFromCopilot({
434
442
  * copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
435
443
  * collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
436
444
  * })
@@ -445,12 +453,14 @@ class Copilots {
445
453
  Authorization: yield this._getAuthorizationHeader(),
446
454
  "X-Fern-Language": "JavaScript",
447
455
  "X-Fern-SDK-Name": "@credal/sdk",
448
- "X-Fern-SDK-Version": "0.0.14",
456
+ "X-Fern-SDK-Version": "0.0.16",
457
+ "User-Agent": "@credal/sdk/0.0.16",
449
458
  "X-Fern-Runtime": core.RUNTIME.type,
450
459
  "X-Fern-Runtime-Version": core.RUNTIME.version,
451
460
  },
452
461
  contentType: "application/json",
453
- body: yield serializers.RemoveCollectionFromCopilotRequest.jsonOrThrow(request, {
462
+ requestType: "json",
463
+ body: serializers.RemoveCollectionFromCopilotRequest.jsonOrThrow(request, {
454
464
  unrecognizedObjectKeys: "strip",
455
465
  }),
456
466
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -488,7 +498,7 @@ class Copilots {
488
498
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
489
499
  *
490
500
  * @example
491
- * await credal.copilots.updateConfiguration({
501
+ * await client.copilots.updateConfiguration({
492
502
  * copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
493
503
  * configuration: {
494
504
  * name: "Customer Copilot",
@@ -511,14 +521,14 @@ class Copilots {
511
521
  Authorization: yield this._getAuthorizationHeader(),
512
522
  "X-Fern-Language": "JavaScript",
513
523
  "X-Fern-SDK-Name": "@credal/sdk",
514
- "X-Fern-SDK-Version": "0.0.14",
524
+ "X-Fern-SDK-Version": "0.0.16",
525
+ "User-Agent": "@credal/sdk/0.0.16",
515
526
  "X-Fern-Runtime": core.RUNTIME.type,
516
527
  "X-Fern-Runtime-Version": core.RUNTIME.version,
517
528
  },
518
529
  contentType: "application/json",
519
- body: yield serializers.UpdateConfigurationRequest.jsonOrThrow(request, {
520
- unrecognizedObjectKeys: "strip",
521
- }),
530
+ requestType: "json",
531
+ body: serializers.UpdateConfigurationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
522
532
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
523
533
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
524
534
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -552,7 +562,7 @@ class Copilots {
552
562
  * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
553
563
  *
554
564
  * @example
555
- * await credal.copilots.deleteCopilot({
565
+ * await client.copilots.deleteCopilot({
556
566
  * id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
557
567
  * })
558
568
  */
@@ -566,18 +576,20 @@ class Copilots {
566
576
  Authorization: yield this._getAuthorizationHeader(),
567
577
  "X-Fern-Language": "JavaScript",
568
578
  "X-Fern-SDK-Name": "@credal/sdk",
569
- "X-Fern-SDK-Version": "0.0.14",
579
+ "X-Fern-SDK-Version": "0.0.16",
580
+ "User-Agent": "@credal/sdk/0.0.16",
570
581
  "X-Fern-Runtime": core.RUNTIME.type,
571
582
  "X-Fern-Runtime-Version": core.RUNTIME.version,
572
583
  },
573
584
  contentType: "application/json",
574
- body: yield serializers.DeleteCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
585
+ requestType: "json",
586
+ body: serializers.DeleteCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
575
587
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
576
588
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
577
589
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
578
590
  });
579
591
  if (_response.ok) {
580
- return yield serializers.DeleteCopilotResponse.parseOrThrow(_response.body, {
592
+ return serializers.DeleteCopilotResponse.parseOrThrow(_response.body, {
581
593
  unrecognizedObjectKeys: "passthrough",
582
594
  allowUnrecognizedUnionMembers: true,
583
595
  allowUnrecognizedEnumValues: true,
@@ -9,7 +9,7 @@ import * as Credal from "../../../../index";
9
9
  * description: "This copilot is used to answer customer requests based on internal documentation.",
10
10
  * collaborators: [{
11
11
  * email: "test@gmail.com",
12
- * role: Credal.Role.Editor
12
+ * role: "editor"
13
13
  * }]
14
14
  * }
15
15
  */
@@ -9,7 +9,7 @@ import * as Credal from "../../../../index";
9
9
  * messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
10
10
  * agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
11
11
  * messageFeedback: {
12
- * feedback: Credal.FeedbackEnum.Negative,
12
+ * feedback: "NEGATIVE",
13
13
  * suggestedAnswer: "Yes, Credal is SOC 2 compliant."
14
14
  * }
15
15
  * }
@@ -4,6 +4,6 @@
4
4
  import * as Credal from "../../../index";
5
5
  export interface DataFilter {
6
6
  semanticSearchTerms: string[];
7
- webSearchResults: string[];
7
+ webSearchTerm: string[];
8
8
  filteredDataSourcesPerCollection: Credal.CollectionFilteredData[];
9
9
  }
@@ -3,5 +3,5 @@
3
3
  */
4
4
  import * as Credal from "../../../index";
5
5
  export interface FinalChunk {
6
- referencedSources: Credal.ReferencedSource[];
6
+ sources: Credal.ReferencedSource[];
7
7
  }
@@ -2,4 +2,18 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as Credal from "../../../index";
5
- export declare type StreamingChunk = Credal.InitialChunk | Credal.DataChunk | Credal.FinalChunk | Credal.BlockedChunk;
5
+ export declare type StreamingChunk = Credal.StreamingChunk.Initial | Credal.StreamingChunk.DataChunk | Credal.StreamingChunk.FinalChunk | Credal.StreamingChunk.Blocked;
6
+ export declare namespace StreamingChunk {
7
+ interface Initial extends Credal.InitialChunk {
8
+ event: "initial";
9
+ }
10
+ interface DataChunk extends Credal.DataChunk {
11
+ event: "data_chunk";
12
+ }
13
+ interface FinalChunk extends Credal.FinalChunk {
14
+ event: "final_chunk";
15
+ }
16
+ interface Blocked extends Credal.BlockedChunk {
17
+ event: "blocked";
18
+ }
19
+ }
@@ -11,8 +11,11 @@ export declare namespace DocumentCatalog {
11
11
  fetcher?: core.FetchFunction;
12
12
  }
13
13
  interface RequestOptions {
14
+ /** The maximum time to wait for a response in seconds. */
14
15
  timeoutInSeconds?: number;
16
+ /** The number of times to retry the request. Defaults to 2. */
15
17
  maxRetries?: number;
18
+ /** A hook to abort the request. */
16
19
  abortSignal?: AbortSignal;
17
20
  }
18
21
  }
@@ -24,7 +27,7 @@ export declare class DocumentCatalog {
24
27
  * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
25
28
  *
26
29
  * @example
27
- * await credal.documentCatalog.uploadDocumentContents({
30
+ * await client.documentCatalog.uploadDocumentContents({
28
31
  * documentName: "My Document",
29
32
  * documentContents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
30
33
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
@@ -40,7 +43,7 @@ export declare class DocumentCatalog {
40
43
  * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
41
44
  *
42
45
  * @example
43
- * await credal.documentCatalog.metadata({
46
+ * await client.documentCatalog.metadata({
44
47
  * sources: [{
45
48
  * metadata: {
46
49
  * "Department": "HR",
@@ -49,7 +52,7 @@ export declare class DocumentCatalog {
49
52
  * resourceIdentifier: {
50
53
  * type: "external-resource-id",
51
54
  * externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
52
- * resourceType: Credal.ResourceType.GoogleDriveItem
55
+ * resourceType: "GOOGLE_DRIVE_ITEM"
53
56
  * }
54
57
  * }, {
55
58
  * metadata: {
@@ -59,7 +62,7 @@ export declare class DocumentCatalog {
59
62
  * resourceIdentifier: {
60
63
  * type: "external-resource-id",
61
64
  * externalResourceId: "123456",
62
- * resourceType: Credal.ResourceType.ZendeskTicket
65
+ * resourceType: "ZENDESK_TICKET"
63
66
  * }
64
67
  * }],
65
68
  * uploadAsUserEmail: "ben@credal.ai"
@@ -53,7 +53,7 @@ class DocumentCatalog {
53
53
  * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
54
54
  *
55
55
  * @example
56
- * await credal.documentCatalog.uploadDocumentContents({
56
+ * await client.documentCatalog.uploadDocumentContents({
57
57
  * documentName: "My Document",
58
58
  * documentContents: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
59
59
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
@@ -71,20 +71,20 @@ 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.14",
74
+ "X-Fern-SDK-Version": "0.0.16",
75
+ "User-Agent": "@credal/sdk/0.0.16",
75
76
  "X-Fern-Runtime": core.RUNTIME.type,
76
77
  "X-Fern-Runtime-Version": core.RUNTIME.version,
77
78
  },
78
79
  contentType: "application/json",
79
- body: yield serializers.UploadDocumentContentsRequest.jsonOrThrow(request, {
80
- unrecognizedObjectKeys: "strip",
81
- }),
80
+ requestType: "json",
81
+ body: serializers.UploadDocumentContentsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
82
82
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
83
83
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
84
84
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
85
85
  });
86
86
  if (_response.ok) {
87
- return yield serializers.UploadDocumentResponse.parseOrThrow(_response.body, {
87
+ return serializers.UploadDocumentResponse.parseOrThrow(_response.body, {
88
88
  unrecognizedObjectKeys: "passthrough",
89
89
  allowUnrecognizedUnionMembers: true,
90
90
  allowUnrecognizedEnumValues: true,
@@ -119,7 +119,7 @@ class DocumentCatalog {
119
119
  * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
120
120
  *
121
121
  * @example
122
- * await credal.documentCatalog.metadata({
122
+ * await client.documentCatalog.metadata({
123
123
  * sources: [{
124
124
  * metadata: {
125
125
  * "Department": "HR",
@@ -128,7 +128,7 @@ class DocumentCatalog {
128
128
  * resourceIdentifier: {
129
129
  * type: "external-resource-id",
130
130
  * externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
131
- * resourceType: Credal.ResourceType.GoogleDriveItem
131
+ * resourceType: "GOOGLE_DRIVE_ITEM"
132
132
  * }
133
133
  * }, {
134
134
  * metadata: {
@@ -138,7 +138,7 @@ class DocumentCatalog {
138
138
  * resourceIdentifier: {
139
139
  * type: "external-resource-id",
140
140
  * externalResourceId: "123456",
141
- * resourceType: Credal.ResourceType.ZendeskTicket
141
+ * resourceType: "ZENDESK_TICKET"
142
142
  * }
143
143
  * }],
144
144
  * uploadAsUserEmail: "ben@credal.ai"
@@ -154,14 +154,14 @@ 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.14",
157
+ "X-Fern-SDK-Version": "0.0.16",
158
+ "User-Agent": "@credal/sdk/0.0.16",
158
159
  "X-Fern-Runtime": core.RUNTIME.type,
159
160
  "X-Fern-Runtime-Version": core.RUNTIME.version,
160
161
  },
161
162
  contentType: "application/json",
162
- body: yield serializers.DocumentMetadataPatchRequest.jsonOrThrow(request, {
163
- unrecognizedObjectKeys: "strip",
164
- }),
163
+ requestType: "json",
164
+ body: serializers.DocumentMetadataPatchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
165
165
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
166
166
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
167
167
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -11,8 +11,11 @@ export declare namespace DocumentCollections {
11
11
  fetcher?: core.FetchFunction;
12
12
  }
13
13
  interface RequestOptions {
14
+ /** The maximum time to wait for a response in seconds. */
14
15
  timeoutInSeconds?: number;
16
+ /** The number of times to retry the request. Defaults to 2. */
15
17
  maxRetries?: number;
18
+ /** A hook to abort the request. */
16
19
  abortSignal?: AbortSignal;
17
20
  }
18
21
  }
@@ -26,16 +29,16 @@ export declare class DocumentCollections {
26
29
  * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
27
30
  *
28
31
  * @example
29
- * await credal.documentCollections.addDocumentsToCollection({
32
+ * await client.documentCollections.addDocumentsToCollection({
30
33
  * collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
31
34
  * resourceIdentifiers: [{
32
35
  * type: "external-resource-id",
33
36
  * externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
34
- * resourceType: Credal.ResourceType.GoogleDriveItem
37
+ * resourceType: "GOOGLE_DRIVE_ITEM"
35
38
  * }, {
36
39
  * type: "external-resource-id",
37
40
  * externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
38
- * resourceType: Credal.ResourceType.GoogleDriveItem
41
+ * resourceType: "GOOGLE_DRIVE_ITEM"
39
42
  * }]
40
43
  * })
41
44
  */
@@ -47,16 +50,16 @@ export declare class DocumentCollections {
47
50
  * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
48
51
  *
49
52
  * @example
50
- * await credal.documentCollections.removeDocumentsFromCollection({
53
+ * await client.documentCollections.removeDocumentsFromCollection({
51
54
  * collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
52
55
  * resourceIdentifiers: [{
53
56
  * type: "external-resource-id",
54
57
  * externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
55
- * resourceType: Credal.ResourceType.GoogleDriveItem
58
+ * resourceType: "GOOGLE_DRIVE_ITEM"
56
59
  * }, {
57
60
  * type: "external-resource-id",
58
61
  * externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
59
- * resourceType: Credal.ResourceType.GoogleDriveItem
62
+ * resourceType: "GOOGLE_DRIVE_ITEM"
60
63
  * }]
61
64
  * })
62
65
  */
@@ -68,12 +71,12 @@ export declare class DocumentCollections {
68
71
  * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
69
72
  *
70
73
  * @example
71
- * await credal.documentCollections.createCollection({
74
+ * await client.documentCollections.createCollection({
72
75
  * name: "Customer Collection",
73
76
  * description: "This collection is used to answer customer requests based on internal documentation.",
74
77
  * collaborators: [{
75
78
  * email: "test@gmail.com",
76
- * role: Credal.Role.Editor
79
+ * role: "editor"
77
80
  * }]
78
81
  * })
79
82
  */
@@ -85,7 +88,7 @@ export declare class DocumentCollections {
85
88
  * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
86
89
  *
87
90
  * @example
88
- * await credal.documentCollections.deleteCollection({
91
+ * await client.documentCollections.deleteCollection({
89
92
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
90
93
  * })
91
94
  */
@@ -97,7 +100,7 @@ export declare class DocumentCollections {
97
100
  * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
98
101
  *
99
102
  * @example
100
- * await credal.documentCollections.createMongoCollectionSync({
103
+ * await client.documentCollections.createMongoCollectionSync({
101
104
  * mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
102
105
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
103
106
  * config: {
@@ -125,7 +128,7 @@ export declare class DocumentCollections {
125
128
  * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
126
129
  *
127
130
  * @example
128
- * await credal.documentCollections.updateMongoCollectionSync({
131
+ * await client.documentCollections.updateMongoCollectionSync({
129
132
  * mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
130
133
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
131
134
  * config: {