vellum-ai 0.1.13 → 0.2.0

package/api/resources/workflowDeployments/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./WorkflowDeploymentsListRequestStatus";

package/api/resources/workflowDeployments/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WorkflowDeploymentsListRequestStatus"), exports);

package/api/types/ArrayChatMessageContent.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * A list of chat message content items.
+ */
+export interface ArrayChatMessageContent {
+    value: Vellum.ArrayChatMessageContentItem[];
+}

package/api/types/ArrayChatMessageContent.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/ArrayChatMessageContentItem.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type ArrayChatMessageContentItem = Vellum.ArrayChatMessageContentItem.String | Vellum.ArrayChatMessageContentItem.FunctionCall | Vellum.ArrayChatMessageContentItem.Image;
+export declare namespace ArrayChatMessageContentItem {
+    interface String extends Vellum.StringChatMessageContent {
+        type: "STRING";
+    }
+    interface FunctionCall extends Vellum.FunctionCallChatMessageContent {
+        type: "FUNCTION_CALL";
+    }
+    interface Image extends Vellum.ImageChatMessageContent {
+        type: "IMAGE";
+    }
+}

package/api/types/ArrayChatMessageContentItem.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/ArrayChatMessageContentItemRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type ArrayChatMessageContentItemRequest = Vellum.ArrayChatMessageContentItemRequest.String | Vellum.ArrayChatMessageContentItemRequest.FunctionCall | Vellum.ArrayChatMessageContentItemRequest.Image;
+export declare namespace ArrayChatMessageContentItemRequest {
+    interface String extends Vellum.StringChatMessageContentRequest {
+        type: "STRING";
+    }
+    interface FunctionCall extends Vellum.FunctionCallChatMessageContentRequest {
+        type: "FUNCTION_CALL";
+    }
+    interface Image extends Vellum.ImageChatMessageContentRequest {
+        type: "IMAGE";
+    }
+}

package/api/types/ArrayChatMessageContentItemRequest.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/ArrayChatMessageContentRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * A list of chat message content items.
+ */
+export interface ArrayChatMessageContentRequest {
+    value: Vellum.ArrayChatMessageContentItemRequest[];
+}

package/api/types/ArrayChatMessageContentRequest.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/ChatHistoryInputRequest.d.ts

@@ -2,6 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "..";
+/**
+ * A user input representing a list of chat messages
+ */
 export interface ChatHistoryInputRequest {
     /** The variable's name, as defined in the deployment. */
     name: string;

package/api/types/ChatMessage.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "..";
 export interface ChatMessage {
-    text: string;
+    text?: string;
     role: Vellum.ChatMessageRole;
+    content?: Vellum.ChatMessageContent;
 }

package/api/types/ChatMessageContent.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type ChatMessageContent = Vellum.ChatMessageContent.String | Vellum.ChatMessageContent.FunctionCall | Vellum.ChatMessageContent.Array | Vellum.ChatMessageContent.Image;
+export declare namespace ChatMessageContent {
+    interface String extends Vellum.StringChatMessageContent {
+        type: "STRING";
+    }
+    interface FunctionCall extends Vellum.FunctionCallChatMessageContent {
+        type: "FUNCTION_CALL";
+    }
+    interface Array extends Vellum.ArrayChatMessageContent {
+        type: "ARRAY";
+    }
+    interface Image extends Vellum.ImageChatMessageContent {
+        type: "IMAGE";
+    }
+}

package/api/types/ChatMessageContent.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/ChatMessageContentRequest.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type ChatMessageContentRequest = Vellum.ChatMessageContentRequest.String | Vellum.ChatMessageContentRequest.FunctionCall | Vellum.ChatMessageContentRequest.Array | Vellum.ChatMessageContentRequest.Image;
+export declare namespace ChatMessageContentRequest {
+    interface String extends Vellum.StringChatMessageContentRequest {
+        type: "STRING";
+    }
+    interface FunctionCall extends Vellum.FunctionCallChatMessageContentRequest {
+        type: "FUNCTION_CALL";
+    }
+    interface Array extends Vellum.ArrayChatMessageContentRequest {
+        type: "ARRAY";
+    }
+    interface Image extends Vellum.ImageChatMessageContentRequest {
+        type: "IMAGE";
+    }
+}

package/api/types/ChatMessageContentRequest.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/ChatMessageRequest.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "..";
 export interface ChatMessageRequest {
-    text: string;
+    text?: string;
     role: Vellum.ChatMessageRole;
+    content?: Vellum.ChatMessageContentRequest;
 }

package/api/types/DeploymentRead.d.ts

@@ -13,10 +13,9 @@ export interface DeploymentRead {
      * The current status of the deployment
      *
      * - `ACTIVE` - Active
-     * - `INACTIVE` - Inactive
      * - `ARCHIVED` - Archived
      */
-    status?: Vellum.DeploymentStatus;
+    status?: Vellum.EntityStatus;
     /**
      * The environment this deployment is used in
      *
@@ -25,8 +24,8 @@ export interface DeploymentRead {
      * - `PRODUCTION` - Production
      */
     environment?: Vellum.EnvironmentEnum;
-    /** Deprecated. The Prompt execution endpoints return a `prompt_version_id` that could be used instead. */
-    activeModelVersionIds: string[];
     lastDeployedOn: Date;
     inputVariables: Vellum.VellumVariable[];
+    /** Deprecated. The Prompt execution endpoints return a `prompt_version_id` that could be used instead. */
+    activeModelVersionIds: string[];
 }

package/api/types/DocumentIndexRead.d.ts

@@ -15,7 +15,7 @@ export interface DocumentIndexRead {
      * - `ACTIVE` - Active
      * - `ARCHIVED` - Archived
      */
-    status?: Vellum.DocumentIndexStatus;
+    status?: Vellum.EntityStatus;
     /**
      * The environment this document index is used in
      *

package/api/types/{DocumentIndexStatus.d.ts → EntityStatus.d.ts}

@@ -5,8 +5,8 @@
  * - `ACTIVE` - Active
  * - `ARCHIVED` - Archived
  */
-export declare type DocumentIndexStatus = "ACTIVE" | "ARCHIVED";
-export declare const DocumentIndexStatus: {
+export declare type EntityStatus = "ACTIVE" | "ARCHIVED";
+export declare const EntityStatus: {
     readonly Active: "ACTIVE";
     readonly Archived: "ARCHIVED";
 };

package/{dist/api/types/DocumentIndexStatus.js → api/types/EntityStatus.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocumentIndexStatus = void 0;
-exports.DocumentIndexStatus = {
+exports.EntityStatus = void 0;
+exports.EntityStatus = {
     Active: "ACTIVE",
     Archived: "ARCHIVED",
 };

package/api/types/FunctionCallChatMessageContent.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * A function call value that is used in a chat message.
+ */
+export interface FunctionCallChatMessageContent {
+    value: Vellum.FunctionCallChatMessageContentValue;
+}

package/api/types/FunctionCallChatMessageContent.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/FunctionCallChatMessageContentRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * A function call value that is used in a chat message.
+ */
+export interface FunctionCallChatMessageContentRequest {
+    value: Vellum.FunctionCallChatMessageContentValueRequest;
+}

package/api/types/FunctionCallChatMessageContentRequest.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/FunctionCallChatMessageContentValue.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The final resolved function call value.
+ */
+export interface FunctionCallChatMessageContentValue {
+    name: string;
+    arguments: Record<string, unknown>;
+    id?: string;
+}

package/api/types/FunctionCallChatMessageContentValue.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/FunctionCallChatMessageContentValueRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The final resolved function call value.
+ */
+export interface FunctionCallChatMessageContentValueRequest {
+    name: string;
+    arguments: Record<string, unknown>;
+    id?: string;
+}

package/api/types/FunctionCallChatMessageContentValueRequest.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/FunctionCallEnum.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type FunctionCallEnum = "FUNCTION_CALL";

package/api/types/FunctionCallEnum.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/ImageChatMessageContent.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * An image value that is used in a chat message.
+ */
+export interface ImageChatMessageContent {
+    value: Vellum.VellumImage;
+}

package/api/types/ImageChatMessageContent.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/ImageChatMessageContentRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+/**
+ * An image value that is used in a chat message.
+ */
+export interface ImageChatMessageContentRequest {
+    value: Vellum.VellumImageRequest;
+}

package/api/types/ImageChatMessageContentRequest.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/ImageEnum.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ImageEnum = "IMAGE";

package/api/types/ImageEnum.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/JsonInputRequest.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * A user input representing a JSON object
+ */
 export interface JsonInputRequest {
     /** The variable's name, as defined in the deployment. */
     name: string;

package/api/types/ModelVersionExecConfigParameters.d.ts

@@ -10,4 +10,5 @@ export interface ModelVersionExecConfigParameters {
     logitBias?: Record<string, number | undefined>;
     stop?: string[];
     topK?: number;
+    customParameters?: Record<string, unknown>;
 }

package/api/types/PaginatedSlimDeploymentReadList.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface PaginatedSlimDeploymentReadList {
+    count?: number;
+    next?: string;
+    previous?: string;
+    results?: Vellum.SlimDeploymentRead[];
+}

package/api/types/PaginatedSlimDeploymentReadList.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/PaginatedSlimWorkflowDeploymentList.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface PaginatedSlimWorkflowDeploymentList {
+    count?: number;
+    next?: string;
+    previous?: string;
+    results?: Vellum.SlimWorkflowDeployment[];
+}

package/api/types/PaginatedSlimWorkflowDeploymentList.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/RegisterPromptModelParametersRequest.d.ts

@@ -10,4 +10,5 @@ export interface RegisterPromptModelParametersRequest {
     frequencyPenalty: number;
     presencePenalty: number;
     logitBias?: Record<string, number | undefined>;
+    customParameters?: Record<string, unknown>;
 }

package/api/types/SlimDeploymentRead.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface SlimDeploymentRead {
+    id: string;
+    created: Date;
+    /** A human-readable label for the deployment */
+    label: string;
+    /** A name that uniquely identifies this deployment within its workspace */
+    name: string;
+    /**
+     * The current status of the deployment
+     *
+     * - `ACTIVE` - Active
+     * - `ARCHIVED` - Archived
+     */
+    status?: Vellum.EntityStatus;
+    /**
+     * The environment this deployment is used in
+     *
+     * - `DEVELOPMENT` - Development
+     * - `STAGING` - Staging
+     * - `PRODUCTION` - Production
+     */
+    environment?: Vellum.EnvironmentEnum;
+    lastDeployedOn: Date;
+    inputVariables: Vellum.VellumVariable[];
+}

package/api/types/SlimDeploymentRead.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/SlimWorkflowDeployment.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface SlimWorkflowDeployment {
+    id: string;
+    /** A name that uniquely identifies this workflow deployment within its workspace */
+    name: string;
+    /** A human-readable label for the workflow deployment */
+    label: string;
+    /**
+     * The current status of the workflow deployment
+     *
+     * - `ACTIVE` - Active
+     * - `ARCHIVED` - Archived
+     */
+    status?: Vellum.EntityStatus;
+    /**
+     * The environment this workflow deployment is used in
+     *
+     * - `DEVELOPMENT` - Development
+     * - `STAGING` - Staging
+     * - `PRODUCTION` - Production
+     */
+    environment?: Vellum.EnvironmentEnum;
+    created: Date;
+    lastDeployedOn: Date;
+    /** The input variables this Workflow Deployment expects to receive values for when it is executed. */
+    inputVariables: Vellum.VellumVariable[];
+    /** The output variables this Workflow Deployment will produce when it is executed. */
+    outputVariables: Vellum.VellumVariable[];
+}

package/api/types/SlimWorkflowDeployment.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/StringChatMessageContent.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A string value that is used in a chat message.
+ */
+export interface StringChatMessageContent {
+    value: string;
+}

package/api/types/StringChatMessageContent.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/StringChatMessageContentRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * A string value that is used in a chat message.
+ */
+export interface StringChatMessageContentRequest {
+    value: string;
+}

package/api/types/StringChatMessageContentRequest.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/StringEnum.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type StringEnum = "STRING";

package/api/types/StringEnum.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/StringInputRequest.d.ts

@@ -1,6 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * A user input representing a string value
+ */
 export interface StringInputRequest {
     /** The variable's name, as defined in the deployment. */
     name: string;

package/api/types/VellumImage.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VellumImage {
+    src: string;
+    metadata?: Record<string, unknown>;
+}

package/api/types/VellumImage.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/VellumImageRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface VellumImageRequest {
+    src: string;
+    metadata?: Record<string, unknown>;
+}

package/api/types/VellumImageRequest.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/VellumVariableType.d.ts

@@ -10,8 +10,9 @@
  * - `ERROR` - ERROR
  * - `ARRAY` - ARRAY
  * - `FUNCTION_CALL` - FUNCTION_CALL
+ * - `IMAGE` - IMAGE
  */
-export declare type VellumVariableType = "STRING" | "NUMBER" | "JSON" | "CHAT_HISTORY" | "SEARCH_RESULTS" | "ERROR" | "ARRAY" | "FUNCTION_CALL";
+export declare type VellumVariableType = "STRING" | "NUMBER" | "JSON" | "CHAT_HISTORY" | "SEARCH_RESULTS" | "ERROR" | "ARRAY" | "FUNCTION_CALL" | "IMAGE";
 export declare const VellumVariableType: {
     readonly String: "STRING";
     readonly Number: "NUMBER";
@@ -21,4 +22,5 @@ export declare const VellumVariableType: {
     readonly Error: "ERROR";
     readonly Array: "ARRAY";
     readonly FunctionCall: "FUNCTION_CALL";
+    readonly Image: "IMAGE";
 };