vellum-ai 0.3.10 → 0.3.12

package/api/types/ArrayVariableValueItem.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "..";
-export declare type ArrayVariableValueItem = Vellum.ArrayVariableValueItem.String | Vellum.ArrayVariableValueItem.Number | Vellum.ArrayVariableValueItem.Json | Vellum.ArrayVariableValueItem.ChatHistory | Vellum.ArrayVariableValueItem.SearchResults | Vellum.ArrayVariableValueItem.Error_ | Vellum.ArrayVariableValueItem.FunctionCall;
+export declare type ArrayVariableValueItem = Vellum.ArrayVariableValueItem.String | Vellum.ArrayVariableValueItem.Number | Vellum.ArrayVariableValueItem.Json | Vellum.ArrayVariableValueItem.ChatHistory | Vellum.ArrayVariableValueItem.SearchResults | Vellum.ArrayVariableValueItem.Error_ | Vellum.ArrayVariableValueItem.FunctionCall | Vellum.ArrayVariableValueItem.Image;
 export declare namespace ArrayVariableValueItem {
     interface String extends Vellum.StringVariableValue {
         type: "STRING";
@@ -25,4 +25,7 @@ export declare namespace ArrayVariableValueItem {
     interface FunctionCall extends Vellum.FunctionCallVariableValue {
         type: "FUNCTION_CALL";
     }
+    interface Image extends Vellum.ImageVariableValue {
+        type: "IMAGE";
+    }
 }

package/api/types/ChatMessage.d.ts

@@ -6,4 +6,6 @@ export interface ChatMessage {
     text?: string;
     role: Vellum.ChatMessageRole;
     content?: Vellum.ChatMessageContent;
+    /** An optional identifier representing who or what generated this message. */
+    source?: string;
 }

package/api/types/ChatMessageRequest.d.ts

@@ -6,4 +6,6 @@ export interface ChatMessageRequest {
     text?: string;
     role: Vellum.ChatMessageRole;
     content?: Vellum.ChatMessageContentRequest;
+    /** An optional identifier representing who or what generated this message. */
+    source?: string;
 }

package/api/types/ExecutionArrayVellumValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ExecutionArrayVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: Vellum.ArrayVariableValueItem[];
+}

package/api/types/ExecutionArrayVellumValue.js

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

package/api/types/ExecutionChatHistoryVellumValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ExecutionChatHistoryVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: Vellum.ChatMessage[];
+}

package/api/types/ExecutionChatHistoryVellumValue.js

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

package/api/types/ExecutionErrorVellumValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ExecutionErrorVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: Vellum.VellumError;
+}

package/api/types/ExecutionErrorVellumValue.js

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

package/api/types/ExecutionFunctionCallVellumValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ExecutionFunctionCallVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: Vellum.FunctionCall;
+}

package/api/types/ExecutionFunctionCallVellumValue.js

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

package/api/types/ExecutionJsonVellumValue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExecutionJsonVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: Record<string, unknown>;
+}

package/api/types/ExecutionJsonVellumValue.js

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

package/api/types/ExecutionNumberVellumValue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExecutionNumberVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: number;
+}

package/api/types/ExecutionNumberVellumValue.js

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

package/api/types/ExecutionSearchResultsVellumValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ExecutionSearchResultsVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: Vellum.SearchResult[];
+}

package/api/types/ExecutionSearchResultsVellumValue.js

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

package/api/types/ExecutionStringVellumValue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ExecutionStringVellumValue {
+    /** The variable's uniquely identifying internal id. */
+    id: string;
+    name: string;
+    value?: string;
+}

package/api/types/ExecutionStringVellumValue.js

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

package/api/types/ExecutionVellumValue.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type ExecutionVellumValue = Vellum.ExecutionVellumValue.String | Vellum.ExecutionVellumValue.Number | Vellum.ExecutionVellumValue.Json | Vellum.ExecutionVellumValue.ChatHistory | Vellum.ExecutionVellumValue.SearchResults | Vellum.ExecutionVellumValue.Error_ | Vellum.ExecutionVellumValue.Array | Vellum.ExecutionVellumValue.FunctionCall;
+export declare namespace ExecutionVellumValue {
+    interface String extends Vellum.ExecutionStringVellumValue {
+        type: "STRING";
+    }
+    interface Number extends Vellum.ExecutionNumberVellumValue {
+        type: "NUMBER";
+    }
+    interface Json extends Vellum.ExecutionJsonVellumValue {
+        type: "JSON";
+    }
+    interface ChatHistory extends Vellum.ExecutionChatHistoryVellumValue {
+        type: "CHAT_HISTORY";
+    }
+    interface SearchResults extends Vellum.ExecutionSearchResultsVellumValue {
+        type: "SEARCH_RESULTS";
+    }
+    interface Error_ extends Vellum.ExecutionErrorVellumValue {
+        type: "ERROR";
+    }
+    interface Array extends Vellum.ExecutionArrayVellumValue {
+        type: "ARRAY";
+    }
+    interface FunctionCall extends Vellum.ExecutionFunctionCallVellumValue {
+        type: "FUNCTION_CALL";
+    }
+}

package/api/types/ExecutionVellumValue.js

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

package/api/types/FulfilledWorkflowNodeResultEvent.d.ts

@@ -11,5 +11,7 @@ export interface FulfilledWorkflowNodeResultEvent {
     nodeResultId: string;
     ts?: Date;
     data?: Vellum.WorkflowNodeResultData;
+    sourceExecutionId?: string;
     outputValues?: Vellum.NodeOutputCompiledValue[];
+    mocked?: boolean;
 }

package/api/types/GenerateRequest.d.ts

@@ -5,7 +5,7 @@ import * as Vellum from "..";
 export interface GenerateRequest {
     /** Key/value pairs for each template variable defined in the deployment's prompt. */
     inputValues: Record<string, unknown>;
-    /** Optionally provide a list of chat messages that'll be used in place of the special {$chat_history} variable, if included in the prompt. */
+    /** Optionally provide a list of chat messages that'll be used in place of the special chat_history variable, if included in the prompt. */
     chatHistory?: Vellum.ChatMessageRequest[];
     /** Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one. */
     externalIds?: string[];

package/api/types/ImageVariableValue.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * A base Vellum primitive value representing an image.
+ */
+export interface ImageVariableValue {
+    value?: Vellum.VellumImage;
+}

package/api/types/ImageVariableValue.js

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

package/api/types/InitiatedWorkflowNodeResultEvent.d.ts

@@ -11,5 +11,6 @@ export interface InitiatedWorkflowNodeResultEvent {
     nodeResultId: string;
     ts?: Date;
     data?: Vellum.WorkflowNodeResultData;
+    sourceExecutionId?: string;
     inputValues?: Vellum.NodeInputVariableCompiledValue[];
 }

package/api/types/PromptTemplateBlockProperties.d.ts

@@ -5,6 +5,7 @@ import * as Vellum from "..";
 export interface PromptTemplateBlockProperties {
     chatRole?: Vellum.ChatMessageRole;
     chatMessageUnterminated?: boolean;
+    chatSource?: string;
     template?: string;
     templateType?: Vellum.VellumVariableType;
     functionName?: string;

package/api/types/PromptTemplateBlockPropertiesRequest.d.ts

@@ -5,6 +5,7 @@ import * as Vellum from "..";
 export interface PromptTemplateBlockPropertiesRequest {
     chatRole?: Vellum.ChatMessageRole;
     chatMessageUnterminated?: boolean;
+    chatSource?: string;
     template?: string;
     templateType?: Vellum.VellumVariableType;
     functionName?: string;

package/api/types/RejectedWorkflowNodeResultEvent.d.ts

@@ -11,5 +11,6 @@ export interface RejectedWorkflowNodeResultEvent {
     nodeResultId: string;
     ts?: Date;
     data?: Vellum.WorkflowNodeResultData;
+    sourceExecutionId?: string;
     error: Vellum.WorkflowEventError;
 }

package/api/types/StreamingWorkflowNodeResultEvent.d.ts

@@ -11,6 +11,7 @@ export interface StreamingWorkflowNodeResultEvent {
     nodeResultId: string;
     ts?: Date;
     data?: Vellum.WorkflowNodeResultData;
+    sourceExecutionId?: string;
     output?: Vellum.NodeOutputCompiledValue;
     outputIndex?: number;
 }

package/api/types/WorkflowExecutionEventErrorCode.d.ts

@@ -3,6 +3,7 @@
  */
 /**
  * - `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION
+ * - `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED
  * - `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED
  * - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
  * - `NODE_EXECUTION` - NODE_EXECUTION
@@ -10,9 +11,10 @@
  * - `INVALID_TEMPLATE` - INVALID_TEMPLATE
  * - `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
  */
-export declare type WorkflowExecutionEventErrorCode = "WORKFLOW_INITIALIZATION" | "NODE_EXECUTION_COUNT_LIMIT_REACHED" | "INTERNAL_SERVER_ERROR" | "NODE_EXECUTION" | "LLM_PROVIDER" | "INVALID_TEMPLATE" | "USER_DEFINED_ERROR";
+export declare type WorkflowExecutionEventErrorCode = "WORKFLOW_INITIALIZATION" | "WORKFLOW_CANCELLED" | "NODE_EXECUTION_COUNT_LIMIT_REACHED" | "INTERNAL_SERVER_ERROR" | "NODE_EXECUTION" | "LLM_PROVIDER" | "INVALID_TEMPLATE" | "USER_DEFINED_ERROR";
 export declare const WorkflowExecutionEventErrorCode: {
     readonly WorkflowInitialization: "WORKFLOW_INITIALIZATION";
+    readonly WorkflowCancelled: "WORKFLOW_CANCELLED";
     readonly NodeExecutionCountLimitReached: "NODE_EXECUTION_COUNT_LIMIT_REACHED";
     readonly InternalServerError: "INTERNAL_SERVER_ERROR";
     readonly NodeExecution: "NODE_EXECUTION";

package/api/types/WorkflowExecutionEventErrorCode.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowExecutionEventErrorCode = void 0;
 exports.WorkflowExecutionEventErrorCode = {
     WorkflowInitialization: "WORKFLOW_INITIALIZATION",
+    WorkflowCancelled: "WORKFLOW_CANCELLED",
     NodeExecutionCountLimitReached: "NODE_EXECUTION_COUNT_LIMIT_REACHED",
     InternalServerError: "INTERNAL_SERVER_ERROR",
     NodeExecution: "NODE_EXECUTION",

package/api/types/WorkflowExecutionEventType.d.ts

@@ -2,8 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 /**
- * - `NODE` - Node
- * - `WORKFLOW` - Workflow
+ * - `NODE` - NODE
+ * - `WORKFLOW` - WORKFLOW
  */
 export declare type WorkflowExecutionEventType = "NODE" | "WORKFLOW";
 export declare const WorkflowExecutionEventType: {

package/api/types/WorkflowResultEvent.d.ts

@@ -9,4 +9,5 @@ export interface WorkflowResultEvent {
     output?: Vellum.WorkflowResultEventOutputData;
     error?: Vellum.WorkflowEventError;
     outputs?: Vellum.WorkflowOutput[];
+    inputs?: Vellum.ExecutionVellumValue[];
 }

package/api/types/index.d.ts

@@ -44,6 +44,15 @@ export * from "./ExecuteWorkflowErrorResponse";
 export * from "./ExecuteWorkflowResponse";
 export * from "./ExecuteWorkflowStreamErrorResponse";
 export * from "./ExecuteWorkflowWorkflowResultEvent";
+export * from "./ExecutionArrayVellumValue";
+export * from "./ExecutionChatHistoryVellumValue";
+export * from "./ExecutionErrorVellumValue";
+export * from "./ExecutionFunctionCallVellumValue";
+export * from "./ExecutionJsonVellumValue";
+export * from "./ExecutionNumberVellumValue";
+export * from "./ExecutionSearchResultsVellumValue";
+export * from "./ExecutionStringVellumValue";
+export * from "./ExecutionVellumValue";
 export * from "./FinishReasonEnum";
 export * from "./FulfilledEnum";
 export * from "./FulfilledExecutePromptEvent";
@@ -72,6 +81,7 @@ export * from "./GenerateStreamResultData";
 export * from "./ImageChatMessageContent";
 export * from "./ImageChatMessageContentRequest";
 export * from "./ImageEnum";
+export * from "./ImageVariableValue";
 export * from "./IndexingStateEnum";
 export * from "./InitiatedEnum";
 export * from "./InitiatedExecutePromptEvent";

package/api/types/index.js

@@ -60,6 +60,15 @@ __exportStar(require("./ExecuteWorkflowErrorResponse"), exports);
 __exportStar(require("./ExecuteWorkflowResponse"), exports);
 __exportStar(require("./ExecuteWorkflowStreamErrorResponse"), exports);
 __exportStar(require("./ExecuteWorkflowWorkflowResultEvent"), exports);
+__exportStar(require("./ExecutionArrayVellumValue"), exports);
+__exportStar(require("./ExecutionChatHistoryVellumValue"), exports);
+__exportStar(require("./ExecutionErrorVellumValue"), exports);
+__exportStar(require("./ExecutionFunctionCallVellumValue"), exports);
+__exportStar(require("./ExecutionJsonVellumValue"), exports);
+__exportStar(require("./ExecutionNumberVellumValue"), exports);
+__exportStar(require("./ExecutionSearchResultsVellumValue"), exports);
+__exportStar(require("./ExecutionStringVellumValue"), exports);
+__exportStar(require("./ExecutionVellumValue"), exports);
 __exportStar(require("./FinishReasonEnum"), exports);
 __exportStar(require("./FulfilledEnum"), exports);
 __exportStar(require("./FulfilledExecutePromptEvent"), exports);
@@ -88,6 +97,7 @@ __exportStar(require("./GenerateStreamResultData"), exports);
 __exportStar(require("./ImageChatMessageContent"), exports);
 __exportStar(require("./ImageChatMessageContentRequest"), exports);
 __exportStar(require("./ImageEnum"), exports);
+__exportStar(require("./ImageVariableValue"), exports);
 __exportStar(require("./IndexingStateEnum"), exports);
 __exportStar(require("./InitiatedEnum"), exports);
 __exportStar(require("./InitiatedExecutePromptEvent"), exports);

package/dist/Client.js

@@ -76,7 +76,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -139,7 +139,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -214,7 +214,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -275,7 +275,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -358,7 +358,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -423,7 +423,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -503,7 +503,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -574,7 +574,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -639,7 +639,7 @@ class VellumClient {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

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

@@ -3,14 +3,14 @@
  */
 import * as Vellum from "../..";
 export interface ExecuteWorkflowRequest {
+    /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
+    inputs: Vellum.WorkflowRequestInputRequest[];
     /** The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name. */
     workflowDeploymentId?: string;
     /** The name of the Workflow Deployment. Must provide either this or workflow_deployment_id. */
     workflowDeploymentName?: string;
     /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
     releaseTag?: string;
-    /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
-    inputs: Vellum.WorkflowRequestInputRequest[];
-    /** Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment. */
+    /** Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment. */
     externalId?: string;
 }

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

@@ -3,14 +3,14 @@
  */
 import * as Vellum from "../..";
 export interface ExecuteWorkflowStreamRequest {
+    /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
+    inputs: Vellum.WorkflowRequestInputRequest[];
     /** The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name. */
     workflowDeploymentId?: string;
     /** The name of the Workflow Deployment. Must provide either this or workflow_deployment_id. */
     workflowDeploymentName?: string;
     /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
     releaseTag?: string;
-    /** The list of inputs defined in the Workflow's deployment with their corresponding values. */
-    inputs: Vellum.WorkflowRequestInputRequest[];
     /** Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment. */
     externalId?: string;
     /** Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution. */

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

@@ -25,5 +25,16 @@ export declare class Deployments {
      *     await vellum.deployments.retrieve("id")
      */
     retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
+    /**
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.ForbiddenError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.deployments.retrieveProviderPayload({
+     *         inputs: []
+     *     })
+     */
     retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentProviderPayloadResponse>;
 }

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

@@ -41,6 +41,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Deployments = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
+const Vellum = __importStar(require("../../.."));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization"));
 const errors = __importStar(require("../../../../errors"));
@@ -73,7 +74,7 @@ class Deployments {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -128,7 +129,7 @@ class Deployments {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -165,6 +166,17 @@ class Deployments {
             }
         });
     }
+    /**
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.ForbiddenError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
+     *
+     * @example
+     *     await vellum.deployments.retrieveProviderPayload({
+     *         inputs: []
+     *     })
+     */
     retrieveProviderPayload(request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -176,7 +188,7 @@ class Deployments {
                     X_API_KEY: yield core.Supplier.get(this._options.apiKey),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "vellum-ai",
-                    "X-Fern-SDK-Version": "0.3.10",
+                    "X-Fern-SDK-Version": "0.3.12",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -196,10 +208,21 @@ class Deployments {
                 });
             }
             if (_response.error.reason === "status-code") {
-                throw new errors.VellumError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.body,
-                });
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Vellum.BadRequestError(_response.error.body);
+                    case 403:
+                        throw new Vellum.ForbiddenError(_response.error.body);
+                    case 404:
+                        throw new Vellum.NotFoundError(_response.error.body);
+                    case 500:
+                        throw new Vellum.InternalServerError(_response.error.body);
+                    default:
+                        throw new errors.VellumError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
             }
             switch (_response.error.reason) {
                 case "non-json":

package/dist/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts

@@ -15,4 +15,6 @@ export interface DeploymentProviderPayloadRequest {
     deploymentName?: string;
     /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
     inputs: Vellum.PromptDeploymentInputRequest[];
+    /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
+    releaseTag?: string;
 }