@credal/sdk 0.0.9 → 0.0.11

package/api/resources/common/types/Collaborator.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface Collaborator {
+    email: string;
+    role: Credal.Role;
+}

package/api/resources/common/types/Collaborator.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/common/types/Role.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Role = "viewer" | "editor";
+export declare const Role: {
+    readonly Viewer: "viewer";
+    readonly Editor: "editor";
+};

package/api/resources/common/types/Role.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Role = void 0;
+exports.Role = {
+    Viewer: "viewer",
+    Editor: "editor",
+};

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

@@ -2,3 +2,5 @@ export * from "./ResourceIdentifier";
 export * from "./ExternalResourceId";
 export * from "./Url";
 export * from "./ResourceType";
+export * from "./Collaborator";
+export * from "./Role";

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

@@ -18,3 +18,5 @@ __exportStar(require("./ResourceIdentifier"), exports);
 __exportStar(require("./ExternalResourceId"), exports);
 __exportStar(require("./Url"), exports);
 __exportStar(require("./ResourceType"), exports);
+__exportStar(require("./Collaborator"), exports);
+__exportStar(require("./Role"), exports);

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

@@ -20,7 +20,24 @@ export declare class Copilots {
     protected readonly _options: Copilots.Options;
     constructor(_options?: Copilots.Options);
     /**
-     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
+     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     *
+     * @param {Credal.CreateCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.createCopilot({
+     *         name: "Customer Copilot",
+     *         description: "This copilot is used to answer customer requests based on internal documentation.",
+     *         collaborators: [{
+     *                 email: "test@gmail.com",
+     *                 role: Credal.Role.Editor
+     *             }]
+     *     })
+     */
+    createCopilot(request: Credal.CreateCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.CreateCopilotResponse>;
+    /**
+     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the `sendMessage` endpoint. The `sendMessage` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
      *
      * @param {Credal.CreateConversationRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -60,5 +77,62 @@ export declare class Copilots {
      *     })
      */
     sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.SendAgentMessageResponse>;
+    /**
+     * Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     *
+     * @param {Credal.AddCollectionToCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.addCollectionToCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    addCollectionToCopilot(request: Credal.AddCollectionToCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
+    /**
+     * Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     *
+     * @param {Credal.RemoveCollectionFromCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.removeCollectionFromCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    removeCollectionFromCopilot(request: Credal.RemoveCollectionFromCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
+    /**
+     * Update the configuration for a copilot
+     *
+     * @param {Credal.UpdateConfigurationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.updateConfiguration({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         configuration: {
+     *             name: "Customer Copilot",
+     *             description: "This copilot is used to answer customer requests based on internal documentation.",
+     *             prompt: "You are a polite, helpful assistant used to answer customer requests.",
+     *             aiEndpointConfiguration: {
+     *                 baseUrl: "https://api.openai.com/v1/",
+     *                 apiKey: "<YOUR_API_KEY_HERE>"
+     *             }
+     *         }
+     *     })
+     */
+    updateConfiguration(request: Credal.UpdateConfigurationRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
+    /**
+     * @param {Credal.DeleteCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.deleteCopilot({
+     *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+     *     })
+     */
+    deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.DeleteCopilotResponse>;
     protected _getAuthorizationHeader(): Promise<string>;
 }

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

@@ -49,7 +49,72 @@ class Copilots {
         this._options = _options;
     }
     /**
-     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
+     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     *
+     * @param {Credal.CreateCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.createCopilot({
+     *         name: "Customer Copilot",
+     *         description: "This copilot is used to answer customer requests based on internal documentation.",
+     *         collaborators: [{
+     *                 email: "test@gmail.com",
+     *                 role: Credal.Role.Editor
+     *             }]
+     *     })
+     */
+    createCopilot(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/createCopilot"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.11",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.CreateCopilotRequest.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.CreateCopilotResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the `sendMessage` endpoint. The `sendMessage` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
      *
      * @param {Credal.CreateConversationRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -70,7 +135,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.9",
+                    "X-Fern-SDK-Version": "0.0.11",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -134,7 +199,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.9",
+                    "X-Fern-SDK-Version": "0.0.11",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -191,7 +256,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.9",
+                    "X-Fern-SDK-Version": "0.0.11",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -230,6 +295,246 @@ class Copilots {
             }
         });
     }
+    /**
+     * Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     *
+     * @param {Credal.AddCollectionToCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.addCollectionToCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    addCollectionToCopilot(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/addCollectionToCopilot"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.11",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.AddCollectionToCopilotRequest.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;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     *
+     * @param {Credal.RemoveCollectionFromCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.removeCollectionFromCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    removeCollectionFromCopilot(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/removeCollectionFromCopilot"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.11",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.RemoveCollectionFromCopilotRequest.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;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Update the configuration for a copilot
+     *
+     * @param {Credal.UpdateConfigurationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.updateConfiguration({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         configuration: {
+     *             name: "Customer Copilot",
+     *             description: "This copilot is used to answer customer requests based on internal documentation.",
+     *             prompt: "You are a polite, helpful assistant used to answer customer requests.",
+     *             aiEndpointConfiguration: {
+     *                 baseUrl: "https://api.openai.com/v1/",
+     *                 apiKey: "<YOUR_API_KEY_HERE>"
+     *             }
+     *         }
+     *     })
+     */
+    updateConfiguration(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/updateConfiguration"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.11",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.UpdateConfigurationRequest.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;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * @param {Credal.DeleteCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.deleteCopilot({
+     *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+     *     })
+     */
+    deleteCopilot(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/deleteCopilot"),
+                method: "DELETE",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.11",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.DeleteCopilotRequest.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.DeleteCopilotResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {

package/api/resources/copilots/client/requests/AddCollectionToCopilotRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+ *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+ *     }
+ */
+export interface AddCollectionToCopilotRequest {
+    /**
+     * Credal-generated copilot ID to add the collection to.
+     *
+     */
+    copilotId: string;
+    /**
+     * Credal-generated collection ID to add.
+     *
+     */
+    collectionId: string;
+}

package/api/resources/copilots/client/requests/AddCollectionToCopilotRequest.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/client/requests/CreateConversationRequest.d.ts

@@ -10,10 +10,10 @@
  */
 export interface CreateConversationRequest {
     /**
-     * Credal-generated agent ID to specify which agent to route the request to. This is required for all new API keys going forward.
+     * Credal-generated Copilot ID to specify which agent to route the request to.
      *
      */
-    agentId?: string;
+    agentId: string;
     /**
      * End-user for the conversation.
      *

package/api/resources/copilots/client/requests/CreateCopilotRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "Customer Copilot",
+ *         description: "This copilot is used to answer customer requests based on internal documentation.",
+ *         collaborators: [{
+ *                 email: "test@gmail.com",
+ *                 role: Credal.Role.Editor
+ *             }]
+ *     }
+ */
+export interface CreateCopilotRequest {
+    /**
+     * A descriptive name for the copilot.
+     *
+     */
+    name: string;
+    /**
+     * An in depth name for the copilot's function. Useful for routing requests to the right copilot.
+     *
+     */
+    description: string;
+    /**
+     * A list of collaborator emails and roles that will have access to the copilot.
+     *
+     */
+    collaborators: Credal.Collaborator[];
+}

package/api/resources/copilots/client/requests/CreateCopilotRequest.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/client/requests/DeleteCopilotRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+ *     }
+ */
+export interface DeleteCopilotRequest {
+    /** Copilot ID */
+    id: string;
+}

package/api/resources/copilots/client/requests/DeleteCopilotRequest.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/client/requests/ProvideMessageFeedbackRequest.d.ts

@@ -16,10 +16,10 @@ import * as Credal from "../../../../index";
  */
 export interface ProvideMessageFeedbackRequest {
     /**
-     * Credal-generated agent ID to specify which agent to route the request to. This is required for all new API keys going forward.
+     * Credal-generated Copilot ID to specify which agent to route the request to.
      *
      */
-    agentId?: string;
+    agentId: string;
     /**
      * The user profile you want to use when providing feedback.
      *

package/api/resources/copilots/client/requests/RemoveCollectionFromCopilotRequest.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+ *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+ *     }
+ */
+export interface RemoveCollectionFromCopilotRequest {
+    /**
+     * Credal-generated copilot ID to add the collection to.
+     *
+     */
+    copilotId: string;
+    /**
+     * Credal-generated collection ID to add.
+     *
+     */
+    collectionId: string;
+}

package/api/resources/copilots/client/requests/RemoveCollectionFromCopilotRequest.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/client/requests/SendMessageRequest.d.ts

@@ -11,10 +11,10 @@
  */
 export interface SendMessageRequest {
     /**
-     * Credal-generated agent ID to specify which agent to route the request to. This is required for all new API keys going forward.
+     * Credal-generated Copilot ID to specify which agent to route the request to.
      *
      */
-    agentId?: string;
+    agentId: string;
     /**
      * The message you want to send to your copilot.
      *