vellum-ai 0.6.3 → 0.6.6

package/dist/api/resources/documentIndexes/client/Client.js

@@ -42,8 +42,8 @@ exports.DocumentIndexes = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 class DocumentIndexes {
     constructor(_options) {
         this._options = _options;
@@ -51,6 +51,9 @@ class DocumentIndexes {
     /**
      * Used to retrieve a list of Document Indexes.
      *
+     * @param {Vellum.DocumentIndexesListRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documentIndexes.list()
      */
@@ -78,11 +81,12 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/document-indexes"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.PaginatedDocumentIndexReadList.parseOrThrow(_response.body, {
@@ -115,6 +119,26 @@ class DocumentIndexes {
     }
     /**
      * Creates a new document index.
+     *
+     * @param {Vellum.DocumentIndexCreateRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.create({
+     *         label: "string",
+     *         name: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development,
+     *         indexingConfig: {
+     *             vectorizer: {
+     *                 modelName: "text-embedding-3-small"
+     *             },
+     *             chunking: {
+     *                 chunkerName: "reducto-chunker"
+     *             }
+     *         },
+     *         copyDocumentsFromIndexId: "string"
+     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -123,13 +147,14 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/document-indexes"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {
@@ -162,18 +187,25 @@ class DocumentIndexes {
     }
     /**
      * Used to retrieve a Document Index given its ID or name.
+     *
+     * @param {string} id - Either the Document Index's ID or its unique name
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.retrieve("string")
      */
     retrieve(id, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/document-indexes/${id}`),
+                    .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {
@@ -206,21 +238,33 @@ class DocumentIndexes {
     }
     /**
      * Used to fully update a Document Index given its ID.
+     *
+     * @param {string} id - A UUID string identifying this document index.
+     * @param {Vellum.DocumentIndexUpdateRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.update("string", {
+     *         label: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development
+     *     })
      */
     update(id, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/document-indexes/${id}`),
+                    .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "PUT",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DocumentIndexUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {
@@ -254,6 +298,9 @@ class DocumentIndexes {
     /**
      * Used to delete a Document Index given its ID.
      *
+     * @param {string} id - A UUID string identifying this document index.
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documentIndexes.destroy("id")
      */
@@ -262,12 +309,13 @@ class DocumentIndexes {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/document-indexes/${id}`),
+                    .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return;
@@ -295,21 +343,33 @@ class DocumentIndexes {
     }
     /**
      * Used to partial update a Document Index given its ID.
+     *
+     * @param {string} id - A UUID string identifying this document index.
+     * @param {Vellum.PatchedDocumentIndexUpdateRequest} request
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.documentIndexes.partialUpdate("string", {
+     *         label: "string",
+     *         status: Vellum.EntityStatus.Active,
+     *         environment: Vellum.EnvironmentEnum.Development
+     *     })
      */
     partialUpdate(id, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/document-indexes/${id}`),
+                    .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PatchedDocumentIndexUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {

package/dist/api/resources/documentIndexes/client/requests/DocumentIndexCreateRequest.d.ts

@@ -1,7 +1,25 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
+/**
+ * @example
+ *     {
+ *         label: "string",
+ *         name: "string",
+ *         status: Vellum.EntityStatus.Active,
+ *         environment: Vellum.EnvironmentEnum.Development,
+ *         indexingConfig: {
+ *             vectorizer: {
+ *                 modelName: "text-embedding-3-small"
+ *             },
+ *             chunking: {
+ *                 chunkerName: "reducto-chunker"
+ *             }
+ *         },
+ *         copyDocumentsFromIndexId: "string"
+ *     }
+ */
 export interface DocumentIndexCreateRequest {
     /** A human-readable label for the document index */
     label: string;

package/dist/api/resources/documentIndexes/client/requests/DocumentIndexUpdateRequest.d.ts

@@ -1,7 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
+/**
+ * @example
+ *     {
+ *         label: "string",
+ *         status: Vellum.EntityStatus.Active,
+ *         environment: Vellum.EnvironmentEnum.Development
+ *     }
+ */
 export interface DocumentIndexUpdateRequest {
     /** A human-readable label for the document index */
     label: string;

package/dist/api/resources/documentIndexes/client/requests/DocumentIndexesListRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
 /**
  * @example
  *     {}

package/dist/api/resources/documentIndexes/client/requests/PatchedDocumentIndexUpdateRequest.d.ts

@@ -1,7 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
+/**
+ * @example
+ *     {
+ *         label: "string",
+ *         status: Vellum.EntityStatus.Active,
+ *         environment: Vellum.EnvironmentEnum.Development
+ *     }
+ */
 export interface PatchedDocumentIndexUpdateRequest {
     /** A human-readable label for the document index */
     label?: string;

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

@@ -1,4 +1,4 @@
-export { DocumentIndexesListRequest } from "./DocumentIndexesListRequest";
-export { DocumentIndexCreateRequest } from "./DocumentIndexCreateRequest";
-export { DocumentIndexUpdateRequest } from "./DocumentIndexUpdateRequest";
-export { PatchedDocumentIndexUpdateRequest } from "./PatchedDocumentIndexUpdateRequest";
+export { type DocumentIndexesListRequest } from "./DocumentIndexesListRequest";
+export { type DocumentIndexCreateRequest } from "./DocumentIndexCreateRequest";
+export { type DocumentIndexUpdateRequest } from "./DocumentIndexUpdateRequest";
+export { type PatchedDocumentIndexUpdateRequest } from "./PatchedDocumentIndexUpdateRequest";

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

@@ -4,7 +4,7 @@
 /// <reference types="node" />
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 import * as fs from "fs";
 export declare namespace Documents {
     interface Options {
@@ -14,6 +14,7 @@ export declare namespace Documents {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class Documents {
@@ -22,6 +23,9 @@ export declare class Documents {
     /**
      * Used to list documents. Optionally filter on supported fields.
      *
+     * @param {Vellum.DocumentsListRequest} request
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.list()
      */
@@ -29,6 +33,9 @@ export declare class Documents {
     /**
      * Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
      *
+     * @param {string} id - A UUID string identifying this document.
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.retrieve("id")
      */
@@ -36,6 +43,9 @@ export declare class Documents {
     /**
      * Delete a Document, keying off of either its Vellum-generated ID or its external ID.
      *
+     * @param {string} id - A UUID string identifying this document.
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.destroy("id")
      */
@@ -43,6 +53,10 @@ export declare class Documents {
     /**
      * Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
      *
+     * @param {string} id - A UUID string identifying this document.
+     * @param {Vellum.PatchedDocumentUpdateRequest} request
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.partialUpdate("id")
      */
@@ -59,9 +73,19 @@ export declare class Documents {
      * - `label: str` - A human-friendly name for this document. Typically the filename.
      * - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
      * - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+     *
+     * @param {File | fs.ReadStream} contents
+     * @param {Vellum.UploadDocumentBodyRequest} request
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.documents.upload(fs.createReadStream("/path/to/your/file"), {
+     *         label: "label"
+     *     })
      */
     upload(contents: File | fs.ReadStream, request: Vellum.UploadDocumentBodyRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.UploadDocumentResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/dist/api/resources/documents/client/Client.js

@@ -41,11 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Documents = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const Vellum = __importStar(require("../../.."));
+const Vellum = __importStar(require("../../../index"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
-const form_data_1 = __importDefault(require("form-data"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 class Documents {
     constructor(_options) {
         this._options = _options;
@@ -53,6 +52,9 @@ class Documents {
     /**
      * Used to list documents. Optionally filter on supported fields.
      *
+     * @param {Vellum.DocumentsListRequest} request
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.list()
      */
@@ -77,11 +79,12 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/documents"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.PaginatedSlimDocumentList.parseOrThrow(_response.body, {
@@ -115,6 +118,9 @@ class Documents {
     /**
      * Retrieve a Document, keying off of either its Vellum-generated ID or its external ID.
      *
+     * @param {string} id - A UUID string identifying this document.
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.retrieve("id")
      */
@@ -123,12 +129,13 @@ class Documents {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/documents/${id}`),
+                    .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DocumentRead.parseOrThrow(_response.body, {
@@ -162,6 +169,9 @@ class Documents {
     /**
      * Delete a Document, keying off of either its Vellum-generated ID or its external ID.
      *
+     * @param {string} id - A UUID string identifying this document.
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.destroy("id")
      */
@@ -170,12 +180,13 @@ class Documents {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/documents/${id}`),
+                    .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return;
@@ -204,6 +215,10 @@ class Documents {
     /**
      * Update a Document, keying off of either its Vellum-generated ID or its external ID. Particularly useful for updating its metadata.
      *
+     * @param {string} id - A UUID string identifying this document.
+     * @param {Vellum.PatchedDocumentUpdateRequest} request
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.documents.partialUpdate("id")
      */
@@ -212,15 +227,16 @@ class Documents {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/documents/${id}`),
+                    .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DocumentRead.parseOrThrow(_response.body, {
@@ -263,41 +279,52 @@ class Documents {
      * - `label: str` - A human-friendly name for this document. Typically the filename.
      * - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
      * - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
+     *
+     * @param {File | fs.ReadStream} contents
+     * @param {Vellum.UploadDocumentBodyRequest} request
+     * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.documents.upload(fs.createReadStream("/path/to/your/file"), {
+     *         label: "label"
+     *     })
      */
     upload(contents, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const _request = new form_data_1.default();
+            const _request = new core.FormDataWrapper();
             if (request.addToIndexNames != null) {
                 for (const _item of request.addToIndexNames) {
-                    _request.append("add_to_index_names", _item);
+                    yield _request.append("add_to_index_names", _item);
                 }
             }
             if (request.externalId != null) {
-                _request.append("external_id", request.externalId);
+                yield _request.append("external_id", request.externalId);
             }
-            _request.append("label", request.label);
-            _request.append("contents", contents);
+            yield _request.append("label", request.label);
+            yield _request.append("contents", contents);
             if (request.keywords != null) {
                 for (const _item of request.keywords) {
-                    _request.append("keywords", _item);
+                    yield _request.append("keywords", _item);
                 }
             }
             if (request.metadata != null) {
-                _request.append("metadata", request.metadata);
+                yield _request.append("metadata", request.metadata);
             }
+            const _maybeEncodedRequest = _request.getRequest();
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .documents, "v1/upload-document"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
-                contentType: "multipart/form-data; boundary=" + _request.getBoundary(),
-                body: _request,
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), (yield _maybeEncodedRequest.getHeaders())),
+                body: yield _maybeEncodedRequest.getBody(),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.UploadDocumentResponse.parseOrThrow(_response.body, {

package/dist/api/resources/documents/client/requests/PatchedDocumentUpdateRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
 /**
  * @example
  *     {}

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

@@ -1,3 +1,3 @@
-export { DocumentsListRequest } from "./DocumentsListRequest";
-export { PatchedDocumentUpdateRequest } from "./PatchedDocumentUpdateRequest";
-export { UploadDocumentBodyRequest } from "./UploadDocumentBodyRequest";
+export { type DocumentsListRequest } from "./DocumentsListRequest";
+export { type PatchedDocumentUpdateRequest } from "./PatchedDocumentUpdateRequest";
+export { type UploadDocumentBodyRequest } from "./UploadDocumentBodyRequest";

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace FolderEntities {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,6 +12,7 @@ export declare namespace FolderEntities {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class FolderEntities {
@@ -22,6 +23,10 @@ export declare class FolderEntities {
      *
      * Adding an entity to a folder will remove it from any other folders it might have been a member of.
      *
+     * @param {string} folderId - The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root directory (e.g. "PROMPT_SANDBOX").
+     * @param {Vellum.AddEntityToFolderRequest} request
+     * @param {FolderEntities.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.folderEntities.addEntityToFolder("folder_id", {
      *         entityId: "entity_id"

package/dist/api/resources/folderEntities/client/Client.js

@@ -41,9 +41,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FolderEntities = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const serializers = __importStar(require("../../../../serialization"));
+const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class FolderEntities {
     constructor(_options) {
         this._options = _options;
@@ -53,6 +53,10 @@ class FolderEntities {
      *
      * Adding an entity to a folder will remove it from any other folders it might have been a member of.
      *
+     * @param {string} folderId - The ID of the folder to which the entity should be added. This can be a UUID of a folder, or the name of a root directory (e.g. "PROMPT_SANDBOX").
+     * @param {Vellum.AddEntityToFolderRequest} request
+     * @param {FolderEntities.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.folderEntities.addEntityToFolder("folder_id", {
      *         entityId: "entity_id"
@@ -63,13 +67,14 @@ class FolderEntities {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/folders/${folderId}/add-entity`),
+                    .default, `v1/folders/${encodeURIComponent(folderId)}/add-entity`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.AddEntityToFolderRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return;

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

@@ -1 +1 @@
-export { AddEntityToFolderRequest } from "./AddEntityToFolderRequest";
+export { type AddEntityToFolderRequest } from "./AddEntityToFolderRequest";