vellum-ai 0.6.8 → 0.6.11

package/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/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.11", "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.11", "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.11", "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.11", "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.11", "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.11", "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.11", "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.11", "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.11", "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/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/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>;
 }

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

@@ -10,8 +10,11 @@ export declare namespace Deployments {
         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;
     }
 }
@@ -23,7 +26,7 @@ export declare class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.list()
+     *     await client.deployments.list()
      */
     list(request?: Vellum.DeploymentsListRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.PaginatedSlimDeploymentReadList>;
     /**
@@ -33,7 +36,7 @@ export declare class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.retrieve("id")
+     *     await client.deployments.retrieve("id")
      */
     retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
     /**
@@ -44,7 +47,7 @@ export declare class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.retrieveDeploymentReleaseTag("id", "name")
+     *     await client.deployments.retrieveDeploymentReleaseTag("id", "name")
      */
     retrieveDeploymentReleaseTag(id: string, name: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentReleaseTagRead>;
     /**
@@ -56,7 +59,7 @@ export declare class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.updateDeploymentReleaseTag("id", "name")
+     *     await client.deployments.updateDeploymentReleaseTag("id", "name")
      */
     updateDeploymentReleaseTag(id: string, name: string, request?: Vellum.PatchedDeploymentReleaseTagUpdateRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentReleaseTagRead>;
     /**
@@ -69,7 +72,7 @@ export declare class Deployments {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.deployments.retrieveProviderPayload({
+     *     await client.deployments.retrieveProviderPayload({
      *         inputs: []
      *     })
      */

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

@@ -54,7 +54,7 @@ class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.list()
+     *     await client.deployments.list()
      */
     list(request = {}, requestOptions) {
         var _a;
@@ -77,15 +77,16 @@ 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.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.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "json",
                 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.PaginatedSlimDeploymentReadList.parseOrThrow(_response.body, {
+                return serializers.PaginatedSlimDeploymentReadList.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -120,7 +121,7 @@ class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.retrieve("id")
+     *     await client.deployments.retrieve("id")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -129,14 +130,15 @@ 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.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.11", "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,
                 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.DeploymentRead.parseOrThrow(_response.body, {
+                return serializers.DeploymentRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -172,7 +174,7 @@ class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.retrieveDeploymentReleaseTag("id", "name")
+     *     await client.deployments.retrieveDeploymentReleaseTag("id", "name")
      */
     retrieveDeploymentReleaseTag(id, name, requestOptions) {
         var _a;
@@ -181,14 +183,15 @@ 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.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.11", "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,
                 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.DeploymentReleaseTagRead.parseOrThrow(_response.body, {
+                return serializers.DeploymentReleaseTagRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -225,7 +228,7 @@ class Deployments {
      * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.deployments.updateDeploymentReleaseTag("id", "name")
+     *     await client.deployments.updateDeploymentReleaseTag("id", "name")
      */
     updateDeploymentReleaseTag(id, name, request = {}, requestOptions) {
         var _a;
@@ -234,9 +237,10 @@ 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.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.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.PatchedDeploymentReleaseTagUpdateRequest.jsonOrThrow(request, {
+                requestType: "json",
+                body: serializers.PatchedDeploymentReleaseTagUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -244,7 +248,7 @@ class Deployments {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.DeploymentReleaseTagRead.parseOrThrow(_response.body, {
+                return serializers.DeploymentReleaseTagRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -282,7 +286,7 @@ class Deployments {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.deployments.retrieveProviderPayload({
+     *     await client.deployments.retrieveProviderPayload({
      *         inputs: []
      *     })
      */
@@ -293,9 +297,10 @@ 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.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.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {
+                requestType: "json",
+                body: serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -303,7 +308,7 @@ class Deployments {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.DeploymentProviderPayloadResponse.parseOrThrow(_response.body, {
+                return serializers.DeploymentProviderPayloadResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,