vellum-ai 0.6.8 → 0.6.12

package/core/schemas/builders/undiscriminated-union/undiscriminatedUnion.js

@@ -1,13 +1,4 @@
 "use strict";
-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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.undiscriminatedUnion = void 0;
 const Schema_1 = require("../../Schema");
@@ -15,37 +6,35 @@ const maybeSkipValidation_1 = require("../../utils/maybeSkipValidation");
 const schema_utils_1 = require("../schema-utils");
 function undiscriminatedUnion(schemas) {
     const baseSchema = {
-        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+        parse: (raw, opts) => {
             return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.parse(raw, opts), schemas, opts);
-        }),
-        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () {
+        },
+        json: (parsed, opts) => {
             return validateAndTransformUndiscriminatedUnion((schema, opts) => schema.json(parsed, opts), schemas, opts);
-        }),
+        },
         getType: () => Schema_1.SchemaType.UNDISCRIMINATED_UNION,
     };
     return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
 }
 exports.undiscriminatedUnion = undiscriminatedUnion;
 function validateAndTransformUndiscriminatedUnion(transform, schemas, opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const errors = [];
-        for (const [index, schema] of schemas.entries()) {
-            const transformed = yield transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
-            if (transformed.ok) {
-                return transformed;
-            }
-            else {
-                for (const error of transformed.errors) {
-                    errors.push({
-                        path: error.path,
-                        message: `[Variant ${index}] ${error.message}`,
-                    });
-                }
+    const errors = [];
+    for (const [index, schema] of schemas.entries()) {
+        const transformed = transform(schema, Object.assign(Object.assign({}, opts), { skipValidation: false }));
+        if (transformed.ok) {
+            return transformed;
+        }
+        else {
+            for (const error of transformed.errors) {
+                errors.push({
+                    path: error.path,
+                    message: `[Variant ${index}] ${error.message}`,
+                });
             }
         }
-        return {
-            ok: false,
-            errors,
-        };
-    });
+    }
+    return {
+        ok: false,
+        errors,
+    };
 }

package/core/schemas/builders/union/union.js

@@ -1,13 +1,4 @@
 "use strict";
-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 __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -36,7 +27,7 @@ function union(discriminant, union) {
         : discriminant.parsedDiscriminant;
     const discriminantValueSchema = (0, enum_1.enum_)((0, keys_1.keys)(union));
     const baseSchema = {
-        parse: (raw, opts) => __awaiter(this, void 0, void 0, function* () {
+        parse: (raw, opts) => {
             return transformAndValidateUnion({
                 value: raw,
                 discriminant: rawDiscriminant,
@@ -53,8 +44,8 @@ function union(discriminant, union) {
                 transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.parse(additionalProperties, opts),
                 breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
             });
-        }),
-        json: (parsed, opts) => __awaiter(this, void 0, void 0, function* () {
+        },
+        json: (parsed, opts) => {
             return transformAndValidateUnion({
                 value: parsed,
                 discriminant: parsedDiscriminant,
@@ -71,71 +62,69 @@ function union(discriminant, union) {
                 transformAdditionalProperties: (additionalProperties, additionalPropertiesSchema) => additionalPropertiesSchema.json(additionalProperties, opts),
                 breadcrumbsPrefix: opts === null || opts === void 0 ? void 0 : opts.breadcrumbsPrefix,
             });
-        }),
+        },
         getType: () => Schema_1.SchemaType.UNION,
     };
     return Object.assign(Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema)), (0, object_like_1.getObjectLikeUtils)(baseSchema));
 }
 exports.union = union;
 function transformAndValidateUnion({ value, discriminant, transformedDiscriminant, transformDiscriminantValue, getAdditionalPropertiesSchema, allowUnrecognizedUnionMembers = false, transformAdditionalProperties, breadcrumbsPrefix = [], }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!(0, isPlainObject_1.isPlainObject)(value)) {
+    if (!(0, isPlainObject_1.isPlainObject)(value)) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "object"),
+                },
+            ],
+        };
+    }
+    const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
+    if (discriminantValue == null) {
+        return {
+            ok: false,
+            errors: [
+                {
+                    path: breadcrumbsPrefix,
+                    message: `Missing discriminant ("${discriminant}")`,
+                },
+            ],
+        };
+    }
+    const transformedDiscriminantValue = transformDiscriminantValue(discriminantValue);
+    if (!transformedDiscriminantValue.ok) {
+        return {
+            ok: false,
+            errors: transformedDiscriminantValue.errors,
+        };
+    }
+    const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
+    if (additionalPropertiesSchema == null) {
+        if (allowUnrecognizedUnionMembers) {
             return {
-                ok: false,
-                errors: [
-                    {
-                        path: breadcrumbsPrefix,
-                        message: (0, getErrorMessageForIncorrectType_1.getErrorMessageForIncorrectType)(value, "object"),
-                    },
-                ],
+                ok: true,
+                value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
             };
         }
-        const _a = value, _b = discriminant, discriminantValue = _a[_b], additionalProperties = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
-        if (discriminantValue == null) {
+        else {
             return {
                 ok: false,
                 errors: [
                     {
-                        path: breadcrumbsPrefix,
-                        message: `Missing discriminant ("${discriminant}")`,
+                        path: [...breadcrumbsPrefix, discriminant],
+                        message: "Unexpected discriminant value",
                     },
                 ],
             };
         }
-        const transformedDiscriminantValue = yield transformDiscriminantValue(discriminantValue);
-        if (!transformedDiscriminantValue.ok) {
-            return {
-                ok: false,
-                errors: transformedDiscriminantValue.errors,
-            };
-        }
-        const additionalPropertiesSchema = getAdditionalPropertiesSchema(transformedDiscriminantValue.value);
-        if (additionalPropertiesSchema == null) {
-            if (allowUnrecognizedUnionMembers) {
-                return {
-                    ok: true,
-                    value: Object.assign({ [transformedDiscriminant]: transformedDiscriminantValue.value }, additionalProperties),
-                };
-            }
-            else {
-                return {
-                    ok: false,
-                    errors: [
-                        {
-                            path: [...breadcrumbsPrefix, discriminant],
-                            message: "Unexpected discriminant value",
-                        },
-                    ],
-                };
-            }
-        }
-        const transformedAdditionalProperties = yield transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
-        if (!transformedAdditionalProperties.ok) {
-            return transformedAdditionalProperties;
-        }
-        return {
-            ok: true,
-            value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
-        };
-    });
+    }
+    const transformedAdditionalProperties = transformAdditionalProperties(additionalProperties, additionalPropertiesSchema);
+    if (!transformedAdditionalProperties.ok) {
+        return transformedAdditionalProperties;
+    }
+    return {
+        ok: true,
+        value: Object.assign({ [transformedDiscriminant]: discriminantValue }, transformedAdditionalProperties.value),
+    };
 }

package/core/schemas/utils/maybeSkipValidation.js

@@ -1,13 +1,4 @@
 "use strict";
-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());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.maybeSkipValidation = void 0;
 function maybeSkipValidation(schema) {
@@ -15,8 +6,8 @@ function maybeSkipValidation(schema) {
 }
 exports.maybeSkipValidation = maybeSkipValidation;
 function transformAndMaybeSkipValidation(transform) {
-    return (value, opts) => __awaiter(this, void 0, void 0, function* () {
-        const transformed = yield transform(value, opts);
+    return (value, opts) => {
+        const transformed = transform(value, opts);
         const { skipValidation = false } = opts !== null && opts !== void 0 ? opts : {};
         if (!transformed.ok && skipValidation) {
             // eslint-disable-next-line no-console
@@ -33,5 +24,5 @@ function transformAndMaybeSkipValidation(transform) {
         else {
             return transformed;
         }
-    });
+    };
 }

package/dist/Client.d.ts

@@ -19,8 +19,11 @@ export declare namespace VellumClient {
         apiKey: core.Supplier<string>;
     }
     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;
     }
 }
@@ -39,7 +42,7 @@ export declare class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.executePrompt({
+     *     await client.executePrompt({
      *         inputs: [{
      *                 type: "STRING",
      *                 name: "string",
@@ -94,7 +97,7 @@ export declare class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.executeWorkflow({
+     *     await client.executeWorkflow({
      *         inputs: [{
      *                 type: "STRING",
      *                 name: "string",
@@ -126,7 +129,7 @@ export declare class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.generate({
+     *     await client.generate({
      *         requests: [{
      *                 inputValues: {}
      *             }]
@@ -151,7 +154,7 @@ export declare class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.search({
+     *     await client.search({
      *         query: "query"
      *     })
      */
@@ -167,7 +170,7 @@ export declare class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.submitCompletionActuals({
+     *     await client.submitCompletionActuals({
      *         actuals: [{}]
      *     })
      */
@@ -181,7 +184,7 @@ export declare class VellumClient {
      * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.submitWorkflowExecutionActuals({
+     *     await client.submitWorkflowExecutionActuals({
      *         actuals: []
      *     })
      */

package/dist/Client.js

@@ -70,7 +70,7 @@ class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.executePrompt({
+     *     await client.executePrompt({
      *         inputs: [{
      *                 type: "STRING",
      *                 name: "string",
@@ -116,15 +116,16 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.ExecutePromptResponse.parseOrThrow(_response.body, {
+                return serializers.ExecutePromptResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -173,11 +174,10 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.ExecutePromptStreamRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.ExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 responseType: "streaming",
                 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,
@@ -187,7 +187,7 @@ class VellumClient {
                 return new core.Stream({
                     stream: _response.body,
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                        return yield serializers.ExecutePromptEvent.parseOrThrow(data, {
+                        return serializers.ExecutePromptEvent.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -244,7 +244,7 @@ class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.executeWorkflow({
+     *     await client.executeWorkflow({
      *         inputs: [{
      *                 type: "STRING",
      *                 name: "string",
@@ -263,15 +263,16 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.ExecuteWorkflowResponse.parseOrThrow(_response.body, {
+                return serializers.ExecuteWorkflowResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -318,11 +319,10 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 responseType: "streaming",
                 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,
@@ -332,7 +332,7 @@ class VellumClient {
                 return new core.Stream({
                     stream: _response.body,
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                        return yield serializers.WorkflowStreamEvent.parseOrThrow(data, {
+                        return serializers.WorkflowStreamEvent.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -391,7 +391,7 @@ class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.generate({
+     *     await client.generate({
      *         requests: [{
      *                 inputValues: {}
      *             }]
@@ -404,15 +404,16 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.GenerateResponse.parseOrThrow(_response.body, {
+                return serializers.GenerateResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -464,9 +465,10 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 responseType: "streaming",
                 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,
@@ -476,7 +478,7 @@ class VellumClient {
                 return new core.Stream({
                     stream: _response.body,
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                        return yield serializers.GenerateStreamResponse.parseOrThrow(data, {
+                        return serializers.GenerateStreamResponse.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -533,7 +535,7 @@ class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.search({
+     *     await client.search({
      *         query: "query"
      *     })
      */
@@ -544,15 +546,16 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.SearchResponse.parseOrThrow(_response.body, {
+                return serializers.SearchResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -600,7 +603,7 @@ class VellumClient {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.submitCompletionActuals({
+     *     await client.submitCompletionActuals({
      *         actuals: [{}]
      *     })
      */
@@ -611,11 +614,10 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -662,7 +664,7 @@ class VellumClient {
      * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.submitWorkflowExecutionActuals({
+     *     await client.submitWorkflowExecutionActuals({
      *         actuals: []
      *     })
      */
@@ -673,9 +675,10 @@ 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.6.8", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
+                requestType: "json",
+                body: serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,

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

@@ -44,20 +44,22 @@ import * as Vellum from "../../index";
  *     }
  */
 export interface ExecutePromptRequest {
-    /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
+    /** A list consisting of the Prompt Deployment's input variables and their values. */
     inputs: Vellum.PromptDeploymentInputRequest[];
     /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
     promptDeploymentId?: string;
-    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    /** The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
     promptDeploymentName?: string;
     /** Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment */
     releaseTag?: string;
-    /** "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment. */
+    /** Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment. */
     externalId?: string;
-    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    /** 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;
+    /** 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;
-    /** Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models. */
+    /** 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. */
     expandRaw?: 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/dist/api/client/requests/ExecutePromptStreamRequest.d.ts

@@ -44,20 +44,22 @@ import * as Vellum from "../../index";
  *     }
  */
 export interface ExecutePromptStreamRequest {
-    /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
+    /** A list consisting of the Prompt Deployment's input variables and their values. */
     inputs: Vellum.PromptDeploymentInputRequest[];
     /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
     promptDeploymentId?: string;
-    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    /** The unique name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
     promptDeploymentName?: string;
     /** Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment */
     releaseTag?: string;
-    /** "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment. */
+    /** Optionally include a unique identifier for tracking purposes. Must be unique within a given Prompt Deployment. */
     externalId?: string;
-    /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
+    /** 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;
+    /** 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;
-    /** Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models. */
+    /** 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. */
     expandRaw?: 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>;
 }