@credal/sdk 0.1.0 → 0.1.1

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 (24) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/copilots/types/ResponseChunk.d.ts +1 -0
  3. package/dist/cjs/api/resources/documentCatalog/client/Client.d.ts +1 -1
  4. package/dist/cjs/api/resources/documentCatalog/client/Client.js +1 -1
  5. package/dist/cjs/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.ts +2 -2
  6. package/dist/cjs/api/resources/documentCollections/client/Client.d.ts +2 -2
  7. package/dist/cjs/api/resources/documentCollections/client/Client.js +2 -2
  8. package/dist/cjs/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.ts +1 -1
  9. package/dist/cjs/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.ts +1 -1
  10. package/dist/cjs/version.d.ts +1 -1
  11. package/dist/cjs/version.js +1 -1
  12. package/dist/esm/Client.mjs +2 -2
  13. package/dist/esm/api/resources/copilots/types/ResponseChunk.d.mts +1 -0
  14. package/dist/esm/api/resources/documentCatalog/client/Client.d.mts +1 -1
  15. package/dist/esm/api/resources/documentCatalog/client/Client.mjs +1 -1
  16. package/dist/esm/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.mts +2 -2
  17. package/dist/esm/api/resources/documentCollections/client/Client.d.mts +2 -2
  18. package/dist/esm/api/resources/documentCollections/client/Client.mjs +2 -2
  19. package/dist/esm/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.mts +1 -1
  20. package/dist/esm/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.mts +1 -1
  21. package/dist/esm/version.d.mts +1 -1
  22. package/dist/esm/version.mjs +1 -1
  23. package/package.json +1 -1
  24. package/reference.md +3 -4
package/dist/cjs/Client.js CHANGED
@@ -50,8 +50,8 @@ class CredalClient {
50
50
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
51
51
  "X-Fern-Language": "JavaScript",
52
52
  "X-Fern-SDK-Name": "@credal/sdk",
53
- "X-Fern-SDK-Version": "0.1.0",
54
- "User-Agent": "@credal/sdk/0.1.0",
53
+ "X-Fern-SDK-Version": "0.1.1",
54
+ "User-Agent": "@credal/sdk/0.1.1",
55
55
  "X-Fern-Runtime": core.RUNTIME.type,
56
56
  "X-Fern-Runtime-Version": core.RUNTIME.version,
57
57
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
package/dist/cjs/api/resources/copilots/types/ResponseChunk.d.ts CHANGED
@@ -4,4 +4,5 @@
4
4
  export interface ResponseChunk {
5
5
  message: string;
6
6
  dataChunk: string;
7
+ structuredOutput?: unknown;
7
8
  }
package/dist/cjs/api/resources/documentCatalog/client/Client.d.ts CHANGED
@@ -37,7 +37,7 @@ export declare class DocumentCatalog {
37
37
  * @example
38
38
  * await client.documentCatalog.uploadDocumentContents({
39
39
  * documentName: "My Document",
40
- * 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.",
40
+ * documentContents: "Lorem ipsum...",
41
41
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
42
42
  * allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
43
43
  * uploadAsUserEmail: "jack@credal.ai"
package/dist/cjs/api/resources/documentCatalog/client/Client.js CHANGED
@@ -61,7 +61,7 @@ class DocumentCatalog {
61
61
  * @example
62
62
  * await client.documentCatalog.uploadDocumentContents({
63
63
  * documentName: "My Document",
64
- * 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.",
64
+ * documentContents: "Lorem ipsum...",
65
65
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
66
66
  * allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
67
67
  * uploadAsUserEmail: "jack@credal.ai"
package/dist/cjs/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * @example
6
6
  * {
7
7
  * documentName: "My Document",
8
- * 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.",
8
+ * documentContents: "Lorem ipsum...",
9
9
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
10
10
  * allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
11
11
  * uploadAsUserEmail: "jack@credal.ai"
@@ -24,7 +24,7 @@ export interface UploadDocumentContentsRequest {
24
24
  documentExternalId: string;
25
25
  /** The external URL of the document you want to upload. If provided Credal will link to this URL. */
26
26
  documentExternalUrl?: string;
27
- /** Optional JSON representing any custom metdata for this document */
27
+ /** Optional JSON representing any custom metadata for this document */
28
28
  customMetadata?: unknown;
29
29
  /** If specified, document will also be added to a particular document collection */
30
30
  collectionId?: string;
package/dist/cjs/api/resources/documentCollections/client/Client.d.ts CHANGED
@@ -113,7 +113,7 @@ export declare class DocumentCollections {
113
113
  *
114
114
  * @example
115
115
  * await client.documentCollections.createMongoCollectionSync({
116
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
116
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
117
117
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
118
118
  * config: {
119
119
  * syncName: "My sales transcripts",
@@ -142,7 +142,7 @@ export declare class DocumentCollections {
142
142
  *
143
143
  * @example
144
144
  * await client.documentCollections.updateMongoCollectionSync({
145
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
145
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
146
146
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
147
147
  * config: {
148
148
  * syncName: "My recent summarized sales transcripts",
package/dist/cjs/api/resources/documentCollections/client/Client.js CHANGED
@@ -309,7 +309,7 @@ class DocumentCollections {
309
309
  *
310
310
  * @example
311
311
  * await client.documentCollections.createMongoCollectionSync({
312
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
312
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
313
313
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
314
314
  * config: {
315
315
  * syncName: "My sales transcripts",
@@ -381,7 +381,7 @@ class DocumentCollections {
381
381
  *
382
382
  * @example
383
383
  * await client.documentCollections.updateMongoCollectionSync({
384
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
384
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
385
385
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
386
386
  * config: {
387
387
  * syncName: "My recent summarized sales transcripts",
package/dist/cjs/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.ts CHANGED
@@ -5,7 +5,7 @@ import * as Credal from "../../../../index.js";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
8
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
9
9
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
10
10
  * config: {
11
11
  * syncName: "My sales transcripts",
package/dist/cjs/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.ts CHANGED
@@ -5,7 +5,7 @@ import * as Credal from "../../../../index.js";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
8
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
9
9
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
10
10
  * config: {
11
11
  * syncName: "My recent summarized sales transcripts",
package/dist/cjs/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.1.0";
1
+ export declare const SDK_VERSION = "0.1.1";
package/dist/cjs/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.1.0";
4
+ exports.SDK_VERSION = "0.1.1";
package/dist/esm/Client.mjs CHANGED
@@ -14,8 +14,8 @@ export class CredalClient {
14
14
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
15
15
  "X-Fern-Language": "JavaScript",
16
16
  "X-Fern-SDK-Name": "@credal/sdk",
17
- "X-Fern-SDK-Version": "0.1.0",
18
- "User-Agent": "@credal/sdk/0.1.0",
17
+ "X-Fern-SDK-Version": "0.1.1",
18
+ "User-Agent": "@credal/sdk/0.1.1",
19
19
  "X-Fern-Runtime": core.RUNTIME.type,
20
20
  "X-Fern-Runtime-Version": core.RUNTIME.version,
21
21
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
package/dist/esm/api/resources/copilots/types/ResponseChunk.d.mts CHANGED
@@ -4,4 +4,5 @@
4
4
  export interface ResponseChunk {
5
5
  message: string;
6
6
  dataChunk: string;
7
+ structuredOutput?: unknown;
7
8
  }
package/dist/esm/api/resources/documentCatalog/client/Client.d.mts CHANGED
@@ -37,7 +37,7 @@ export declare class DocumentCatalog {
37
37
  * @example
38
38
  * await client.documentCatalog.uploadDocumentContents({
39
39
  * documentName: "My Document",
40
- * 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.",
40
+ * documentContents: "Lorem ipsum...",
41
41
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
42
42
  * allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
43
43
  * uploadAsUserEmail: "jack@credal.ai"
package/dist/esm/api/resources/documentCatalog/client/Client.mjs CHANGED
@@ -25,7 +25,7 @@ export class DocumentCatalog {
25
25
  * @example
26
26
  * await client.documentCatalog.uploadDocumentContents({
27
27
  * documentName: "My Document",
28
- * 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.",
28
+ * documentContents: "Lorem ipsum...",
29
29
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
30
30
  * allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
31
31
  * uploadAsUserEmail: "jack@credal.ai"
package/dist/esm/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.mts CHANGED
@@ -5,7 +5,7 @@
5
5
  * @example
6
6
  * {
7
7
  * documentName: "My Document",
8
- * 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.",
8
+ * documentContents: "Lorem ipsum...",
9
9
  * documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
10
10
  * allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
11
11
  * uploadAsUserEmail: "jack@credal.ai"
@@ -24,7 +24,7 @@ export interface UploadDocumentContentsRequest {
24
24
  documentExternalId: string;
25
25
  /** The external URL of the document you want to upload. If provided Credal will link to this URL. */
26
26
  documentExternalUrl?: string;
27
- /** Optional JSON representing any custom metdata for this document */
27
+ /** Optional JSON representing any custom metadata for this document */
28
28
  customMetadata?: unknown;
29
29
  /** If specified, document will also be added to a particular document collection */
30
30
  collectionId?: string;
package/dist/esm/api/resources/documentCollections/client/Client.d.mts CHANGED
@@ -113,7 +113,7 @@ export declare class DocumentCollections {
113
113
  *
114
114
  * @example
115
115
  * await client.documentCollections.createMongoCollectionSync({
116
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
116
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
117
117
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
118
118
  * config: {
119
119
  * syncName: "My sales transcripts",
@@ -142,7 +142,7 @@ export declare class DocumentCollections {
142
142
  *
143
143
  * @example
144
144
  * await client.documentCollections.updateMongoCollectionSync({
145
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
145
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
146
146
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
147
147
  * config: {
148
148
  * syncName: "My recent summarized sales transcripts",
package/dist/esm/api/resources/documentCollections/client/Client.mjs CHANGED
@@ -273,7 +273,7 @@ export class DocumentCollections {
273
273
  *
274
274
  * @example
275
275
  * await client.documentCollections.createMongoCollectionSync({
276
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
276
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
277
277
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
278
278
  * config: {
279
279
  * syncName: "My sales transcripts",
@@ -345,7 +345,7 @@ export class DocumentCollections {
345
345
  *
346
346
  * @example
347
347
  * await client.documentCollections.updateMongoCollectionSync({
348
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
348
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
349
349
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
350
350
  * config: {
351
351
  * syncName: "My recent summarized sales transcripts",
package/dist/esm/api/resources/documentCollections/client/requests/CreateMongoCollectionSyncRequest.d.mts CHANGED
@@ -5,7 +5,7 @@ import * as Credal from "../../../../index.mjs";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
8
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
9
9
  * collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
10
10
  * config: {
11
11
  * syncName: "My sales transcripts",
package/dist/esm/api/resources/documentCollections/client/requests/UpdateMongoCollectionSyncRequest.d.mts CHANGED
@@ -5,7 +5,7 @@ import * as Credal from "../../../../index.mjs";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
8
+ * mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
9
9
  * mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
10
10
  * config: {
11
11
  * syncName: "My recent summarized sales transcripts",
package/dist/esm/version.d.mts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.1.0";
1
+ export declare const SDK_VERSION = "0.1.1";
package/dist/esm/version.mjs CHANGED
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.1.0";
1
+ export const SDK_VERSION = "0.1.1";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@credal/sdk",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "private": false,
5
5
  "repository": "github:credal-ai/credal-typescript-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -612,8 +612,7 @@ await client.copilots.deleteCopilot({
612
612
  ```typescript
613
613
  await client.documentCatalog.uploadDocumentContents({
614
614
  documentName: "My Document",
615
- documentContents:
616
- "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.",
615
+ documentContents: "Lorem ipsum...",
617
616
  documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
618
617
  allowedUsersEmailAddresses: ["jack@credal.ai", "ravin@credal.ai"],
619
618
  uploadAsUserEmail: "jack@credal.ai",
@@ -1129,7 +1128,7 @@ Credal lets you easily sync your MongoDB data for use in Collections and Agents.
1129
1128
 
1130
1129
  ```typescript
1131
1130
  await client.documentCollections.createMongoCollectionSync({
1132
- mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
1131
+ mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
1133
1132
  collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
1134
1133
  config: {
1135
1134
  syncName: "My sales transcripts",
@@ -1210,7 +1209,7 @@ Credal lets you easily sync your MongoDB data for use in Collections and Agents.
1210
1209
 
1211
1210
  ```typescript
1212
1211
  await client.documentCollections.updateMongoCollectionSync({
1213
- mongoURI: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
1212
+ mongoURI: "mongodb+srv://cluster0.abcdefg.mongodb.net/Cluster0?retryWrites=true&w=majority",
1214
1213
  mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
1215
1214
  config: {
1216
1215
  syncName: "My recent summarized sales transcripts",