@credal/sdk 0.0.13 → 0.0.15

package/api/resources/copilots/types/DataChunk.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DataChunk {
+    chunk: string;
+}

package/api/resources/copilots/types/DataChunk.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/DataFilter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface DataFilter {
+    semanticSearchTerms: string[];
+    webSearchTerm: string[];
+    filteredDataSourcesPerCollection: Credal.CollectionFilteredData[];
+}

package/api/resources/copilots/types/DataFilter.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/DatetimeFieldSchema.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface DatetimeFieldSchema {
+    field: string;
+    operator: Credal.Operator;
+    value: string;
+}

package/api/resources/copilots/types/DatetimeFieldSchema.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/Filter.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type Filter = Credal.Filter.String | Credal.Filter.Number | Credal.Filter.Boolean | Credal.Filter.Datetime;
+export declare namespace Filter {
+    interface String extends Credal.StringFieldSchema {
+        fieldType: "string";
+    }
+    interface Number extends Credal.NumberFieldSchema {
+        fieldType: "number";
+    }
+    interface Boolean extends Credal.BooleanFieldSchema {
+        fieldType: "boolean";
+    }
+    interface Datetime extends Credal.DatetimeFieldSchema {
+        fieldType: "datetime";
+    }
+}

package/api/resources/copilots/types/Filter.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/FinalChunk.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface FinalChunk {
+    sources: Credal.ReferencedSource[];
+}

package/api/resources/copilots/types/FinalChunk.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/InitialChunk.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface InitialChunk {
+    conversationId: string;
+    warnings: string[];
+    webSearchResults: Credal.WebSearchResult[];
+    dataFilters?: Credal.DataFilter;
+}

package/api/resources/copilots/types/InitialChunk.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/InputVariable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InputVariable {
+    name: string;
+    urls: string[];
+}

package/api/resources/copilots/types/InputVariable.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/MessageReply.d.ts

@@ -10,5 +10,6 @@ export interface MessageReply {
     insertedAuditLog: Credal.InsertedAuditLog;
     referencedSources: Credal.ReferencedSource[];
     sourcesInDataContext: Credal.ReferencedSource[];
+    webSearchResults: Credal.WebSearchResult[];
     messageId: string;
 }

package/api/resources/copilots/types/NumberFieldSchema.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface NumberFieldSchema {
+    field: string;
+    operator: Credal.Operator;
+    value: number;
+}

package/api/resources/copilots/types/NumberFieldSchema.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/StreamingChunk.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type StreamingChunk = Credal.InitialChunk | Credal.DataChunk | Credal.FinalChunk | Credal.BlockedChunk;

package/api/resources/copilots/types/StreamingChunk.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/StringFieldSchema.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface StringFieldSchema {
+    field: string;
+    operator: Credal.Operator;
+    value: string;
+}

package/api/resources/copilots/types/StringFieldSchema.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/WebSearchResult.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WebSearchResult {
+    title: string;
+    url: string;
+    content: string;
+}

package/api/resources/copilots/types/WebSearchResult.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/index.d.ts

@@ -1,8 +1,10 @@
 export * from "./CreateConversationResponse";
 export * from "./SendAgentMessageResponse";
 export * from "./SendMessageResponse";
+export * from "./InputVariable";
 export * from "./MessageReply";
 export * from "./ReferencedSource";
+export * from "./WebSearchResult";
 export * from "./ResponseChunk";
 export * from "./InsertedAuditLog";
 export * from "./MessageBlocked";
@@ -13,3 +15,15 @@ export * from "./Configuration";
 export * from "./AiEndpointConfiguration";
 export * from "./CreateCopilotResponse";
 export * from "./DeleteCopilotResponse";
+export * from "./StringFieldSchema";
+export * from "./NumberFieldSchema";
+export * from "./BooleanFieldSchema";
+export * from "./DatetimeFieldSchema";
+export * from "./Filter";
+export * from "./CollectionFilteredData";
+export * from "./DataFilter";
+export * from "./InitialChunk";
+export * from "./DataChunk";
+export * from "./FinalChunk";
+export * from "./BlockedChunk";
+export * from "./StreamingChunk";

package/api/resources/copilots/types/index.js

@@ -17,8 +17,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CreateConversationResponse"), exports);
 __exportStar(require("./SendAgentMessageResponse"), exports);
 __exportStar(require("./SendMessageResponse"), exports);
+__exportStar(require("./InputVariable"), exports);
 __exportStar(require("./MessageReply"), exports);
 __exportStar(require("./ReferencedSource"), exports);
+__exportStar(require("./WebSearchResult"), exports);
 __exportStar(require("./ResponseChunk"), exports);
 __exportStar(require("./InsertedAuditLog"), exports);
 __exportStar(require("./MessageBlocked"), exports);
@@ -29,3 +31,15 @@ __exportStar(require("./Configuration"), exports);
 __exportStar(require("./AiEndpointConfiguration"), exports);
 __exportStar(require("./CreateCopilotResponse"), exports);
 __exportStar(require("./DeleteCopilotResponse"), exports);
+__exportStar(require("./StringFieldSchema"), exports);
+__exportStar(require("./NumberFieldSchema"), exports);
+__exportStar(require("./BooleanFieldSchema"), exports);
+__exportStar(require("./DatetimeFieldSchema"), exports);
+__exportStar(require("./Filter"), exports);
+__exportStar(require("./CollectionFilteredData"), exports);
+__exportStar(require("./DataFilter"), exports);
+__exportStar(require("./InitialChunk"), exports);
+__exportStar(require("./DataChunk"), exports);
+__exportStar(require("./FinalChunk"), exports);
+__exportStar(require("./BlockedChunk"), exports);
+__exportStar(require("./StreamingChunk"), exports);

package/api/resources/documentCatalog/client/Client.d.ts

@@ -11,8 +11,11 @@ export declare namespace DocumentCatalog {
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -24,7 +27,7 @@ export declare class DocumentCatalog {
      * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCatalog.uploadDocumentContents({
+     *     await client.documentCatalog.uploadDocumentContents({
      *         documentName: "My Document",
      *         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.",
      *         documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
@@ -40,7 +43,7 @@ export declare class DocumentCatalog {
      * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCatalog.metadata({
+     *     await client.documentCatalog.metadata({
      *         sources: [{
      *                 metadata: {
      *                     "Department": "HR",
@@ -49,7 +52,7 @@ export declare class DocumentCatalog {
      *                 resourceIdentifier: {
      *                     type: "external-resource-id",
      *                     externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
-     *                     resourceType: Credal.ResourceType.GoogleDriveItem
+     *                     resourceType: "GOOGLE_DRIVE_ITEM"
      *                 }
      *             }, {
      *                 metadata: {
@@ -59,7 +62,7 @@ export declare class DocumentCatalog {
      *                 resourceIdentifier: {
      *                     type: "external-resource-id",
      *                     externalResourceId: "123456",
-     *                     resourceType: Credal.ResourceType.ZendeskTicket
+     *                     resourceType: "ZENDESK_TICKET"
      *                 }
      *             }],
      *         uploadAsUserEmail: "ben@credal.ai"

package/api/resources/documentCatalog/client/Client.js

@@ -53,7 +53,7 @@ class DocumentCatalog {
      * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCatalog.uploadDocumentContents({
+     *     await client.documentCatalog.uploadDocumentContents({
      *         documentName: "My Document",
      *         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.",
      *         documentExternalId: "73eead26-d124-4940-b329-5f068a0a8db9",
@@ -71,20 +71,20 @@ class DocumentCatalog {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.15",
+                    "User-Agent": "@credal/sdk/0.0.15",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.UploadDocumentContentsRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.UploadDocumentContentsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.UploadDocumentResponse.parseOrThrow(_response.body, {
+                return serializers.UploadDocumentResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -119,7 +119,7 @@ class DocumentCatalog {
      * @param {DocumentCatalog.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCatalog.metadata({
+     *     await client.documentCatalog.metadata({
      *         sources: [{
      *                 metadata: {
      *                     "Department": "HR",
@@ -128,7 +128,7 @@ class DocumentCatalog {
      *                 resourceIdentifier: {
      *                     type: "external-resource-id",
      *                     externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
-     *                     resourceType: Credal.ResourceType.GoogleDriveItem
+     *                     resourceType: "GOOGLE_DRIVE_ITEM"
      *                 }
      *             }, {
      *                 metadata: {
@@ -138,7 +138,7 @@ class DocumentCatalog {
      *                 resourceIdentifier: {
      *                     type: "external-resource-id",
      *                     externalResourceId: "123456",
-     *                     resourceType: Credal.ResourceType.ZendeskTicket
+     *                     resourceType: "ZENDESK_TICKET"
      *                 }
      *             }],
      *         uploadAsUserEmail: "ben@credal.ai"
@@ -154,14 +154,14 @@ class DocumentCatalog {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.15",
+                    "User-Agent": "@credal/sdk/0.0.15",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.DocumentMetadataPatchRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.DocumentMetadataPatchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,

package/api/resources/documentCollections/client/Client.d.ts

@@ -11,8 +11,11 @@ export declare namespace DocumentCollections {
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -26,16 +29,16 @@ export declare class DocumentCollections {
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCollections.addDocumentsToCollection({
+     *     await client.documentCollections.addDocumentsToCollection({
      *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         resourceIdentifiers: [{
      *                 type: "external-resource-id",
      *                 externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
-     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *                 resourceType: "GOOGLE_DRIVE_ITEM"
      *             }, {
      *                 type: "external-resource-id",
      *                 externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
-     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *                 resourceType: "GOOGLE_DRIVE_ITEM"
      *             }]
      *     })
      */
@@ -47,16 +50,16 @@ export declare class DocumentCollections {
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCollections.removeDocumentsFromCollection({
+     *     await client.documentCollections.removeDocumentsFromCollection({
      *         collectionId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         resourceIdentifiers: [{
      *                 type: "external-resource-id",
      *                 externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
-     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *                 resourceType: "GOOGLE_DRIVE_ITEM"
      *             }, {
      *                 type: "external-resource-id",
      *                 externalResourceId: "398KAHdfkjsdf09r54UvyslPVWkQFOA0lOiu34in923",
-     *                 resourceType: Credal.ResourceType.GoogleDriveItem
+     *                 resourceType: "GOOGLE_DRIVE_ITEM"
      *             }]
      *     })
      */
@@ -68,12 +71,12 @@ export declare class DocumentCollections {
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCollections.createCollection({
+     *     await client.documentCollections.createCollection({
      *         name: "Customer Collection",
      *         description: "This collection is used to answer customer requests based on internal documentation.",
      *         collaborators: [{
      *                 email: "test@gmail.com",
-     *                 role: Credal.Role.Editor
+     *                 role: "editor"
      *             }]
      *     })
      */
@@ -85,7 +88,7 @@ export declare class DocumentCollections {
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCollections.deleteCollection({
+     *     await client.documentCollections.deleteCollection({
      *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
      *     })
      */
@@ -97,7 +100,7 @@ export declare class DocumentCollections {
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCollections.createMongoCollectionSync({
+     *     await client.documentCollections.createMongoCollectionSync({
      *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
      *         collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
      *         config: {
@@ -125,7 +128,7 @@ export declare class DocumentCollections {
      * @param {DocumentCollections.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.documentCollections.updateMongoCollectionSync({
+     *     await client.documentCollections.updateMongoCollectionSync({
      *         mongoUri: "mongodb+srv://cluster0.hzwklqn.mongodb.net/Cluster0?retryWrites=true&w=majority",
      *         mongoCredentialId: "5988ed76-6ee1-11ef-97dd-1fca54b7c4bc",
      *         config: {