vellum-ai 0.8.7 → 0.8.8

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

@@ -45,7 +45,7 @@ const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class TestSuiteRuns {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -72,7 +72,7 @@ class TestSuiteRuns {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/test-suite-runs"),
                 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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.TestSuiteRunCreateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -125,7 +125,7 @@ class TestSuiteRuns {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/test-suite-runs/${encodeURIComponent(id)}`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "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,
@@ -192,7 +192,7 @@ class TestSuiteRuns {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/test-suite-runs/${encodeURIComponent(id)}/executions`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",

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

@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
 export declare namespace TestSuites {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace TestSuites {
 }
 export declare class TestSuites {
     protected readonly _options: TestSuites.Options;
-    constructor(_options?: TestSuites.Options);
+    constructor(_options: TestSuites.Options);
     /**
      * List the Test Cases associated with a Test Suite
      *
@@ -74,6 +74,6 @@ export declare class TestSuites {
      */
     deleteTestSuiteTestCase(id: string, testCaseId: string, requestOptions?: TestSuites.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string | undefined;
+        X_API_KEY: string;
     }>;
 }

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

@@ -45,7 +45,7 @@ const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
 class TestSuites {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -73,7 +73,7 @@ class TestSuites {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -142,7 +142,7 @@ class TestSuites {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases`),
                 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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.UpsertTestSuiteTestCaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -189,7 +189,7 @@ class TestSuites {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases-bulk`),
                 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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.testSuites.testSuiteTestCasesBulk.Request.jsonOrThrow(request, {
@@ -256,7 +256,7 @@ class TestSuites {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases/${encodeURIComponent(testCaseId)}`),
                 method: "DELETE",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "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,

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

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

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

@@ -45,7 +45,7 @@ const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization/index"));
 const errors = __importStar(require("../../../../errors/index"));
 class WorkflowDeployments {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -78,7 +78,7 @@ class WorkflowDeployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/workflow-deployments"),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -131,7 +131,7 @@ class WorkflowDeployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/workflow-deployments/${encodeURIComponent(id)}`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "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,
@@ -184,7 +184,7 @@ class WorkflowDeployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/workflow-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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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,
@@ -238,7 +238,7 @@ class WorkflowDeployments {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/workflow-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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.PatchedWorkflowReleaseTagUpdateRequest.jsonOrThrow(request, {

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

@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
 export declare namespace WorkflowSandboxes {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace WorkflowSandboxes {
 }
 export declare class WorkflowSandboxes {
     protected readonly _options: WorkflowSandboxes.Options;
-    constructor(_options?: WorkflowSandboxes.Options);
+    constructor(_options: WorkflowSandboxes.Options);
     /**
      * @param {string} id - A UUID string identifying this workflow sandbox.
      * @param {string} workflowId - An ID identifying the Workflow you'd like to deploy.
@@ -32,6 +32,6 @@ export declare class WorkflowSandboxes {
      */
     deployWorkflow(id: string, workflowId: string, request?: Vellum.DeploySandboxWorkflowRequest, requestOptions?: WorkflowSandboxes.RequestOptions): Promise<Vellum.WorkflowDeploymentRead>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string | undefined;
+        X_API_KEY: string;
     }>;
 }

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

@@ -45,7 +45,7 @@ const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class WorkflowSandboxes {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -64,7 +64,7 @@ class WorkflowSandboxes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/workflow-sandboxes/${encodeURIComponent(id)}/workflows/${encodeURIComponent(workflowId)}/deploy`),
                 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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.DeploySandboxWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/api/types/AdHocExpandMetaRequest.d.ts

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface AdHocExpandMetaRequest {
+    /** If enabled, the response will include model host cost tracking. This may increase latency for some model hosts. */
     cost?: boolean;
     /** If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt. */
     modelName?: boolean;

package/api/types/Price.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export interface Price {
+    value: number;
+    unit: Vellum.UnitEnum;
+}

package/api/types/Price.js

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

package/api/types/PromptDeploymentExpandMetaRequest.d.ts

@@ -6,6 +6,8 @@ export interface PromptDeploymentExpandMetaRequest {
     modelName?: boolean;
     /** If enabled, the response will include model host usage tracking. This may increase latency for some model hosts. */
     usage?: boolean;
+    /** If enabled, the response will include model host cost tracking. This may increase latency for some model hosts. */
+    cost?: boolean;
     /** If enabled, the response will include the reason provided by the model for why the execution finished. */
     finishReason?: boolean;
     /** If enabled, the response will include the time in nanoseconds it took to execute the Prompt Deployment. */

package/api/types/PromptExecutionMeta.d.ts

@@ -12,4 +12,5 @@ export interface PromptExecutionMeta {
     promptVersionId?: string;
     finishReason?: Vellum.FinishReasonEnum;
     usage?: Vellum.MlModelUsage;
+    cost?: Vellum.Price;
 }

package/api/types/TestSuiteRunMetricJsonOutput.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Output for a test suite run metric that is of type NUMBER
+ */
+export interface TestSuiteRunMetricJsonOutput {
+    value?: unknown;
+    type: "JSON";
+    name: string;
+}

package/api/types/TestSuiteRunMetricJsonOutput.js

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

package/api/types/TestSuiteRunMetricOutput.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../index";
-export declare type TestSuiteRunMetricOutput = Vellum.TestSuiteRunMetricStringOutput | Vellum.TestSuiteRunMetricNumberOutput | Vellum.TestSuiteRunMetricErrorOutput;
+export declare type TestSuiteRunMetricOutput = Vellum.TestSuiteRunMetricStringOutput | Vellum.TestSuiteRunMetricNumberOutput | Vellum.TestSuiteRunMetricJsonOutput | Vellum.TestSuiteRunMetricErrorOutput;

package/api/types/UnitEnum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * - `USD` - USD
+ */
+export declare type UnitEnum = "USD";

package/api/types/UnitEnum.js

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

package/api/types/index.d.ts

@@ -204,6 +204,7 @@ export * from "./PaginatedTestSuiteTestCaseList";
 export * from "./PdfSearchResultMetaSource";
 export * from "./PdfSearchResultMetaSourceRequest";
 export * from "./PlainTextPromptBlockRequest";
+export * from "./Price";
 export * from "./ProcessingFailureReasonEnum";
 export * from "./ProcessingStateEnum";
 export * from "./PromptBlockRequest";
@@ -330,6 +331,7 @@ export * from "./TestSuiteRunExternalExecConfigData";
 export * from "./TestSuiteRunExternalExecConfigDataRequest";
 export * from "./TestSuiteRunExternalExecConfigRequest";
 export * from "./TestSuiteRunMetricErrorOutput";
+export * from "./TestSuiteRunMetricJsonOutput";
 export * from "./TestSuiteRunMetricNumberOutput";
 export * from "./TestSuiteRunMetricOutput";
 export * from "./TestSuiteRunMetricStringOutput";
@@ -359,6 +361,7 @@ export * from "./TokenOverlappingWindowChunkerConfig";
 export * from "./TokenOverlappingWindowChunkerConfigRequest";
 export * from "./TokenOverlappingWindowChunking";
 export * from "./TokenOverlappingWindowChunkingRequest";
+export * from "./UnitEnum";
 export * from "./UploadDocumentResponse";
 export * from "./UpsertTestSuiteTestCaseRequest";
 export * from "./VariablePromptBlockRequest";

package/api/types/index.js

@@ -220,6 +220,7 @@ __exportStar(require("./PaginatedTestSuiteTestCaseList"), exports);
 __exportStar(require("./PdfSearchResultMetaSource"), exports);
 __exportStar(require("./PdfSearchResultMetaSourceRequest"), exports);
 __exportStar(require("./PlainTextPromptBlockRequest"), exports);
+__exportStar(require("./Price"), exports);
 __exportStar(require("./ProcessingFailureReasonEnum"), exports);
 __exportStar(require("./ProcessingStateEnum"), exports);
 __exportStar(require("./PromptBlockRequest"), exports);
@@ -346,6 +347,7 @@ __exportStar(require("./TestSuiteRunExternalExecConfigData"), exports);
 __exportStar(require("./TestSuiteRunExternalExecConfigDataRequest"), exports);
 __exportStar(require("./TestSuiteRunExternalExecConfigRequest"), exports);
 __exportStar(require("./TestSuiteRunMetricErrorOutput"), exports);
+__exportStar(require("./TestSuiteRunMetricJsonOutput"), exports);
 __exportStar(require("./TestSuiteRunMetricNumberOutput"), exports);
 __exportStar(require("./TestSuiteRunMetricOutput"), exports);
 __exportStar(require("./TestSuiteRunMetricStringOutput"), exports);
@@ -375,6 +377,7 @@ __exportStar(require("./TokenOverlappingWindowChunkerConfig"), exports);
 __exportStar(require("./TokenOverlappingWindowChunkerConfigRequest"), exports);
 __exportStar(require("./TokenOverlappingWindowChunking"), exports);
 __exportStar(require("./TokenOverlappingWindowChunkingRequest"), exports);
+__exportStar(require("./UnitEnum"), exports);
 __exportStar(require("./UploadDocumentResponse"), exports);
 __exportStar(require("./UpsertTestSuiteTestCaseRequest"), exports);
 __exportStar(require("./VariablePromptBlockRequest"), exports);

package/dist/Client.d.ts

@@ -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 | undefined>;
+        apiKey: core.Supplier<string>;
     }
     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.
      *
@@ -180,6 +180,6 @@ export declare class VellumClient {
     protected _workflowSandboxes: WorkflowSandboxes | undefined;
     get workflowSandboxes(): WorkflowSandboxes;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string | undefined;
+        X_API_KEY: string;
     }>;
 }

package/dist/Client.js

@@ -56,7 +56,7 @@ 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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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.7", "User-Agent": "vellum-ai/0.8.7", "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.8", "User-Agent": "vellum-ai/0.8.8", "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, {

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

@@ -17,6 +17,7 @@ import * as Vellum from "../../index";
  *         expandMeta: {
  *             modelName: true,
  *             usage: true,
+ *             cost: true,
  *             finishReason: true,
  *             latency: true,
  *             deploymentReleaseTag: true,

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

@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
 export declare namespace AdHoc {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey?: core.Supplier<string | undefined>;
+        apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,12 +20,12 @@ export declare namespace AdHoc {
 }
 export declare class AdHoc {
     protected readonly _options: AdHoc.Options;
-    constructor(_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;
+        X_API_KEY: string;
     }>;
 }

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

@@ -46,7 +46,7 @@ const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class AdHoc {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -59,7 +59,7 @@ class AdHoc {
                 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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.8", "User-Agent": "vellum-ai/0.8.8", "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" }),

package/dist/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 | undefined>;
+        apiKey: core.Supplier<string>;
     }
     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 | undefined;
+        X_API_KEY: string;
     }>;
 }