vellum-ai 0.0.10 → 0.0.11

package/api/types/GenerateStreamResultData.js

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

package/api/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./GenerateBodyRequest";
 export * from "./BlockTypeEnum";
 export * from "./ChatMessage";
 export * from "./ChatMessageRequest";
@@ -15,6 +16,9 @@ export * from "./GenerateResponse";
 export * from "./GenerateResult";
 export * from "./GenerateResultData";
 export * from "./GenerateResultError";
+export * from "./GenerateStreamResponse";
+export * from "./GenerateStreamResult";
+export * from "./GenerateStreamResultData";
 export * from "./IndexingStateEnum";
 export * from "./LogprobsEnum";
 export * from "./ModelTypeEnum";

package/api/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./GenerateBodyRequest"), exports);
 __exportStar(require("./BlockTypeEnum"), exports);
 __exportStar(require("./ChatMessage"), exports);
 __exportStar(require("./ChatMessageRequest"), exports);
@@ -31,6 +32,9 @@ __exportStar(require("./GenerateResponse"), exports);
 __exportStar(require("./GenerateResult"), exports);
 __exportStar(require("./GenerateResultData"), exports);
 __exportStar(require("./GenerateResultError"), exports);
+__exportStar(require("./GenerateStreamResponse"), exports);
+__exportStar(require("./GenerateStreamResult"), exports);
+__exportStar(require("./GenerateStreamResultData"), exports);
 __exportStar(require("./IndexingStateEnum"), exports);
 __exportStar(require("./LogprobsEnum"), exports);
 __exportStar(require("./ModelTypeEnum"), exports);

package/core/callback-queue/CallbackQueue.d.ts

@@ -0,0 +1,6 @@
+export declare class CallbackQueue {
+    private queue;
+    wrap<Args extends any[]>(callback: (...args: Args) => void | Promise<void>): (...args: Args) => void;
+    wrap(callback: undefined): undefined;
+    toPromise(): Promise<void>;
+}

package/core/callback-queue/CallbackQueue.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallbackQueue = void 0;
+class CallbackQueue {
+    queue = Promise.resolve();
+    wrap(callback) {
+        if (callback == null) {
+            return undefined;
+        }
+        return (...args) => {
+            this.queue = this.queue.then(() => {
+                return callback(...args);
+            });
+        };
+    }
+    toPromise() {
+        return this.queue;
+    }
+}
+exports.CallbackQueue = CallbackQueue;

package/core/callback-queue/index.d.ts

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

package/core/callback-queue/index.js

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

package/core/index.d.ts

@@ -1,3 +1,5 @@
 export * as serialization from "./schemas";
 export * from "./fetcher";
+export * from "./streaming-fetcher";
+export * from "./callback-queue";
 export * from "./form-data-utils";

package/core/index.js

@@ -29,4 +29,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serialization = void 0;
 exports.serialization = __importStar(require("./schemas"));
 __exportStar(require("./fetcher"), exports);
+__exportStar(require("./streaming-fetcher"), exports);
+__exportStar(require("./callback-queue"), exports);
 __exportStar(require("./form-data-utils"), exports);

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

@@ -0,0 +1,22 @@
+import URLSearchParams from "@ungap/url-search-params";
+import { AxiosAdapter } from "axios";
+export declare type StreamingFetchFunction = (args: StreamingFetcher.Args) => Promise<void>;
+export declare namespace StreamingFetcher {
+    interface Args {
+        url: string;
+        method: string;
+        headers?: Record<string, string | undefined>;
+        queryParameters?: URLSearchParams;
+        body?: unknown;
+        timeoutMs?: number;
+        withCredentials?: boolean;
+        adapter?: AxiosAdapter;
+        onData: (data: unknown) => void;
+        onError?: (err: unknown) => void;
+        onFinish?: () => void;
+        abortController?: AbortController;
+        responseChunkPrefix?: string;
+        terminator?: string;
+    }
+}
+export declare const streamingFetcher: StreamingFetchFunction;

package/core/streaming-fetcher/StreamingFetcher.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamingFetcher = void 0;
+const axios_1 = __importDefault(require("axios"));
+const streamingFetcher = async (args) => {
+    const headers = {};
+    if (args.body !== undefined) {
+        headers["Content-Type"] = "application/json";
+    }
+    if (args.headers != null) {
+        for (const [key, value] of Object.entries(args.headers)) {
+            if (value != null) {
+                headers[key] = value;
+            }
+        }
+    }
+    let response;
+    try {
+        response = await (0, axios_1.default)({
+            url: args.url,
+            params: args.queryParameters,
+            method: args.method,
+            headers,
+            data: args.body,
+            timeout: args.timeoutMs,
+            transitional: {
+                clarifyTimeoutError: true,
+            },
+            withCredentials: args.withCredentials,
+            signal: args.abortController?.signal,
+            responseType: "stream",
+            adapter: args.adapter,
+        });
+    }
+    catch (error) {
+        args.onError?.(error);
+        return;
+    }
+    response.data.on("data", (data) => {
+        for (const line of data.toString().split("\n")) {
+            let data = line;
+            if (args.responseChunkPrefix != null) {
+                if (!data.startsWith(args.responseChunkPrefix)) {
+                    continue;
+                }
+                data = data.substring(args.responseChunkPrefix.length);
+            }
+            try {
+                const parsed = JSON.parse(data);
+                args.onData(parsed);
+            }
+            catch (error) {
+                args.onError?.(error);
+            }
+        }
+    });
+    if (args.onFinish != null) {
+        response.data.on("end", args.onFinish);
+    }
+};
+exports.streamingFetcher = streamingFetcher;

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

@@ -0,0 +1 @@
+export { streamingFetcher, type StreamingFetcher, type StreamingFetchFunction } from "./StreamingFetcher";

package/core/streaming-fetcher/index.js

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

package/dist/Client.d.ts

@@ -17,8 +17,44 @@ export declare namespace VellumClient {
 export declare class VellumClient {
     protected readonly options: VellumClient.Options;
     constructor(options: VellumClient.Options);
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a completion using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
+    /**
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
+    generateStream(request: Vellum.GenerateBodyRequest, cb: (data: Vellum.GenerateStreamResponse) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Perform a search against a document index.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     search(request: Vellum.SearchRequestBodyRequest): Promise<Vellum.SearchResponse>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previously generated completions.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
     protected _documents: Documents | undefined;
     get documents(): Documents;

package/dist/Client.js

@@ -32,6 +32,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VellumClient = void 0;
 const environments = __importStar(require("./environments"));
 const core = __importStar(require("./core"));
+const Vellum = __importStar(require("./api"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("./serialization"));
 const errors = __importStar(require("./errors"));
@@ -44,6 +45,16 @@ class VellumClient {
     constructor(options) {
         this.options = options;
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a completion using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async generate(request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/generate"),
@@ -62,10 +73,19 @@ class VellumClient {
             });
         }
         if (_response.error.reason === "status-code") {
-            throw new errors.VellumError({
-                statusCode: _response.error.statusCode,
-                body: _response.error.body,
-            });
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new Vellum.BadRequestError(_response.error.body);
+                case 404:
+                    throw new Vellum.NotFoundError(_response.error.body);
+                case 500:
+                    throw new Vellum.InternalServerError(_response.error.body);
+                default:
+                    throw new errors.VellumError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                    });
+            }
         }
         switch (_response.error.reason) {
             case "non-json":
@@ -81,6 +101,48 @@ class VellumClient {
                 });
         }
     }
+    /**
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
+    async generateStream(request, cb, opts) {
+        const _queue = new core.CallbackQueue();
+        await core.streamingFetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, "v1/generate-stream"),
+            method: "POST",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            body: await serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+            onData: _queue.wrap(async (data) => {
+                const parsed = await serializers.GenerateStreamResponse.parse(data, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                });
+                if (parsed.ok) {
+                    cb(parsed.value);
+                }
+                else {
+                    opts?.onError?.(parsed.errors);
+                }
+            }),
+            onError: opts?.onError != null ? _queue.wrap(opts.onError) : undefined,
+            onFinish: opts?.onFinish != null ? _queue.wrap(opts.onFinish) : undefined,
+            abortController: opts?.abortController,
+        });
+    }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Perform a search against a document index.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async search(request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/search"),
@@ -99,10 +161,19 @@ class VellumClient {
             });
         }
         if (_response.error.reason === "status-code") {
-            throw new errors.VellumError({
-                statusCode: _response.error.statusCode,
-                body: _response.error.body,
-            });
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new Vellum.BadRequestError(_response.error.body);
+                case 404:
+                    throw new Vellum.NotFoundError(_response.error.body);
+                case 500:
+                    throw new Vellum.InternalServerError(_response.error.body);
+                default:
+                    throw new errors.VellumError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                    });
+            }
         }
         switch (_response.error.reason) {
             case "non-json":
@@ -118,6 +189,16 @@ class VellumClient {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previously generated completions.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async submitCompletionActuals(request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/submit-completion-actuals"),
@@ -134,10 +215,19 @@ class VellumClient {
             return;
         }
         if (_response.error.reason === "status-code") {
-            throw new errors.VellumError({
-                statusCode: _response.error.statusCode,
-                body: _response.error.body,
-            });
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new Vellum.BadRequestError(_response.error.body);
+                case 404:
+                    throw new Vellum.NotFoundError(_response.error.body);
+                case 500:
+                    throw new Vellum.InternalServerError(_response.error.body);
+                default:
+                    throw new errors.VellumError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                    });
+            }
         }
         switch (_response.error.reason) {
             case "non-json":

package/dist/api/client/requests/index.d.ts

@@ -1,3 +1,2 @@
-export { GenerateBodyRequest } from "./GenerateBodyRequest";
 export { SearchRequestBodyRequest } from "./SearchRequestBodyRequest";
 export { SubmitCompletionActualsRequest } from "./SubmitCompletionActualsRequest";

package/dist/api/errors/BadRequestError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+export declare class BadRequestError extends errors.VellumError {
+    constructor(body?: unknown);
+}

package/dist/api/errors/BadRequestError.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const errors = __importStar(require("../../errors"));
+class BadRequestError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}
+exports.BadRequestError = BadRequestError;

package/dist/api/errors/InternalServerError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+export declare class InternalServerError extends errors.VellumError {
+    constructor(body?: unknown);
+}

package/dist/api/errors/InternalServerError.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerError = void 0;
+const errors = __importStar(require("../../errors"));
+class InternalServerError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}
+exports.InternalServerError = InternalServerError;

package/dist/api/errors/NotFoundError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+export declare class NotFoundError extends errors.VellumError {
+    constructor(body?: unknown);
+}

package/dist/api/errors/NotFoundError.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const errors = __importStar(require("../../errors"));
+class NotFoundError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/dist/api/errors/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./BadRequestError";
+export * from "./NotFoundError";
+export * from "./InternalServerError";

package/dist/api/errors/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BadRequestError"), exports);
+__exportStar(require("./NotFoundError"), exports);
+__exportStar(require("./InternalServerError"), exports);

package/dist/api/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./types";
+export * from "./errors";
 export * from "./resources";
 export * from "./client";

package/dist/api/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);
 __exportStar(require("./resources"), exports);
 __exportStar(require("./client"), exports);

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

@@ -15,6 +15,23 @@ export declare namespace Documents {
 export declare class Documents {
     protected readonly options: Documents.Options;
     constructor(options: Documents.Options);
+    /**
+     *
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to list documents. Optionally filter on supported fields.
+     *
+     */
     list(request?: Vellum.DocumentsListRequest): Promise<Vellum.PaginatedSlimDocumentList>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Upload a document to be indexed and used for search.
+     *
+     * **Note:** Uses a base url of `https://documents.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     upload(contents: File | fs.ReadStream, request: Vellum.UploadDocumentBodyRequest): Promise<Vellum.UploadDocumentResponse>;
 }