@credal/sdk 0.0.24 → 0.0.25

package/dist/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 Copilot ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * End-user for the conversation.
-     *
-     */
+    /** End-user for the conversation. */
     userEmail: string;
 }

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

@@ -14,19 +14,10 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface CreateCopilotRequest {
-    /**
-     * A descriptive name for the copilot.
-     *
-     */
+    /** 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.
-     *
-     */
+    /** 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.
-     *
-     */
+    /** A list of collaborator emails and roles that will have access to the copilot. */
     collaborators: Credal.Collaborator[];
 }

package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts

@@ -16,24 +16,12 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface ProvideMessageFeedbackRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * The user profile you want to use when providing feedback.
-     *
-     */
+    /** The user profile you want to use when providing feedback. */
     userEmail: string;
-    /**
-     * The message ID for which feedback is being provided.
-     *
-     */
+    /** The message ID for which feedback is being provided. */
     messageId: string;
-    /**
-     * The feedback provided by the user.
-     *
-     */
+    /** The feedback provided by the user. */
     messageFeedback: Credal.MessageFeedback;
 }

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

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

package/dist/api/resources/copilots/client/requests/SendMessageRequest.d.ts

@@ -18,29 +18,14 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface SendMessageRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * The message you want to send to your copilot.
-     *
-     */
+    /** The message you want to send to your copilot. */
     message: string;
-    /**
-     * The user profile you want to use when sending the message.
-     *
-     */
+    /** The user profile you want to use when sending the message. */
     userEmail: string;
-    /**
-     * Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
-     *
-     */
+    /** Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations. */
     conversationId?: string;
-    /**
-     * Optional input variables to be used in the message. Map the name of the variable to a list of urls.
-     *
-     */
+    /** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
     inputVariables?: Credal.InputVariable[];
 }

package/dist/api/resources/copilots/client/requests/StreamMessageRequest.d.ts

@@ -30,31 +30,30 @@ import * as Credal from "../../../../index";
  *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c24"]
  *             }]
  *     }
+ *
+ * @example
+ *     {
+ *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c25",
+ *         message: "Is Credal SOC 2 compliant?",
+ *         email: "ravin@credal.ai",
+ *         inputVariables: [{
+ *                 name: "input1",
+ *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
+ *             }, {
+ *                 name: "input2",
+ *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
+ *             }]
+ *     }
  */
 export interface StreamMessageRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     copilotId: string;
-    /**
-     * The message you want to send to your copilot.
-     *
-     */
+    /** The message you want to send to your copilot. */
     message: string;
-    /**
-     * The user profile you want to use when sending the message.
-     *
-     */
+    /** The user profile you want to use when sending the message. */
     email: string;
-    /**
-     * Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
-     *
-     */
+    /** Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations. */
     conversationId?: string;
-    /**
-     * Optional input variables to be used in the message. Map the name of the variable to a list of urls.
-     *
-     */
+    /** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
     inputVariables?: Credal.InputVariable[];
 }

package/dist/api/resources/copilots/client/requests/UpdateConfigurationRequest.d.ts

@@ -18,10 +18,7 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface UpdateConfigurationRequest {
-    /**
-     * Credal-generated copilot ID to add the collection to.
-     *
-     */
+    /** Credal-generated copilot ID to add the collection to. */
     copilotId: string;
     configuration: Credal.Configuration;
 }

package/dist/api/resources/copilots/types/ErrorChunk.d.ts

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

package/dist/api/resources/copilots/types/ErrorChunk.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/dist/api/resources/copilots/types/ErrorChunkData.d.ts

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

package/dist/api/resources/copilots/types/ErrorChunkData.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/dist/api/resources/copilots/types/FeedbackEnum.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type FeedbackEnum = "POSITIVE" | "NEGATIVE";
+export type FeedbackEnum = "POSITIVE" | "NEGATIVE";
 export declare const FeedbackEnum: {
     readonly Positive: "POSITIVE";
     readonly Negative: "NEGATIVE";

package/dist/api/resources/copilots/types/Filter.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 Filter = Credal.Filter.String | Credal.Filter.Number | Credal.Filter.Boolean | Credal.Filter.Datetime;
+export 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";

package/dist/api/resources/copilots/types/SendMessageResponse.d.ts

@@ -2,16 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Credal from "../../../index";
-export declare type SendMessageResponse = 
+export type SendMessageResponse = 
 /**
  * Returned when there is a reply
- * fetched from the copilot.
- *  */
+ * fetched from the copilot. */
 Credal.SendMessageResponse.AiResponseResult
 /**
  * Returned when Credal detects possible
- * infosec violations and blocks the message.
- *  */
+ * infosec violations and blocks the message. */
  | Credal.SendMessageResponse.BlockedResult;
 export declare namespace SendMessageResponse {
     interface AiResponseResult extends Credal.MessageReply {

package/dist/api/resources/copilots/types/StreamingChunk.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 StreamingChunk = Credal.StreamingChunk.Initial | Credal.StreamingChunk.DataChunk | Credal.StreamingChunk.EndOfMessage | Credal.StreamingChunk.FinalChunk | Credal.StreamingChunk.Blocked;
+export type StreamingChunk = Credal.StreamingChunk.Initial | Credal.StreamingChunk.DataChunk | Credal.StreamingChunk.EndOfMessage | Credal.StreamingChunk.FinalChunk | Credal.StreamingChunk.Blocked | Credal.StreamingChunk.ErrorChunk;
 export declare namespace StreamingChunk {
     interface Initial extends Credal.InitialChunk {
         event: "initial";
@@ -19,4 +19,7 @@ export declare namespace StreamingChunk {
     interface Blocked extends Credal.BlockedChunk {
         event: "blocked";
     }
+    interface ErrorChunk extends Credal.ErrorChunk {
+        event: "error_chunk";
+    }
 }

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

@@ -27,4 +27,6 @@ export * from "./DataChunk";
 export * from "./FinalChunk";
 export * from "./EndOfMessageChunk";
 export * from "./BlockedChunk";
+export * from "./ErrorChunkData";
+export * from "./ErrorChunk";
 export * from "./StreamingChunk";

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

@@ -43,4 +43,6 @@ __exportStar(require("./DataChunk"), exports);
 __exportStar(require("./FinalChunk"), exports);
 __exportStar(require("./EndOfMessageChunk"), exports);
 __exportStar(require("./BlockedChunk"), exports);
+__exportStar(require("./ErrorChunkData"), exports);
+__exportStar(require("./ErrorChunk"), exports);
 __exportStar(require("./StreamingChunk"), exports);

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

@@ -7,6 +7,8 @@ import * as Credal from "../../../index";
 export declare namespace DocumentCatalog {
     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,6 +19,8 @@ export declare namespace DocumentCatalog {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class DocumentCatalog {

package/dist/api/resources/documentCatalog/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) {
@@ -62,20 +72,12 @@ class DocumentCatalog {
      *     })
      */
     uploadDocumentContents(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/catalog/uploadDocumentContents"),
+                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/catalog/uploadDocumentContents"),
                 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.25", "User-Agent": "@credal/sdk/0.0.25", "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.UploadDocumentContentsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -104,7 +106,7 @@ class DocumentCatalog {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/catalog/uploadDocumentContents.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -125,20 +127,12 @@ class DocumentCatalog {
      *     })
      */
     syncSourceByUrl(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/catalog/syncSourceByUrl"),
+                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/catalog/syncSourceByUrl"),
                 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.25", "User-Agent": "@credal/sdk/0.0.25", "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.SyncSourceByUrlRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -167,7 +161,7 @@ class DocumentCatalog {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling POST /v0/catalog/syncSourceByUrl.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -208,20 +202,12 @@ class DocumentCatalog {
      *     })
      */
     metadata(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/catalog/metadata"),
+                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/catalog/metadata"),
                 method: "PATCH",
-                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.25", "User-Agent": "@credal/sdk/0.0.25", "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.DocumentMetadataPatchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -245,7 +231,7 @@ class DocumentCatalog {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.CredalTimeoutError();
+                    throw new errors.CredalTimeoutError("Timeout exceeded when calling PATCH /v0/catalog/metadata.");
                 case "unknown":
                     throw new errors.CredalError({
                         message: _response.error.errorMessage,
@@ -254,12 +240,12 @@ class DocumentCatalog {
         });
     }
     _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/dist/api/resources/documentCatalog/client/requests/UploadDocumentContentsRequest.d.ts

@@ -12,54 +12,24 @@
  *     }
  */
 export interface UploadDocumentContentsRequest {
-    /**
-     * The name of the document you want to upload.
-     *
-     */
+    /** The name of the document you want to upload. */
     documentName: string;
-    /**
-     * The full LLM-formatted text contents of the document you want to upload.
-     *
-     */
+    /** The full LLM-formatted text contents of the document you want to upload. */
     documentContents: string;
-    /**
-     * Users allowed to access the document. Unlike Credal's out of the box connectors which reconcile various permissions models from 3rd party software, for custom uploads the caller is responsible for specifying who can access the document and currently flattening groups if applicable. Documents can also be marked as internal public.
-     *
-     */
+    /** Users allowed to access the document. Unlike Credal's out of the box connectors which reconcile various permissions models from 3rd party software, for custom uploads the caller is responsible for specifying who can access the document and currently flattening groups if applicable. Documents can also be marked as internal public. */
     allowedUsersEmailAddresses: string[];
-    /**
-     * [Legacy] The user on behalf of whom the document should be uploaded. In most cases, this can simply be the email of the developer making the API call. This field will be removed in the future in favor of purely specifying permissions via allowedUsersEmailAddresses.
-     *
-     */
+    /** [Legacy] The user on behalf of whom the document should be uploaded. In most cases, this can simply be the email of the developer making the API call. This field will be removed in the future in favor of purely specifying permissions via allowedUsersEmailAddresses. */
     uploadAsUserEmail: string;
-    /**
-     * The external ID of the document. This is typically the ID as it exists in its original external system. Uploads to the same external ID will update the document in Credal.
-     *
-     */
+    /** The external ID of the document. This is typically the ID as it exists in its original external system. Uploads to the same external ID will update the document in Credal. */
     documentExternalId: string;
-    /**
-     * The external URL of the document you want to upload. If provided Credal will link to this URL.
-     *
-     */
+    /** The external URL of the document you want to upload. If provided Credal will link to this URL. */
     documentExternalUrl?: string;
-    /**
-     * Optional JSON representing any custom metdata for this document
-     *
-     */
+    /** Optional JSON representing any custom metdata for this document */
     customMetadata?: unknown;
-    /**
-     * If specified, document will also be added to a particular document collection
-     *
-     */
+    /** If specified, document will also be added to a particular document collection */
     collectionId?: string;
-    /**
-     * If specified, document contents will be re-uploaded and re-embedded even if the document already exists in Credal
-     *
-     */
+    /** If specified, document contents will be re-uploaded and re-embedded even if the document already exists in Credal */
     forceUpdate?: boolean;
-    /**
-     * If specified, document will be accessible to everyone within the organization of the uploader
-     *
-     */
+    /** If specified, document will be accessible to everyone within the organization of the uploader */
     internalPublic?: boolean;
 }

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

@@ -7,6 +7,8 @@ import * as Credal from "../../../index";
 export declare namespace DocumentCollections {
     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,6 +19,8 @@ export declare namespace DocumentCollections {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class DocumentCollections {