@credal/sdk 0.0.13 → 0.0.15

package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js

@@ -1,13 +1,4 @@
 "use strict";
-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) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.undiscriminatedUnion = void 0;
 const Schema_1 = require("../../Schema");
@@ -15,37 +6,35 @@ const maybeSkipValidation_1 = require("../../utils/maybeSkipValidation");
 const schema_utils_1 = require("../schema-utils");
 function undiscriminatedUnion(schemas) {
     const baseSchema = {
-        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+        parse: (raw, opts) => {
             return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.parse(raw, opts), schemas, opts);
-        }),
-        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () {
+        },
+        json: (parsed, opts) => {
             return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.json(parsed, opts), schemas, opts);
-        }),
+        },
         getType: () => Schema_1.SchemaType.UNDISCRIMINATED_UNION,
     };
     return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
 }
 exports.undiscriminatedUnion = undiscriminatedUnion;
 function validateAndTransformUndiscriminatedUnion(transform, schemas, opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const errors = [];
-        for (const [index, schema] of schemas.entries()) {
-            const transformed = yield transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
-            if (transformed.ok) {
-                return transformed;
-            }
-            else {
-                for (const error of transformed.errors) {
-                    errors.push({
-                        path: error.path,
-                        message: `[Variant ${index}] ${error.message}`,
-                    });
-                }
+    const errors = [];
+    for (const [index, schema] of schemas.entries()) {
+        const transformed = transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
+        if (transformed.ok) {
+            return transformed;
+        }
+        else {
+            for (const error of transformed.errors) {
+                errors.push({
+                    path: error.path,
+                    message: `[Variant ${index}] ${error.message}`,
+                });
             }
         }
-        return {
-            ok: false,
-            errors,
-        };
-    });
+    }
+    return {
+        ok: false,
+        errors,
+    };
 }

package/core/schemas/builders/union/union.js

@@ -1,13 +1,4 @@
 "use strict";
-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) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -36,7 +27,7 @@ function union(discriminant, union) {
         : discriminant.parsedDiscriminant;
     const discriminantValueSchema = (0, enum_1.enum_)((0, keys_1.keys)(union));
     const baseSchema = {
-        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+        parse: (raw, opts) => {
             return transformAndValidateUnion({
                 value: raw,
                 discriminant: rawDiscriminant,
@@ -53,8 +44,8 @@ function union(discriminant, union) {
                 transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.parse(additionalProperties, opts),
                 breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
             });
-        }),
-        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () {
+        },
+        json: (parsed, opts) => {
             return transformAndValidateUnion({
                 value: parsed,
                 discriminant: parsedDiscriminant,
@@ -71,71 +62,69 @@ function union(discriminant, union) {
                 transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.json(additionalProperties, opts),
                 breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
             });
-        }),
+        },
         getType: () => Schema_1.SchemaType.UNION,
     };
     return Object.assign(Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema)), (0, object_like_1.getObjectLikeUtils)(baseSchema));
 }
 exports.union = union;
 function transformAndValidateUnion({ value, discriminant, transformedDiscriminant, transformDiscriminantValue, getAdditionalPropertiesSchema, allowUnrecognizedUnionMembers = false, transformAdditionalProperties, breadcrumbsPrefix = [], }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!(0, isPlainObject_1.isPlainObject)(value)) {
+    if (!(0, isPlainObject_1.isPlainObject)(value)) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "object"),
+                },
+            ],
+        };
+    }
+    const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
+    if (discriminantValue == null) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: `Missing discriminant ("${discriminant}")`,
+                },
+            ],
+        };
+    }
+    const transformedDiscriminantValue = transformDiscriminantValue(discriminantValue);
+    if (!transformedDiscriminantValue.ok) {
+        return {
+            ok: false,
+            errors: transformedDiscriminantValue.errors,
+        };
+    }
+    const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
+    if (additionalPropertiesSchema == null) {
+        if (allowUnrecognizedUnionMembers) {
             return {
-                ok: false,
-                errors: [
-                    {
-                        path: breadcrumbsPrefix,
-                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "object"),
-                    },
-                ],
+                ok: true,
+                value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
             };
         }
-        const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
-        if (discriminantValue == null) {
+        else {
             return {
                 ok: false,
                 errors: [
                     {
-                        path: breadcrumbsPrefix,
-                        message: `Missing discriminant ("${discriminant}")`,
+                        path: [...breadcrumbsPrefix, discriminant],
+                        message: "Unexpected discriminant value",
                     },
                 ],
             };
         }
-        const transformedDiscriminantValue = yield transformDiscriminantValue(discriminantValue);
-        if (!transformedDiscriminantValue.ok) {
-            return {
-                ok: false,
-                errors: transformedDiscriminantValue.errors,
-            };
-        }
-        const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
-        if (additionalPropertiesSchema == null) {
-            if (allowUnrecognizedUnionMembers) {
-                return {
-                    ok: true,
-                    value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
-                };
-            }
-            else {
-                return {
-                    ok: false,
-                    errors: [
-                        {
-                            path: [...breadcrumbsPrefix, discriminant],
-                            message: "Unexpected discriminant value",
-                        },
-                    ],
-                };
-            }
-        }
-        const transformedAdditionalProperties = yield transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
-        if (!transformedAdditionalProperties.ok) {
-            return transformedAdditionalProperties;
-        }
-        return {
-            ok: true,
-            value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
-        };
-    });
+    }
+    const transformedAdditionalProperties = transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
+    if (!transformedAdditionalProperties.ok) {
+        return transformedAdditionalProperties;
+    }
+    return {
+        ok: true,
+        value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
+    };
 }

package/core/schemas/utils/getErrorMessageForIncorrectType.js

@@ -12,9 +12,13 @@ function getTypeAsString(value) {
     if (value === null) {
         return "null";
     }
+    if (value instanceof BigInt) {
+        return "BigInt";
+    }
     switch (typeof value) {
         case "string":
             return `"${value}"`;
+        case "bigint":
         case "number":
         case "boolean":
         case "undefined":

package/core/schemas/utils/maybeSkipValidation.js

@@ -1,13 +1,4 @@
 "use strict";
-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) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.maybeSkipValidation = void 0;
 function maybeSkipValidation(schema) {
@@ -15,8 +6,8 @@ function maybeSkipValidation(schema) {
 }
 exports.maybeSkipValidation = maybeSkipValidation;
 function transformAndMaybeSkipValidation(transform) {
-    return (value, opts) => __awaiter(this, void 0, void 0, function* () {
-        const transformed = yield transform(value, opts);
+    return (value, opts) => {
+        const transformed = transform(value, opts);
         const { skipValidation = false } = opts !== null && opts !== void 0 ? opts : {};
         if (!transformed.ok && skipValidation) {
             // eslint-disable-next-line no-console
@@ -33,5 +24,5 @@ function transformAndMaybeSkipValidation(transform) {
         else {
             return transformed;
         }
-    });
+    };
 }

package/core/streaming-fetcher/Stream.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+import { Readable } from "stream";
+export declare namespace Stream {
+    interface Args {
+        /**
+         * The HTTP response stream to read from.
+         */
+        stream: Readable | ReadableStream;
+        /**
+         * The event shape to use for parsing the stream data.
+         */
+        eventShape: JsonEvent | SseEvent;
+        /**
+         * An abort signal to stop the stream.
+         */
+        signal?: AbortSignal;
+    }
+    interface JsonEvent {
+        type: "json";
+        messageTerminator: string;
+    }
+    interface SseEvent {
+        type: "sse";
+        streamTerminator?: string;
+    }
+}
+export declare class Stream<T> implements AsyncIterable<T> {
+    private stream;
+    private parse;
+    /**
+     * The prefix to use for each message. For example,
+     * for SSE, the prefix is "data: ".
+     */
+    private prefix;
+    private messageTerminator;
+    private streamTerminator;
+    private controller;
+    constructor({ stream, parse, eventShape, signal }: Stream.Args & {
+        parse: (val: unknown) => Promise<T>;
+    });
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+    private decodeChunk;
+}
+/**
+ * Browser polyfill for ReadableStream
+ */
+export declare function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T>;

package/core/streaming-fetcher/Stream.js

@@ -0,0 +1,170 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readableStreamAsyncIterable = exports.Stream = void 0;
+const runtime_1 = require("../runtime");
+const DATA_PREFIX = "data:";
+class Stream {
+    constructor({ stream, parse, eventShape, signal }) {
+        this.controller = new AbortController();
+        this.stream = stream;
+        this.parse = parse;
+        if (eventShape.type === "sse") {
+            this.prefix = DATA_PREFIX;
+            this.messageTerminator = "\n";
+            this.streamTerminator = eventShape.streamTerminator;
+        }
+        else {
+            this.messageTerminator = eventShape.messageTerminator;
+        }
+        signal === null || signal === void 0 ? void 0 : signal.addEventListener("abort", () => this.controller.abort());
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            var e_1, _a;
+            this.controller.signal;
+            const stream = readableStreamAsyncIterable(this.stream);
+            let buf = "";
+            let prefixSeen = false;
+            try {
+                for (var stream_1 = __asyncValues(stream), stream_1_1; stream_1_1 = yield __await(stream_1.next()), !stream_1_1.done;) {
+                    const chunk = stream_1_1.value;
+                    buf += this.decodeChunk(chunk);
+                    let terminatorIndex;
+                    // Parse the chunk into as many messages as possible
+                    while ((terminatorIndex = buf.indexOf(this.messageTerminator)) >= 0) {
+                        // Extract the line from the buffer
+                        let line = buf.slice(0, terminatorIndex + 1);
+                        buf = buf.slice(terminatorIndex + 1);
+                        // Skip empty lines
+                        if (line.length === 0) {
+                            continue;
+                        }
+                        // Skip the chunk until the prefix is found
+                        if (!prefixSeen && this.prefix != null) {
+                            const prefixIndex = line.indexOf(this.prefix);
+                            if (prefixIndex === -1) {
+                                continue;
+                            }
+                            prefixSeen = true;
+                            line = line.slice(prefixIndex + this.prefix.length);
+                        }
+                        // If the stream terminator is present, return
+                        if (this.streamTerminator != null && line.includes(this.streamTerminator)) {
+                            return yield __await(void 0);
+                        }
+                        // Otherwise, yield message from the prefix to the terminator
+                        const message = yield __await(this.parse(JSON.parse(line)));
+                        yield yield __await(message);
+                        prefixSeen = false;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (stream_1_1 && !stream_1_1.done && (_a = stream_1.return)) yield __await(_a.call(stream_1));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var e_2, _b;
+            try {
+                for (var _c = __asyncValues(this.iterMessages()), _d; _d = yield __await(_c.next()), !_d.done;) {
+                    const message = _d.value;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_d && !_d.done && (_b = _c.return)) yield __await(_b.call(_c));
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        });
+    }
+    decodeChunk(chunk) {
+        let decoded = "";
+        // If TextDecoder is present, use it
+        if (typeof TextDecoder !== "undefined") {
+            const decoder = new TextDecoder("utf8");
+            decoded += decoder.decode(chunk);
+        }
+        // Buffer is present in Node.js environment
+        else if (runtime_1.RUNTIME.type === "node" && typeof chunk != "undefined") {
+            decoded += Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+        }
+        return decoded;
+    }
+}
+exports.Stream = Stream;
+/**
+ * Browser polyfill for ReadableStream
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function readableStreamAsyncIterable(stream) {
+    if (stream[Symbol.asyncIterator]) {
+        return stream;
+    }
+    const reader = stream.getReader();
+    return {
+        next() {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const result = yield reader.read();
+                    if (result === null || result === void 0 ? void 0 : result.done) {
+                        reader.releaseLock();
+                    } // release lock when stream becomes closed
+                    return result;
+                }
+                catch (e) {
+                    reader.releaseLock(); // release lock when stream becomes errored
+                    throw e;
+                }
+            });
+        },
+        return() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const cancelPromise = reader.cancel();
+                reader.releaseLock();
+                yield cancelPromise;
+                return { done: true, value: undefined };
+            });
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+    };
+}
+exports.readableStreamAsyncIterable = readableStreamAsyncIterable;

package/core/streaming-fetcher/index.d.ts

@@ -0,0 +1 @@
+export { Stream } from "./Stream";

package/core/streaming-fetcher/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stream = void 0;
+var Stream_1 = require("./Stream");
+Object.defineProperty(exports, "Stream", { enumerable: true, get: function () { return Stream_1.Stream; } });

package/dist/Client.d.ts

@@ -16,8 +16,11 @@ export declare namespace CredalClient {
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }

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

@@ -4,3 +4,4 @@ export * from "./Url";
 export * from "./ResourceType";
 export * from "./Collaborator";
 export * from "./Role";
+export * from "./Operator";

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

@@ -20,3 +20,4 @@ __exportStar(require("./Url"), exports);
 __exportStar(require("./ResourceType"), exports);
 __exportStar(require("./Collaborator"), exports);
 __exportStar(require("./Role"), exports);
+__exportStar(require("./Operator"), exports);

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

@@ -11,8 +11,11 @@ export declare namespace Copilots {
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -26,12 +29,12 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.createCopilot({
+     *     await client.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
+     *                 role: "editor"
      *             }]
      *     })
      */
@@ -43,7 +46,7 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.createConversation({
+     *     await client.copilots.createConversation({
      *         agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         userEmail: "ravin@credal.ai"
      *     })
@@ -54,12 +57,12 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.provideMessageFeedback({
+     *     await client.copilots.provideMessageFeedback({
      *         userEmail: "ravin@credal.ai",
      *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
      *         agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         messageFeedback: {
-     *             feedback: Credal.FeedbackEnum.Negative,
+     *             feedback: "NEGATIVE",
      *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
      *         }
      *     })
@@ -70,13 +73,24 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.sendMessage({
+     *     await client.copilots.sendMessage({
      *         agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         message: "Is Credal SOC 2 compliant?",
-     *         userEmail: "ravin@credal.ai"
+     *         userEmail: "ravin@credal.ai",
+     *         inputVariables: [{
+     *                 name: "input1",
+     *                 urls: ["https://drive.google.com/file/d/123456/view"]
+     *             }, {
+     *                 name: "input2",
+     *                 urls: ["https://drive.google.com/file/d/123457/view", "https://drive.google.com/file/d/123458/view"]
+     *             }]
      *     })
      */
     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.
+     */
+    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.
      *
@@ -84,7 +98,7 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.addCollectionToCopilot({
+     *     await client.copilots.addCollectionToCopilot({
      *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
      *     })
@@ -97,7 +111,7 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.removeCollectionFromCopilot({
+     *     await client.copilots.removeCollectionFromCopilot({
      *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
      *     })
@@ -110,7 +124,7 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.updateConfiguration({
+     *     await client.copilots.updateConfiguration({
      *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
      *         configuration: {
      *             name: "Customer Copilot",
@@ -129,7 +143,7 @@ export declare class Copilots {
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await credal.copilots.deleteCopilot({
+     *     await client.copilots.deleteCopilot({
      *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
      *     })
      */