vellum-ai 0.6.4 → 0.6.7

package/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import * as Vellum from "./api";
+import * as Vellum from "./api/index";
 import { Deployments } from "./api/resources/deployments/client/Client";
 import { DocumentIndexes } from "./api/resources/documentIndexes/client/Client";
 import { Documents } from "./api/resources/documents/client/Client";
@@ -21,6 +21,7 @@ export declare namespace VellumClient {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class VellumClient {
@@ -28,10 +29,54 @@ export declare class VellumClient {
     constructor(_options: VellumClient.Options);
     /**
      * Executes a deployed Prompt and returns the result.
+     *
+     * @param {Vellum.ExecutePromptRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.executePrompt({
+     *         inputs: [{
+     *                 type: "STRING",
+     *                 name: "string",
+     *                 value: "string"
+     *             }],
+     *         promptDeploymentId: "string",
+     *         promptDeploymentName: "string",
+     *         releaseTag: "string",
+     *         externalId: "string",
+     *         expandMeta: {
+     *             modelName: true,
+     *             latency: true,
+     *             deploymentReleaseTag: true,
+     *             promptVersionId: true,
+     *             finishReason: true,
+     *             usage: true
+     *         },
+     *         rawOverrides: {
+     *             body: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             headers: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             url: "string"
+     *         },
+     *         expandRaw: ["string"],
+     *         metadata: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
      */
     executePrompt(request: Vellum.ExecutePromptRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.ExecutePromptResponse>;
     /**
@@ -40,9 +85,26 @@ export declare class VellumClient {
     executePromptStream(request: Vellum.ExecutePromptStreamRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.ExecutePromptEvent>>;
     /**
      * Executes a deployed Workflow and returns its outputs.
+     *
+     * @param {Vellum.ExecuteWorkflowRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.executeWorkflow({
+     *         inputs: [{
+     *                 type: "STRING",
+     *                 name: "string",
+     *                 value: "string"
+     *             }],
+     *         workflowDeploymentId: "string",
+     *         workflowDeploymentName: "string",
+     *         releaseTag: "string",
+     *         externalId: "string"
+     *     })
      */
     executeWorkflow(request: Vellum.ExecuteWorkflowRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.ExecuteWorkflowResponse>;
     /**
@@ -54,6 +116,10 @@ export declare class VellumClient {
      *
      * Important: This endpoint is DEPRECATED and has been superseded by
      * [execute-prompt](/api-reference/api-reference/execute-prompt).
+     *
+     * @param {Vellum.GenerateBodyRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
@@ -76,6 +142,10 @@ export declare class VellumClient {
     generateStream(request: Vellum.GenerateStreamBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.GenerateStreamResponse>>;
     /**
      * Perform a search against a document index.
+     *
+     * @param {Vellum.SearchRequestBodyRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
@@ -88,6 +158,10 @@ export declare class VellumClient {
     search(request: Vellum.SearchRequestBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.SearchResponse>;
     /**
      * Used to submit feedback regarding the quality of previously generated completions.
+     *
+     * @param {Vellum.SubmitCompletionActualsRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
@@ -103,6 +177,9 @@ export declare class VellumClient {
      *
      *     **Note:** Uses a base url of `https://predict.vellum.ai`.
      *
+     * @param {Vellum.SubmitWorkflowExecutionActualsRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.submitWorkflowExecutionActuals({
      *         actuals: []

package/Client.js

@@ -41,10 +41,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VellumClient = void 0;
 const environments = __importStar(require("./environments"));
 const core = __importStar(require("./core"));
-const Vellum = __importStar(require("./api"));
-const serializers = __importStar(require("./serialization"));
+const Vellum = __importStar(require("./api/index"));
+const serializers = __importStar(require("./serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("./errors"));
+const errors = __importStar(require("./errors/index"));
 const Client_1 = require("./api/resources/deployments/client/Client");
 const Client_2 = require("./api/resources/documentIndexes/client/Client");
 const Client_3 = require("./api/resources/documents/client/Client");
@@ -60,10 +60,54 @@ class VellumClient {
     }
     /**
      * Executes a deployed Prompt and returns the result.
+     *
+     * @param {Vellum.ExecutePromptRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.executePrompt({
+     *         inputs: [{
+     *                 type: "STRING",
+     *                 name: "string",
+     *                 value: "string"
+     *             }],
+     *         promptDeploymentId: "string",
+     *         promptDeploymentName: "string",
+     *         releaseTag: "string",
+     *         externalId: "string",
+     *         expandMeta: {
+     *             modelName: true,
+     *             latency: true,
+     *             deploymentReleaseTag: true,
+     *             promptVersionId: true,
+     *             finishReason: true,
+     *             usage: true
+     *         },
+     *         rawOverrides: {
+     *             body: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             headers: {
+     *                 "string": {
+     *                     "key": "value"
+     *                 }
+     *             },
+     *             url: "string"
+     *         },
+     *         expandRaw: ["string"],
+     *         metadata: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
      */
     executePrompt(request, requestOptions) {
         var _a;
@@ -72,11 +116,12 @@ 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.4", "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.7", "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" }),
                 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, {
@@ -128,7 +173,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.6.4", "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.7", "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",
@@ -136,11 +181,11 @@ class VellumClient {
                 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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return new core.Stream({
                     stream: _response.body,
-                    terminator: "\n",
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
                         return yield serializers.ExecutePromptEvent.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
@@ -149,6 +194,11 @@ class VellumClient {
                             breadcrumbsPrefix: ["response"],
                         });
                     }),
+                    signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    eventShape: {
+                        type: "json",
+                        messageTerminator: "\n",
+                    },
                 });
             }
             if (_response.error.reason === "status-code") {
@@ -185,9 +235,26 @@ class VellumClient {
     }
     /**
      * Executes a deployed Workflow and returns its outputs.
+     *
+     * @param {Vellum.ExecuteWorkflowRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.executeWorkflow({
+     *         inputs: [{
+     *                 type: "STRING",
+     *                 name: "string",
+     *                 value: "string"
+     *             }],
+     *         workflowDeploymentId: "string",
+     *         workflowDeploymentName: "string",
+     *         releaseTag: "string",
+     *         externalId: "string"
+     *     })
      */
     executeWorkflow(request, requestOptions) {
         var _a;
@@ -196,11 +263,12 @@ 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.4", "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.7", "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" }),
                 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, {
@@ -250,7 +318,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.6.4", "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.7", "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",
@@ -258,11 +326,11 @@ class VellumClient {
                 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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return new core.Stream({
                     stream: _response.body,
-                    terminator: "\n",
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
                         return yield serializers.WorkflowStreamEvent.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
@@ -271,6 +339,11 @@ class VellumClient {
                             breadcrumbsPrefix: ["response"],
                         });
                     }),
+                    signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    eventShape: {
+                        type: "json",
+                        messageTerminator: "\n",
+                    },
                 });
             }
             if (_response.error.reason === "status-code") {
@@ -308,6 +381,10 @@ class VellumClient {
      *
      * Important: This endpoint is DEPRECATED and has been superseded by
      * [execute-prompt](/api-reference/api-reference/execute-prompt).
+     *
+     * @param {Vellum.GenerateBodyRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.ForbiddenError}
      * @throws {@link Vellum.NotFoundError}
@@ -327,11 +404,12 @@ 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.4", "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.7", "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" }),
                 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, {
@@ -386,17 +464,17 @@ 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.4", "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.7", "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" }),
                 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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return new core.Stream({
                     stream: _response.body,
-                    terminator: "\n",
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
                         return yield serializers.GenerateStreamResponse.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
@@ -405,6 +483,11 @@ class VellumClient {
                             breadcrumbsPrefix: ["response"],
                         });
                     }),
+                    signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    eventShape: {
+                        type: "json",
+                        messageTerminator: "\n",
+                    },
                 });
             }
             if (_response.error.reason === "status-code") {
@@ -441,6 +524,10 @@ class VellumClient {
     }
     /**
      * Perform a search against a document index.
+     *
+     * @param {Vellum.SearchRequestBodyRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
@@ -457,11 +544,12 @@ 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.4", "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.7", "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" }),
                 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, {
@@ -503,6 +591,10 @@ class VellumClient {
     }
     /**
      * Used to submit feedback regarding the quality of previously generated completions.
+     *
+     * @param {Vellum.SubmitCompletionActualsRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @throws {@link Vellum.BadRequestError}
      * @throws {@link Vellum.NotFoundError}
      * @throws {@link Vellum.InternalServerError}
@@ -519,13 +611,14 @@ 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.4", "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.7", "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",
                 }),
                 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;
@@ -565,6 +658,9 @@ class VellumClient {
      *
      *     **Note:** Uses a base url of `https://predict.vellum.ai`.
      *
+     * @param {Vellum.SubmitWorkflowExecutionActualsRequest} request
+     * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.submitWorkflowExecutionActuals({
      *         actuals: []
@@ -577,13 +673,14 @@ 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.4", "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.7", "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, {
                     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;

package/README.md

@@ -1,12 +1,15 @@
 # Vellum Node Library
 
 [![npm shield](https://img.shields.io/npm/v/vellum-ai)](https://www.npmjs.com/package/vellum-ai)
+![license badge](https://img.shields.io/github/license/vellum-ai/vellum-client-node)
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=vellum-ai/vellum-client-node/readme)
 
-The Vellum Node.js library provides access to the Vellum API from JavaScript/TypeScript.
+The Vellum Node SDK provides access to the Vellum API from JavaScript/TypeScript in node environments.
+
+Note: This SDK is not intended to work in client-side JavaScript environments (i.e. web browsers).
 
 ## API Docs
-You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai).
+You can find Vellum's complete API docs at [docs.vellum.ai](https://docs.vellum.ai/api-reference/introduction/getting-started).
 
 
 ## Installation
@@ -19,43 +22,51 @@ yarn add vellum-ai
 
 ## Usage
 
-[![Try it out](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/typescript-example-using-sdk-built-with-fern-xbs4jx?file=app.ts)
-
 ```typescript
 import { VellumClient } from 'vellum-ai';
 
 const vellum = new VellumClient({
-  apiKey: 'VELLUM_API_KEY',
-});
-
-await vellum.generate({
-  deploymentName: 'my-deployment',
-  requests: [{ inputValues: { question: 'Could I please get a refund' } }],
+  apiKey: "<YOUR_API_KEY>",
 });
 
+void main();
+
+async function main() {
+    const result = await vellum.executePrompt({
+        promptDeploymentName: "<your-deployment-name>>",
+        releaseTag: "LATEST",
+        inputs: [
+            {
+                type: "STRING",
+                name: "<input_name>",
+                value: "<example-string-value>",
+            },
+        ],
+    });
+
+    if (result.state === "REJECTED") {
+        throw new Error(result.error.message)
+    } else if (result.state === "FULFILLED") {
+        console.log(result.outputs[0].value);
+    }
+}
 ```
 
-## Uploading documents
+> [!TIP]
+> You can set a system environment variable `VELLUM_API_KEY` to avoid writing your api key within your code. To do so, add `export VELLUM_API_KEY=<your-api-token>`
+> to your ~/.zshrc or ~/.bashrc, open a new terminal, and then any code calling `VellumClient()` will read this key.
 
-Documents can be uploaded to Vellum via either the UI or this API. Once uploaded and indexed, Vellum's Search allows you to perform semantic searches against them.
+## Contributing
 
-```typescript
-import * as fs from 'fs';
+While we value open-source contributions to this SDK, most of this library is generated programmatically.
 
-await vellum.documents.upload(fs.createReadStream('/path/to/your/file.txt'), {
-  addToIndexNames: ['<your-index-name>'],
-  externalId: '<your-external-id>',
-  label: 'Human-friendly label for your document',
-  keywords: [],
-});
+Please feel free to make contributions to any of the directories or files below:
+```plaintext
+tests/*
+README.md
 ```
 
-## Beta status
-
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
-
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!
+Any additions made to files beyond those directories and files above would have to be moved over to our generation code
+(found in the separate [vellum-client-generator](https://github.com/vellum-ai/vellum-client-generator) repo),
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept,
+but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

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

@@ -1,7 +1,48 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
+/**
+ * @example
+ *     {
+ *         inputs: [{
+ *                 type: "STRING",
+ *                 name: "string",
+ *                 value: "string"
+ *             }],
+ *         promptDeploymentId: "string",
+ *         promptDeploymentName: "string",
+ *         releaseTag: "string",
+ *         externalId: "string",
+ *         expandMeta: {
+ *             modelName: true,
+ *             latency: true,
+ *             deploymentReleaseTag: true,
+ *             promptVersionId: true,
+ *             finishReason: true,
+ *             usage: true
+ *         },
+ *         rawOverrides: {
+ *             body: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             },
+ *             headers: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             },
+ *             url: "string"
+ *         },
+ *         expandRaw: ["string"],
+ *         metadata: {
+ *             "string": {
+ *                 "key": "value"
+ *             }
+ *         }
+ *     }
+ */
 export interface ExecutePromptRequest {
     /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
     inputs: Vellum.PromptDeploymentInputRequest[];

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

@@ -1,7 +1,48 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../..";
+import * as Vellum from "../../index";
+/**
+ * @example
+ *     {
+ *         inputs: [{
+ *                 type: "STRING",
+ *                 name: "string",
+ *                 value: "string"
+ *             }],
+ *         promptDeploymentId: "string",
+ *         promptDeploymentName: "string",
+ *         releaseTag: "string",
+ *         externalId: "string",
+ *         expandMeta: {
+ *             modelName: true,
+ *             latency: true,
+ *             deploymentReleaseTag: true,
+ *             promptVersionId: true,
+ *             finishReason: true,
+ *             usage: true
+ *         },
+ *         rawOverrides: {
+ *             body: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             },
+ *             headers: {
+ *                 "string": {
+ *                     "key": "value"
+ *                 }
+ *             },
+ *             url: "string"
+ *         },
+ *         expandRaw: ["string"],
+ *         metadata: {
+ *             "string": {
+ *                 "key": "value"
+ *             }
+ *         }
+ *     }
+ */
 export interface ExecutePromptStreamRequest {
     /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
     inputs: Vellum.PromptDeploymentInputRequest[];