vellum-ai 0.14.88 → 1.0.0

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

@@ -96,7 +96,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VellumEnvironment.Production)
                     .default, "v1/document-indexes"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -147,65 +151,12 @@ class DocumentIndexes {
      *
      * @example
      *     await client.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
+     *         label: "x",
+     *         name: "x",
      *         indexingConfig: {
      *             vectorizer: {
-     *                 modelName: "hkunlp/instructor-xl",
-     *                 config: {
-     *                     instructionDomain: "",
-     *                     instructionQueryTextType: "plain_text",
-     *                     instructionDocumentTextType: "plain_text"
-     *                 }
-     *             },
-     *             chunking: {
-     *                 chunkerName: "sentence-chunker",
-     *                 chunkerConfig: {
-     *                     characterLimit: 1000,
-     *                     minOverlapRatio: 0.5
-     *                 }
-     *             }
-     *         }
-     *     })
-     *
-     * @example
-     *     await client.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             vectorizer: {
-     *                 modelName: "sentence-transformers/multi-qa-mpnet-base-dot-v1",
-     *                 config: {
-     *                     "key": "value"
-     *                 }
-     *             },
-     *             chunking: {
-     *                 chunkerName: "sentence-chunker",
-     *                 chunkerConfig: {
-     *                     characterLimit: 1000,
-     *                     minOverlapRatio: 0.5
-     *                 }
-     *             }
-     *         }
-     *     })
-     *
-     * @example
-     *     await client.documentIndexes.create({
-     *         label: "My Document Index",
-     *         name: "my-document-index",
-     *         indexingConfig: {
-     *             vectorizer: {
-     *                 config: {
-     *                     addOpenaiApiKey: true
-     *                 },
-     *                 modelName: "text-embedding-ada-002"
-     *             },
-     *             chunking: {
-     *                 chunkerName: "sentence-chunker",
-     *                 chunkerConfig: {
-     *                     characterLimit: 1000,
-     *                     minOverlapRatio: 0.5
-     *                 }
+     *                 config: {},
+     *                 modelName: "text-embedding-3-small"
      *             }
      *         }
      *     })
@@ -220,7 +171,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, "v1/document-indexes"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.DocumentIndexCreateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -282,7 +237,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -333,7 +292,7 @@ class DocumentIndexes {
      *
      * @example
      *     await client.documentIndexes.update("id", {
-     *         label: "label"
+     *         label: "x"
      *     })
      */
     update(id, request, requestOptions) {
@@ -346,7 +305,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "PUT",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.DocumentIndexUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -408,7 +371,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .documents, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -462,7 +429,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "PATCH",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.PatchedDocumentIndexUpdateRequest.jsonOrThrow(request, {
@@ -527,7 +498,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}/documents/${encodeURIComponent(documentId)}`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -581,7 +556,11 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .documents, `v1/document-indexes/${encodeURIComponent(id)}/documents/${encodeURIComponent(documentId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

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

@@ -5,65 +5,12 @@ import * as Vellum from "../../../../index";
 /**
  * @example
  *     {
- *         label: "My Document Index",
- *         name: "my-document-index",
+ *         label: "x",
+ *         name: "x",
  *         indexingConfig: {
  *             vectorizer: {
- *                 modelName: "hkunlp/instructor-xl",
- *                 config: {
- *                     instructionDomain: "",
- *                     instructionQueryTextType: "plain_text",
- *                     instructionDocumentTextType: "plain_text"
- *                 }
- *             },
- *             chunking: {
- *                 chunkerName: "sentence-chunker",
- *                 chunkerConfig: {
- *                     characterLimit: 1000,
- *                     minOverlapRatio: 0.5
- *                 }
- *             }
- *         }
- *     }
- *
- * @example
- *     {
- *         label: "My Document Index",
- *         name: "my-document-index",
- *         indexingConfig: {
- *             vectorizer: {
- *                 modelName: "sentence-transformers/multi-qa-mpnet-base-dot-v1",
- *                 config: {
- *                     "key": "value"
- *                 }
- *             },
- *             chunking: {
- *                 chunkerName: "sentence-chunker",
- *                 chunkerConfig: {
- *                     characterLimit: 1000,
- *                     minOverlapRatio: 0.5
- *                 }
- *             }
- *         }
- *     }
- *
- * @example
- *     {
- *         label: "My Document Index",
- *         name: "my-document-index",
- *         indexingConfig: {
- *             vectorizer: {
- *                 config: {
- *                     addOpenaiApiKey: true
- *                 },
- *                 modelName: "text-embedding-ada-002"
- *             },
- *             chunking: {
- *                 chunkerName: "sentence-chunker",
- *                 chunkerConfig: {
- *                     characterLimit: 1000,
- *                     minOverlapRatio: 0.5
- *                 }
+ *                 config: {},
+ *                 modelName: "text-embedding-3-small"
  *             }
  *         }
  *     }

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

@@ -5,7 +5,7 @@ import * as Vellum from "../../../../index";
 /**
  * @example
  *     {
- *         label: "label"
+ *         label: "x"
  *     }
  */
 export interface DocumentIndexUpdateRequest {

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

@@ -12,6 +12,8 @@ export declare namespace Documents {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
+        /** Override the X-API-Version header */
+        apiVersion?: core.Supplier<Vellum.ApiVersionEnum | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,6 +22,8 @@ export declare namespace Documents {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-API-Version header */
+        apiVersion?: Vellum.ApiVersionEnum | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }
@@ -84,11 +88,6 @@ export declare class Documents {
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
-     *
-     * @example
-     *     await client.documents.upload(fs.createReadStream("/path/to/your/file"), {
-     *         label: "label"
-     *     })
      */
     upload(contents: File | fs.ReadStream | Blob, request: Vellum.UploadDocumentBodyRequest, requestOptions?: Documents.RequestOptions): core.HttpResponsePromise<Vellum.UploadDocumentResponse>;
     private __upload;

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

@@ -52,8 +52,8 @@ exports.Documents = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const Vellum = __importStar(require("../../../index"));
-const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
+const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class Documents {
     constructor(_options) {
@@ -95,7 +95,11 @@ class Documents {
                 url: (0, url_join_1.default)((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VellumEnvironment.Production)
                     .default, "v1/documents"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -157,7 +161,11 @@ class Documents {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -218,7 +226,11 @@ class Documents {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .documents, `v1/documents/${encodeURIComponent(id)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -272,7 +284,11 @@ class Documents {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "PATCH",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -327,11 +343,6 @@ class Documents {
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
-     *
-     * @example
-     *     await client.documents.upload(fs.createReadStream("/path/to/your/file"), {
-     *         label: "label"
-     *     })
      */
     upload(contents, request, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__upload(contents, request, requestOptions));
@@ -363,7 +374,11 @@ class Documents {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .documents, "v1/upload-document"),
                 method: "POST",
-                headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,

package/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts

@@ -1,12 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * @example
- *     {
- *         label: "label"
- *     }
- */
 export interface UploadDocumentBodyRequest {
     /** Optionally include the names of all indexes that you'd like this document to be included in */
     addToIndexNames?: string[] | null;

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

@@ -10,6 +10,8 @@ export declare namespace FolderEntities {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
+        /** Override the X-API-Version header */
+        apiVersion?: core.Supplier<Vellum.ApiVersionEnum | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -18,6 +20,8 @@ export declare namespace FolderEntities {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-API-Version header */
+        apiVersion?: Vellum.ApiVersionEnum | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }

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

@@ -94,7 +94,11 @@ class FolderEntities {
                 url: (0, url_join_1.default)((_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : ((_d = (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.VellumEnvironment.Production)
                     .default, "v1/folder-entities"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -166,7 +170,11 @@ class FolderEntities {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/folders/${encodeURIComponent(folderId)}/add-entity`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.AddEntityToFolderRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

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

@@ -10,6 +10,8 @@ export declare namespace MetricDefinitions {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
+        /** Override the X-API-Version header */
+        apiVersion?: core.Supplier<Vellum.ApiVersionEnum | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -18,6 +20,8 @@ export declare namespace MetricDefinitions {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-API-Version header */
+        apiVersion?: Vellum.ApiVersionEnum | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }
@@ -33,7 +37,11 @@ export declare class MetricDefinitions {
      * @example
      *     await client.metricDefinitions.executeMetricDefinition("id", {
      *         inputs: [{
-     *                 name: "name",
+     *                 name: "x",
+     *                 type: "STRING",
+     *                 value: "value"
+     *             }, {
+     *                 name: "x",
      *                 type: "STRING",
      *                 value: "value"
      *             }]

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

@@ -66,7 +66,11 @@ class MetricDefinitions {
      * @example
      *     await client.metricDefinitions.executeMetricDefinition("id", {
      *         inputs: [{
-     *                 name: "name",
+     *                 name: "x",
+     *                 type: "STRING",
+     *                 value: "value"
+     *             }, {
+     *                 name: "x",
      *                 type: "STRING",
      *                 value: "value"
      *             }]
@@ -82,7 +86,11 @@ class MetricDefinitions {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .predict, `v1/metric-definitions/${encodeURIComponent(id)}/execute`),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ExecuteMetricDefinition.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -143,7 +151,11 @@ class MetricDefinitions {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/metric-definitions/${encodeURIComponent(id)}/history/${encodeURIComponent(historyIdOrReleaseTag)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

package/api/resources/metricDefinitions/client/requests/ExecuteMetricDefinition.d.ts

@@ -6,7 +6,11 @@ import * as Vellum from "../../../../index";
  * @example
  *     {
  *         inputs: [{
- *                 name: "name",
+ *                 name: "x",
+ *                 type: "STRING",
+ *                 value: "value"
+ *             }, {
+ *                 name: "x",
  *                 type: "STRING",
  *                 value: "value"
  *             }]

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

@@ -10,6 +10,8 @@ export declare namespace MlModels {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
+        /** Override the X-API-Version header */
+        apiVersion?: core.Supplier<Vellum.ApiVersionEnum | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -18,6 +20,8 @@ export declare namespace MlModels {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-API-Version header */
+        apiVersion?: Vellum.ApiVersionEnum | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }

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

@@ -51,8 +51,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MlModels = 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/index"));
+const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class MlModels {
     constructor(_options) {
@@ -77,7 +77,11 @@ class MlModels {
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.VellumEnvironment.Production)
                     .default, `v1/ml-models/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.14.88", "User-Agent": "vellum-ai/0.14.88", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-API-Version": (yield core.Supplier.get(this._options.apiVersion)) != null
+                        ? serializers.ApiVersionEnum.jsonOrThrow(yield core.Supplier.get(this._options.apiVersion), {
+                            unrecognizedObjectKeys: "strip",
+                        })
+                        : "2025-07-30", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "vellum-ai/1.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

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

@@ -10,6 +10,8 @@ export declare namespace Organizations {
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
+        /** Override the X-API-Version header */
+        apiVersion?: core.Supplier<Vellum.ApiVersionEnum | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -18,6 +20,8 @@ export declare namespace Organizations {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-API-Version header */
+        apiVersion?: Vellum.ApiVersionEnum | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
     }