vellum-ai 0.8.5 → 0.8.7

package/Client.d.ts

@@ -4,11 +4,11 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import * as Vellum from "./api/index";
+import { AdHoc } from "./api/resources/adHoc/client/Client";
 import { Deployments } from "./api/resources/deployments/client/Client";
 import { DocumentIndexes } from "./api/resources/documentIndexes/client/Client";
 import { Documents } from "./api/resources/documents/client/Client";
 import { FolderEntities } from "./api/resources/folderEntities/client/Client";
-import { MlModels } from "./api/resources/mlModels/client/Client";
 import { Sandboxes } from "./api/resources/sandboxes/client/Client";
 import { TestSuiteRuns } from "./api/resources/testSuiteRuns/client/Client";
 import { TestSuites } from "./api/resources/testSuites/client/Client";
@@ -17,7 +17,7 @@ import { WorkflowSandboxes } from "./api/resources/workflowSandboxes/client/Clie
 export declare namespace VellumClient {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -30,7 +30,7 @@ export declare namespace VellumClient {
 }
 export declare class VellumClient {
     protected readonly _options: VellumClient.Options;
-    constructor(_options: VellumClient.Options);
+    constructor(_options?: VellumClient.Options);
     /**
      * Executes a deployed Prompt and returns the result.
      *
@@ -159,6 +159,8 @@ export declare class VellumClient {
      *     })
      */
     submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
+    protected _adHoc: AdHoc | undefined;
+    get adHoc(): AdHoc;
     protected _deployments: Deployments | undefined;
     get deployments(): Deployments;
     protected _documentIndexes: DocumentIndexes | undefined;
@@ -167,8 +169,6 @@ export declare class VellumClient {
     get documents(): Documents;
     protected _folderEntities: FolderEntities | undefined;
     get folderEntities(): FolderEntities;
-    protected _mlModels: MlModels | undefined;
-    get mlModels(): MlModels;
     protected _sandboxes: Sandboxes | undefined;
     get sandboxes(): Sandboxes;
     protected _testSuiteRuns: TestSuiteRuns | undefined;
@@ -180,6 +180,6 @@ export declare class VellumClient {
     protected _workflowSandboxes: WorkflowSandboxes | undefined;
     get workflowSandboxes(): WorkflowSandboxes;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string;
+        X_API_KEY: string | undefined;
     }>;
 }

package/Client.js

@@ -45,18 +45,18 @@ const Vellum = __importStar(require("./api/index"));
 const serializers = __importStar(require("./serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("./errors/index"));
-const Client_1 = require("./api/resources/deployments/client/Client");
-const Client_2 = require("./api/resources/documentIndexes/client/Client");
-const Client_3 = require("./api/resources/documents/client/Client");
-const Client_4 = require("./api/resources/folderEntities/client/Client");
-const Client_5 = require("./api/resources/mlModels/client/Client");
+const Client_1 = require("./api/resources/adHoc/client/Client");
+const Client_2 = require("./api/resources/deployments/client/Client");
+const Client_3 = require("./api/resources/documentIndexes/client/Client");
+const Client_4 = require("./api/resources/documents/client/Client");
+const Client_5 = require("./api/resources/folderEntities/client/Client");
 const Client_6 = require("./api/resources/sandboxes/client/Client");
 const Client_7 = require("./api/resources/testSuiteRuns/client/Client");
 const Client_8 = require("./api/resources/testSuites/client/Client");
 const Client_9 = require("./api/resources/workflowDeployments/client/Client");
 const Client_10 = require("./api/resources/workflowSandboxes/client/Client");
 class VellumClient {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -86,7 +86,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/execute-prompt"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -144,7 +144,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/execute-prompt-stream"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -229,7 +229,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/execute-workflow"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -285,7 +285,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/execute-workflow-stream"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -372,7 +372,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/generate"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -433,7 +433,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/generate-stream"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -514,7 +514,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/search"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -582,7 +582,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/submit-completion-actuals"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -645,7 +645,7 @@ class VellumClient {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .predict, "v1/submit-workflow-execution-actuals"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
@@ -679,25 +679,25 @@ class VellumClient {
             }
         });
     }
+    get adHoc() {
+        var _a;
+        return ((_a = this._adHoc) !== null && _a !== void 0 ? _a : (this._adHoc = new Client_1.AdHoc(this._options)));
+    }
     get deployments() {
         var _a;
-        return ((_a = this._deployments) !== null && _a !== void 0 ? _a : (this._deployments = new Client_1.Deployments(this._options)));
+        return ((_a = this._deployments) !== null && _a !== void 0 ? _a : (this._deployments = new Client_2.Deployments(this._options)));
     }
     get documentIndexes() {
         var _a;
-        return ((_a = this._documentIndexes) !== null && _a !== void 0 ? _a : (this._documentIndexes = new Client_2.DocumentIndexes(this._options)));
+        return ((_a = this._documentIndexes) !== null && _a !== void 0 ? _a : (this._documentIndexes = new Client_3.DocumentIndexes(this._options)));
     }
     get documents() {
         var _a;
-        return ((_a = this._documents) !== null && _a !== void 0 ? _a : (this._documents = new Client_3.Documents(this._options)));
+        return ((_a = this._documents) !== null && _a !== void 0 ? _a : (this._documents = new Client_4.Documents(this._options)));
     }
     get folderEntities() {
         var _a;
-        return ((_a = this._folderEntities) !== null && _a !== void 0 ? _a : (this._folderEntities = new Client_4.FolderEntities(this._options)));
-    }
-    get mlModels() {
-        var _a;
-        return ((_a = this._mlModels) !== null && _a !== void 0 ? _a : (this._mlModels = new Client_5.MlModels(this._options)));
+        return ((_a = this._folderEntities) !== null && _a !== void 0 ? _a : (this._folderEntities = new Client_5.FolderEntities(this._options)));
     }
     get sandboxes() {
         var _a;

package/api/client/requests/ExecutePromptRequest.d.ts

@@ -24,7 +24,7 @@ export interface ExecutePromptRequest {
     /** Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment. */
     externalId?: string;
     /** An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response. */
-    expandMeta?: Vellum.PromptDeploymentExpandMetaRequestRequest;
+    expandMeta?: Vellum.PromptDeploymentExpandMetaRequest;
     /** Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models. */
     rawOverrides?: Vellum.RawPromptExecutionOverridesRequest;
     /** A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response. */

package/api/client/requests/ExecutePromptStreamRequest.d.ts

@@ -55,7 +55,7 @@ export interface ExecutePromptStreamRequest {
     /** Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment. */
     externalId?: string;
     /** An optionally specified configuration used to opt in to including additional metadata about this prompt execution in the API response. Corresponding values will be returned under the `meta` key of the API response. */
-    expandMeta?: Vellum.PromptDeploymentExpandMetaRequestRequest;
+    expandMeta?: Vellum.PromptDeploymentExpandMetaRequest;
     /** Overrides for the raw API request sent to the model host. Combined with `expand_raw`, it can be used to access new features from models. */
     rawOverrides?: Vellum.RawPromptExecutionOverridesRequest;
     /** A list of keys whose values you'd like to directly return from the JSON response of the model provider. Useful if you need lower-level info returned by model providers that Vellum would otherwise omit. Corresponding key/value pairs will be returned under the `raw` key of the API response. */

package/api/client/requests/ExecuteWorkflowRequest.d.ts

@@ -25,4 +25,6 @@ export interface ExecuteWorkflowRequest {
     releaseTag?: string;
     /** Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment. */
     externalId?: string;
+    /** Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis. */
+    metadata?: Record<string, unknown>;
 }

package/api/client/requests/ExecuteWorkflowStreamRequest.d.ts

@@ -17,7 +17,12 @@ import * as Vellum from "../../index";
  *         workflowDeploymentName: "string",
  *         releaseTag: "string",
  *         externalId: "string",
- *         eventTypes: [Vellum.WorkflowExecutionEventType.Node]
+ *         eventTypes: [Vellum.WorkflowExecutionEventType.Node],
+ *         metadata: {
+ *             "string": {
+ *                 "key": "value"
+ *             }
+ *         }
  *     }
  */
 export interface ExecuteWorkflowStreamRequest {
@@ -35,4 +40,6 @@ export interface ExecuteWorkflowStreamRequest {
     externalId?: string;
     /** Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution. */
     eventTypes?: Vellum.WorkflowExecutionEventType[];
+    /** Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis. */
+    metadata?: Record<string, unknown>;
 }

package/api/errors/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./BadRequestError";
 export * from "./ForbiddenError";
-export * from "./NotFoundError";
 export * from "./InternalServerError";
+export * from "./NotFoundError";

package/api/errors/index.js

@@ -16,5 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError"), exports);
 __exportStar(require("./ForbiddenError"), exports);
-__exportStar(require("./NotFoundError"), exports);
 __exportStar(require("./InternalServerError"), exports);
+__exportStar(require("./NotFoundError"), exports);

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Vellum from "../../../index";
+export declare namespace AdHoc {
+    interface Options {
+        environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
+        apiKey?: core.Supplier<string | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class AdHoc {
+    protected readonly _options: AdHoc.Options;
+    constructor(_options?: AdHoc.Options);
+    /**
+     * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
+     */
+    adhocExecutePromptStream(request: Vellum.AdHocExecutePromptStreamRequest, requestOptions?: AdHoc.RequestOptions): Promise<core.Stream<Vellum.AdHocExecutePromptEvent>>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        X_API_KEY: string | undefined;
+    }>;
+}

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

@@ -0,0 +1,126 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdHoc = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const Vellum = __importStar(require("../../../index"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const url_join_1 = __importDefault(require("url-join"));
+const errors = __importStar(require("../../../../errors/index"));
+class AdHoc {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
+     */
+    adhocExecutePromptStream(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/ad-hoc/execute-prompt-stream"),
+                method: "POST",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.AdHocExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                responseType: "sse",
+                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 new core.Stream({
+                    stream: _response.body,
+                    parse: (data) => __awaiter(this, void 0, void 0, function* () {
+                        return serializers.AdHocExecutePromptEvent.parseOrThrow(data, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        });
+                    }),
+                    signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    eventShape: {
+                        type: "json",
+                        messageTerminator: "\n",
+                    },
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Vellum.BadRequestError(_response.error.body);
+                    case 403:
+                        throw new Vellum.ForbiddenError(_response.error.body);
+                    case 500:
+                        throw new Vellum.InternalServerError(_response.error.body);
+                    default:
+                        throw new errors.VellumError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.VellumError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.VellumTimeoutError();
+                case "unknown":
+                    throw new errors.VellumError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    _getCustomAuthorizationHeaders() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
+            return { X_API_KEY: apiKeyValue };
+        });
+    }
+}
+exports.AdHoc = AdHoc;

package/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts

@@ -0,0 +1,65 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../../../../index";
+/**
+ * @example
+ *     {
+ *         mlModel: "string",
+ *         inputValues: [{
+ *                 key: "string",
+ *                 type: "STRING",
+ *                 value: "string"
+ *             }],
+ *         inputVariables: [{
+ *                 id: "string",
+ *                 key: "string",
+ *                 type: Vellum.VellumVariableType.String
+ *             }],
+ *         parameters: {
+ *             stop: ["string"],
+ *             temperature: 1.1,
+ *             maxTokens: 1,
+ *             topP: 1.1,
+ *             topK: 1,
+ *             frequencyPenalty: 1.1,
+ *             presencePenalty: 1.1,
+ *             logitBias: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             },
+ *             customParameters: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             }
+ *         },
+ *         blocks: [{
+ *                 blockType: "JINJA",
+ *                 properties: {
+ *                     template: "string",
+ *                     templateType: Vellum.VellumVariableType.String
+ *                 },
+ *                 id: "string",
+ *                 state: Vellum.PromptBlockState.Enabled,
+ *                 cacheConfig: {
+ *                     type: "EPHEMERAL"
+ *                 }
+ *             }],
+ *         expandMeta: {
+ *             cost: true,
+ *             modelName: true,
+ *             usage: true,
+ *             finishReason: true
+ *         }
+ *     }
+ */
+export interface AdHocExecutePromptStreamRequest {
+    mlModel: string;
+    inputValues: Vellum.PromptRequestInputRequest[];
+    inputVariables: Vellum.VellumVariableRequest[];
+    parameters: Vellum.PromptParametersRequest;
+    blocks: Vellum.PromptBlockRequest[];
+    expandMeta?: Vellum.AdHocExpandMetaRequest;
+}

package/api/resources/adHoc/client/requests/index.d.ts

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

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

@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
 export declare namespace Deployments {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace Deployments {
 }
 export declare class Deployments {
     protected readonly _options: Deployments.Options;
-    constructor(_options: Deployments.Options);
+    constructor(_options?: Deployments.Options);
     /**
      * Used to list all Prompt Deployments.
      *
@@ -95,6 +95,6 @@ export declare class Deployments {
      */
     retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentProviderPayloadResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string;
+        X_API_KEY: string | undefined;
     }>;
 }

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

@@ -46,7 +46,7 @@ const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
 class Deployments {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -79,7 +79,7 @@ class Deployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/deployments"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -132,7 +132,7 @@ class Deployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/deployments/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -185,7 +185,7 @@ class Deployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/deployments/${encodeURIComponent(id)}/release-tags/${encodeURIComponent(name)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -239,7 +239,7 @@ class Deployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/deployments/${encodeURIComponent(id)}/release-tags/${encodeURIComponent(name)}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.PatchedDeploymentReleaseTagUpdateRequest.jsonOrThrow(request, {
@@ -314,7 +314,7 @@ class Deployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/deployments/provider-payload"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "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.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {

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

@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
 export declare namespace DocumentIndexes {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace DocumentIndexes {
 }
 export declare class DocumentIndexes {
     protected readonly _options: DocumentIndexes.Options;
-    constructor(_options: DocumentIndexes.Options);
+    constructor(_options?: DocumentIndexes.Options);
     /**
      * Used to retrieve a list of Document Indexes.
      *
@@ -170,6 +170,6 @@ export declare class DocumentIndexes {
      */
     removeDocument(documentId: string, id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string;
+        X_API_KEY: string | undefined;
     }>;
 }