@credal/sdk 0.0.24 → 0.0.26

package/Client.d.ts

@@ -12,6 +12,8 @@ import { Users } from "./api/resources/users/client/Client";
 export declare namespace CredalClient {
     interface Options {
         environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -22,21 +24,23 @@ export declare namespace CredalClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class CredalClient {
     protected readonly _options: CredalClient.Options;
-    constructor(_options?: CredalClient.Options);
     protected _copilots: Copilots | undefined;
-    get copilots(): Copilots;
     protected _documentCatalog: DocumentCatalog | undefined;
-    get documentCatalog(): DocumentCatalog;
     protected _documentCollections: DocumentCollections | undefined;
-    get documentCollections(): DocumentCollections;
     protected _permissionsService: PermissionsService | undefined;
-    get permissionsService(): PermissionsService;
     protected _search: Search | undefined;
-    get search(): Search;
     protected _users: Users | undefined;
+    constructor(_options?: CredalClient.Options);
+    get copilots(): Copilots;
+    get documentCatalog(): DocumentCatalog;
+    get documentCollections(): DocumentCollections;
+    get permissionsService(): PermissionsService;
+    get search(): Search;
     get users(): Users;
 }

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Operator = "<" | ">" | "<=" | ">=" | "!=" | "==" | "contains";
+export type Operator = "<" | ">" | "<=" | ">=" | "!=" | "==" | "contains";
 export declare const Operator: {
     readonly LessThan: "<";
     readonly GreaterThan: ">";

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

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Credal from "../../../index";
-export declare type ResourceIdentifier = Credal.ResourceIdentifier.ExternalResourceId | Credal.ResourceIdentifier.Url;
+export type ResourceIdentifier = Credal.ResourceIdentifier.ExternalResourceId | Credal.ResourceIdentifier.Url;
 export declare namespace ResourceIdentifier {
     interface ExternalResourceId extends Credal.ExternalResourceId {
         type: "external-resource-id";

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ResourceType = "GOOGLE_DRIVE_ITEM" | "MICROSOFT_DRIVE_ITEM" | "ZENDESK_TICKET" | "ZENDESK_ARTICLE" | "ZENDESK_GROUP" | "ZENDESK_ARTICLE_SECTION" | "ZENDESK_ARTICLE_CATEGORY" | "CONFLUENCE_PAGE" | "CONFLUENCE_SPACE" | "JIRA_TICKET" | "JIRA_PROJECT" | "SALESFORCE_TASK" | "BOX_FILE" | "BOX_FOLDER" | "NOTION_PAGE" | "NOTION_DATABASE" | "SLACK_CHANNEL" | "MONGO_COLLECTION_SYNC" | "UNKNOWN";
+export type ResourceType = "GOOGLE_DRIVE_ITEM" | "MICROSOFT_DRIVE_ITEM" | "ZENDESK_TICKET" | "ZENDESK_ARTICLE" | "ZENDESK_GROUP" | "ZENDESK_ARTICLE_SECTION" | "ZENDESK_ARTICLE_CATEGORY" | "CONFLUENCE_PAGE" | "CONFLUENCE_SPACE" | "JIRA_TICKET" | "JIRA_PROJECT" | "SALESFORCE_TASK" | "BOX_FILE" | "BOX_FOLDER" | "NOTION_PAGE" | "NOTION_DATABASE" | "SLACK_CHANNEL" | "MONGO_COLLECTION_SYNC" | "UNKNOWN";
 export declare const ResourceType: {
     readonly GoogleDriveItem: "GOOGLE_DRIVE_ITEM";
     readonly MicrosoftDriveItem: "MICROSOFT_DRIVE_ITEM";

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

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

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

@@ -7,6 +7,8 @@ import * as Credal from "../../../index";
 export declare namespace Copilots {
     interface Options {
         environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<core.BearerToken | undefined>;
         fetcher?: core.FetchFunction;
     }
@@ -17,21 +19,23 @@ export declare namespace Copilots {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Copilots {
     protected readonly _options: Copilots.Options;
     constructor(_options?: Copilots.Options);
     /**
-     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     * Create a new agent. The API key used will be added to the agent for future Requests
      *
      * @param {Credal.CreateCopilotRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.copilots.createCopilot({
-     *         name: "Customer Copilot",
-     *         description: "This copilot is used to answer customer requests based on internal documentation.",
+     *         name: "Customer Agent",
+     *         description: "This agent is used to answer customer requests based on internal documentation.",
      *         collaborators: [{
      *                 email: "test@gmail.com",
      *                 role: "editor"
@@ -40,7 +44,7 @@ export declare class Copilots {
      */
     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.
+     * OPTIONAL. Create a new conversation with the Agent. 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.
@@ -89,11 +93,11 @@ export declare class Copilots {
      */
     sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.SendAgentMessageResponse>;
     /**
-     * This endpoint allows you to send a message to a specific copilot and get the response back as a streamed set of Server-Sent Events.
+     * This endpoint allows you to send a message to a specific agent and get the response back as a streamed set of Server-Sent Events.
      */
     streamMessage(request: Credal.StreamMessageRequest, requestOptions?: Copilots.RequestOptions): Promise<core.Stream<Credal.StreamingChunk>>;
     /**
-     * Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     * Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
      *
      * @param {Credal.AddCollectionToCopilotRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -106,7 +110,7 @@ export declare class Copilots {
      */
     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.
+     * Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
      *
      * @param {Credal.RemoveCollectionFromCopilotRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -119,7 +123,7 @@ export declare class Copilots {
      */
     removeCollectionFromCopilot(request: Credal.RemoveCollectionFromCopilotRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
     /**
-     * Update the configuration for a copilot
+     * Update the configuration for a agent
      *
      * @param {Credal.UpdateConfigurationRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,8 +132,8 @@ export declare class Copilots {
      *     await client.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.",
+     *             name: "Customer Agent",
+     *             description: "This agent 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/",

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

@@ -18,13 +18,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -49,15 +59,15 @@ class Copilots {
         this._options = _options;
     }
     /**
-     * Create a new copilot. The API key used will be added to the copilot for future Requests
+     * Create a new agent. The API key used will be added to the agent for future Requests
      *
      * @param {Credal.CreateCopilotRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.copilots.createCopilot({
-     *         name: "Customer Copilot",
-     *         description: "This copilot is used to answer customer requests based on internal documentation.",
+     *         name: "Customer Agent",
+     *         description: "This agent is used to answer customer requests based on internal documentation.",
      *         collaborators: [{
      *                 email: "test@gmail.com",
      *                 role: "editor"
@@ -65,20 +75,12 @@ class Copilots {
      *     })
      */
     createCopilot(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CreateCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -107,7 +109,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/createCopilot.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -116,7 +118,7 @@ class Copilots {
         });
     }
     /**
-     * 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.
+     * OPTIONAL. Create a new conversation with the Agent. 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.
@@ -128,20 +130,12 @@ class Copilots {
      *     })
      */
     createConversation(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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/createConversation"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/copilots/createConversation"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CreateConversationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -170,7 +164,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/createConversation.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -195,20 +189,12 @@ class Copilots {
      *     })
      */
     provideMessageFeedback(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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/provideMessageFeedback"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/copilots/provideMessageFeedback"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ProvideMessageFeedbackRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -232,7 +218,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/provideMessageFeedback.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -259,20 +245,12 @@ class Copilots {
      *     })
      */
     sendMessage(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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/sendMessage"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/copilots/sendMessage"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.SendMessageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -301,7 +279,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/sendMessage.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -310,23 +288,15 @@ class Copilots {
         });
     }
     /**
-     * This endpoint allows you to send a message to a specific copilot and get the response back as a streamed set of Server-Sent Events.
+     * This endpoint allows you to send a message to a specific agent and get the response back as a streamed set of Server-Sent Events.
      */
     streamMessage(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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/streamMessage"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CredalEnvironment.Production, "/v0/copilots/streamMessage"),
                 method: "POST",
-                headers: {
-                    Authorization: yield this._getAuthorizationHeader(),
-                    "X-Fern-Language": "JavaScript",
-                    "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.StreamMessageRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -366,7 +336,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/streamMessage.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -375,7 +345,7 @@ class Copilots {
         });
     }
     /**
-     * Link a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     * Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
      *
      * @param {Credal.AddCollectionToCopilotRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -387,20 +357,12 @@ class Copilots {
      *     })
      */
     addCollectionToCopilot(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.AddCollectionToCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -424,7 +386,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/addCollectionToCopilot.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -433,7 +395,7 @@ class Copilots {
         });
     }
     /**
-     * Unlink a collection with a copilot. The API Key used must be added to both the collection and the copilot beforehand.
+     * Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
      *
      * @param {Credal.RemoveCollectionFromCopilotRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -445,20 +407,12 @@ class Copilots {
      *     })
      */
     removeCollectionFromCopilot(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.RemoveCollectionFromCopilotRequest.jsonOrThrow(request, {
@@ -484,7 +438,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/removeCollectionFromCopilot.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -493,7 +447,7 @@ class Copilots {
         });
     }
     /**
-     * Update the configuration for a copilot
+     * Update the configuration for a agent
      *
      * @param {Credal.UpdateConfigurationRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -502,8 +456,8 @@ class Copilots {
      *     await client.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.",
+     *             name: "Customer Agent",
+     *             description: "This agent 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/",
@@ -513,20 +467,12 @@ class Copilots {
      *     })
      */
     updateConfiguration(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.UpdateConfigurationRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -550,7 +496,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/copilots/updateConfiguration.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -568,20 +514,12 @@ class Copilots {
      *     })
      */
     deleteCopilot(request, requestOptions) {
-        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             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"),
+                url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : 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.24",
-                    "User-Agent": "@credal/sdk/0.0.24",
-                    "X-Fern-Runtime": core.RUNTIME.type,
-                    "X-Fern-Runtime-Version": core.RUNTIME.version,
-                },
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@credal/sdk", "X-Fern-SDK-Version": "0.0.26", "User-Agent": "@credal/sdk/0.0.26", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.DeleteCopilotRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -610,7 +548,7 @@ class Copilots {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling DELETE /v0/copilots/deleteCopilot.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -619,12 +557,12 @@ class Copilots {
         });
     }
     _getAuthorizationHeader() {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const bearer = (_a = (yield core.Supplier.get(this._options.apiKey))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["CREDAL_API_KEY"];
             if (bearer == null) {
                 throw new errors.CredalError({
-                    message: "Please specify CREDAL_API_KEY when instantiating the client.",
+                    message: "Please specify a bearer by either passing it in to the constructor or initializing a CREDAL_API_KEY environment variable",
                 });
             }
             return `Bearer ${bearer}`;

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

@@ -9,14 +9,8 @@
  *     }
  */
 export interface AddCollectionToCopilotRequest {
-    /**
-     * Credal-generated copilot ID to add the collection to.
-     *
-     */
+    /** Credal-generated Agent ID to add the collection to. */
     copilotId: string;
-    /**
-     * Credal-generated collection ID to add.
-     *
-     */
+    /** Credal-generated collection ID to add. */
     collectionId: string;
 }

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

@@ -9,14 +9,8 @@
  *     }
  */
 export interface CreateConversationRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Agent ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * End-user for the conversation.
-     *
-     */
+    /** End-user for the conversation. */
     userEmail: string;
 }