vellum-ai 0.14.88 → 1.0.0

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

@@ -10,6 +10,8 @@ export declare namespace WorkspaceSecrets {
         /** 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 WorkspaceSecrets {
         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/dist/api/resources/workspaceSecrets/client/Client.js

@@ -51,8 +51,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkspaceSecrets = 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 WorkspaceSecrets {
     constructor(_options) {
@@ -77,7 +77,11 @@ class WorkspaceSecrets {
                 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/workspace-secrets/${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,
@@ -139,7 +143,11 @@ class WorkspaceSecrets {
                 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/workspace-secrets/${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.PatchedWorkspaceSecretUpdateRequest.jsonOrThrow(request, {

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

@@ -10,6 +10,8 @@ export declare namespace Workspaces {
         /** 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 Workspaces {
         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/dist/api/resources/workspaces/client/Client.js

@@ -51,8 +51,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Workspaces = 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 Workspaces {
     constructor(_options) {
@@ -76,7 +76,11 @@ class Workspaces {
                 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/workspaces/identity"),
                 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/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.88";
+export declare const SDK_VERSION = "1.0.0";

package/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.14.88";
+exports.SDK_VERSION = "1.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vellum-ai",
-    "version": "0.14.88",
+    "version": "1.0.0",
     "private": false,
     "repository": "https://github.com/vellum-ai/vellum-client-node",
     "license": "MIT",

package/reference.md

@@ -35,6 +35,9 @@ await client.submitWorkflowExecutionActuals({
         {
             outputType: "STRING",
         },
+        {
+            outputType: "STRING",
+        },
     ],
 });
 ```
@@ -89,17 +92,27 @@ await client.submitWorkflowExecutionActuals({
 
 ```typescript
 await client.adHoc.adhocExecutePrompt({
-    mlModel: "ml_model",
+    mlModel: "x",
     inputValues: [
         {
-            key: "key",
+            key: "x",
+            type: "STRING",
+            value: "value",
+        },
+        {
+            key: "x",
             type: "STRING",
             value: "value",
         },
     ],
     inputVariables: [
         {
-            id: "id",
+            id: "x",
+            key: "key",
+            type: "STRING",
+        },
+        {
+            id: "x",
             key: "key",
             type: "STRING",
         },
@@ -110,6 +123,10 @@ await client.adHoc.adhocExecutePrompt({
             blockType: "JINJA",
             template: "template",
         },
+        {
+            blockType: "JINJA",
+            template: "template",
+        },
     ],
 });
 ```
@@ -160,17 +177,27 @@ await client.adHoc.adhocExecutePrompt({
 
 ```typescript
 const response = await client.adHoc.adhocExecutePromptStream({
-    mlModel: "ml_model",
+    mlModel: "x",
     inputValues: [
         {
-            key: "key",
+            key: "x",
+            type: "STRING",
+            value: "value",
+        },
+        {
+            key: "x",
             type: "STRING",
             value: "value",
         },
     ],
     inputVariables: [
         {
-            id: "id",
+            id: "x",
+            key: "key",
+            type: "STRING",
+        },
+        {
+            id: "x",
             key: "key",
             type: "STRING",
         },
@@ -181,6 +208,10 @@ const response = await client.adHoc.adhocExecutePromptStream({
             blockType: "JINJA",
             template: "template",
         },
+        {
+            blockType: "JINJA",
+            template: "template",
+        },
     ],
 });
 for await (const item of response) {
@@ -402,9 +433,9 @@ await client.containerImages.dockerServiceToken();
 
 ```typescript
 await client.containerImages.pushContainerImage({
-    name: "name",
-    sha: "sha",
-    tags: ["tags"],
+    name: "x",
+    sha: "x",
+    tags: ["tags", "tags"],
 });
 ```
 
@@ -972,7 +1003,12 @@ We encourage you to seek advise from Vellum Support before integrating with this
 await client.deployments.retrieveProviderPayload({
     inputs: [
         {
-            name: "name",
+            name: "x",
+            type: "STRING",
+            value: "value",
+        },
+        {
+            name: "x",
             type: "STRING",
             value: "value",
         },
@@ -1106,23 +1142,12 @@ Creates a new document index.
 
 ```typescript
 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,
-            },
+            config: {},
+            modelName: "text-embedding-3-small",
         },
     },
 });
@@ -1252,7 +1277,7 @@ Used to fully update a Document Index given its ID or name.
 
 ```typescript
 await client.documentIndexes.update("id", {
-    label: "label",
+    label: "x",
 });
 ```
 
@@ -1834,81 +1859,6 @@ await client.documents.partialUpdate("id");
 </dl>
 </details>
 
-<details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">upload</a>(contents, { ...params }) -> Vellum.UploadDocumentResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Upload a document to be indexed and used for search.
-
-**Note:** Uses a base url of `https://documents.vellum.ai`.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.documents.upload(fs.createReadStream("/path/to/your/file"), {
-    label: "label",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**contents:** `File | fs.ReadStream | Blob`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Vellum.UploadDocumentBodyRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Documents.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## FolderEntities
 
 <details><summary><code>client.folderEntities.<a href="/src/api/resources/folderEntities/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedFolderEntityList</code></summary>
@@ -2077,7 +2027,12 @@ directory. Supported root directories include:
 await client.metricDefinitions.executeMetricDefinition("id", {
     inputs: [
         {
-            name: "name",
+            name: "x",
+            type: "STRING",
+            value: "value",
+        },
+        {
+            name: "x",
             type: "STRING",
             value: "value",
         },
@@ -2409,7 +2364,12 @@ await client.prompts.push({
         mlModel: "ml_model",
         inputVariables: [
             {
-                id: "id",
+                id: "x",
+                key: "key",
+                type: "STRING",
+            },
+            {
+                id: "x",
                 key: "key",
                 type: "STRING",
             },
@@ -2420,6 +2380,10 @@ await client.prompts.push({
                 blockType: "JINJA",
                 template: "template",
             },
+            {
+                blockType: "JINJA",
+                template: "template",
+            },
         ],
     },
 });
@@ -2558,17 +2522,14 @@ or overwritten with default values.
 
 ```typescript
 await client.sandboxes.upsertSandboxScenario("id", {
-    label: "Scenario 1",
     inputs: [
         {
             type: "STRING",
-            value: "Hello, world!",
-            name: "var_1",
+            name: "x",
         },
         {
             type: "STRING",
-            value: "Why hello, there!",
-            name: "var_2",
+            name: "x",
         },
     ],
 });
@@ -2984,32 +2945,24 @@ or overwritten with default values.
 
 ```typescript
 await client.testSuites.upsertTestSuiteTestCase("id", {
-    label: "Test Case 1",
     inputValues: [
         {
             type: "STRING",
-            value: "What are your favorite colors?",
-            name: "var_1",
+            name: "x",
+        },
+        {
+            type: "STRING",
+            name: "x",
         },
     ],
     evaluationValues: [
         {
-            type: "ARRAY",
-            value: [
-                {
-                    type: "STRING",
-                    value: "Red",
-                },
-                {
-                    type: "STRING",
-                    value: "Green",
-                },
-                {
-                    type: "STRING",
-                    value: "Blue",
-                },
-            ],
-            name: "var_2",
+            type: "STRING",
+            name: "x",
+        },
+        {
+            type: "STRING",
+            name: "x",
         },
     ],
 });
@@ -3091,13 +3044,47 @@ const response = await client.testSuites.testSuiteTestCasesBulk("id", [
             inputValues: [
                 {
                     type: "STRING",
-                    name: "name",
+                    name: "x",
+                },
+                {
+                    type: "STRING",
+                    name: "x",
+                },
+            ],
+            evaluationValues: [
+                {
+                    type: "STRING",
+                    name: "x",
+                },
+                {
+                    type: "STRING",
+                    name: "x",
+                },
+            ],
+        },
+    },
+    {
+        id: "id",
+        type: "CREATE",
+        data: {
+            inputValues: [
+                {
+                    type: "STRING",
+                    name: "x",
+                },
+                {
+                    type: "STRING",
+                    name: "x",
                 },
             ],
             evaluationValues: [
                 {
                     type: "STRING",
-                    name: "name",
+                    name: "x",
+                },
+                {
+                    type: "STRING",
+                    name: "x",
                 },
             ],
         },
@@ -3956,64 +3943,6 @@ await client.workflowSandboxes.listWorkflowSandboxExamples();
 
 ## Workflows
 
-<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">push</a>(artifact, { ...params }) -> Vellum.WorkflowPushResponse</code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.workflows.push(fs.createReadStream("/path/to/your/file"), {
-    execConfig: "exec_config",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**artifact:** `File | fs.ReadStream | Blob | undefined`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Vellum.WorkflowPushRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Workflows.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## WorkspaceSecrets
 
 <details><summary><code>client.workspaceSecrets.<a href="/src/api/resources/workspaceSecrets/client/Client.ts">retrieve</a>(id) -> Vellum.WorkspaceSecretRead</code></summary>

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.88";
+export declare const SDK_VERSION = "1.0.0";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.14.88";
+exports.SDK_VERSION = "1.0.0";