vellum-ai 0.7.3 → 0.7.5

package/reference.md

@@ -75,6 +75,21 @@ await client.submitWorkflowExecutionActuals({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used to list all Prompt Deployments.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -131,7 +146,7 @@ await client.deployments.list();
 <dl>
 <dd>
 
-Used to retrieve a deployment given its ID or name.
+Used to retrieve a Prompt Deployment given its ID or name.
 
 </dd>
 </dl>
@@ -336,6 +351,30 @@ await client.deployments.updateDeploymentReleaseTag("id", "name");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider
+for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the
+prompt or make an API call to the model provider.
+
+This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly
+to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than
+that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or
+derive meaning from the response body and instead, should simply pass it directly to the model provider as is.
+
+We encourage you to seek advise from Vellum Support before integrating with this API for production use.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1363,9 +1402,353 @@ await client.folderEntities.addEntityToFolder("folder_id", {
 </dl>
 </details>
 
+## MlModels
+
+<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedMlModelReadList</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all ML Models that your Workspace has access to.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mlModels.list();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Vellum.MlModelsListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MlModels.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">create</a>({ ...params }) -> Vellum.MlModelRead</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new ML Model.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mlModels.create({
+    name: "name",
+    family: Vellum.MlModelFamily.Capybara,
+    execConfig: {
+        modelIdentifier: "model_identifier",
+        baseUrl: "base_url",
+        metadata: {
+            key: "value",
+        },
+        features: [Vellum.MlModelFeature.Text],
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Vellum.MlModelCreateRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MlModels.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">retrieve</a>(id) -> Vellum.MlModelRead</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve an ML Model by its UUID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mlModels.retrieve("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — A UUID string identifying this ml model.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MlModels.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">update</a>(id, { ...params }) -> Vellum.MlModelRead</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Replace an ML Model with a new representation, keying off of its UUID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mlModels.update("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — A UUID string identifying this ml model.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Vellum.MlModelUpdateRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MlModels.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">partialUpdate</a>(id, { ...params }) -> Vellum.MlModelRead</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Partially update an ML Model, keying off of its UUID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.mlModels.partialUpdate("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — A UUID string identifying this ml model.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Vellum.PatchedMlModelUpdateRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `MlModels.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Sandboxes
 
-<details><summary><code>client.sandboxes.<a href="/src/api/resources/sandboxes/client/Client.ts">deployPrompt</a>(id, promptId, { ...params }) -> Vellum.DeploymentRead</code></summary>
+<details><summary><code>client.sandboxes.<a href="/src/api/resources/sandboxes/client/Client.ts">deployPrompt</a>(id, promptVariantId, { ...params }) -> Vellum.DeploymentRead</code></summary>
 <dl>
 <dd>
 
@@ -1378,7 +1761,7 @@ await client.folderEntities.addEntityToFolder("folder_id", {
 <dd>
 
 ```typescript
-await client.sandboxes.deployPrompt("id", "prompt_id");
+await client.sandboxes.deployPrompt("id", "prompt_variant_id");
 ```
 
 </dd>
@@ -1402,7 +1785,7 @@ await client.sandboxes.deployPrompt("id", "prompt_id");
 <dl>
 <dd>
 
-**promptId:** `string` — An ID identifying the Prompt you'd like to deploy.
+**promptVariantId:** `string` — An ID identifying the Prompt you'd like to deploy.
 
 </dd>
 </dl>
@@ -2094,6 +2477,21 @@ await client.testSuites.deleteTestSuiteTestCase("id", "test_case_id");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used to list all Workflow Deployments.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>

package/serialization/resources/index.d.ts

@@ -11,6 +11,8 @@ export * as documents from "./documents";
 export * from "./documents/client/requests";
 export * as folderEntities from "./folderEntities";
 export * from "./folderEntities/client/requests";
+export * as mlModels from "./mlModels";
+export * from "./mlModels/client/requests";
 export * as sandboxes from "./sandboxes";
 export * from "./sandboxes/client/requests";
 export * as testSuiteRuns from "./testSuiteRuns";

package/serialization/resources/index.js

@@ -26,7 +26,7 @@ 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 });
-exports.workflowSandboxes = exports.testSuiteRuns = exports.sandboxes = exports.folderEntities = exports.documents = exports.testSuites = exports.workflowDeployments = exports.documentIndexes = exports.deployments = void 0;
+exports.workflowSandboxes = exports.testSuiteRuns = exports.sandboxes = exports.mlModels = exports.folderEntities = exports.documents = exports.testSuites = exports.workflowDeployments = exports.documentIndexes = exports.deployments = void 0;
 exports.deployments = __importStar(require("./deployments"));
 __exportStar(require("./deployments/types"), exports);
 exports.documentIndexes = __importStar(require("./documentIndexes"));
@@ -40,6 +40,8 @@ exports.documents = __importStar(require("./documents"));
 __exportStar(require("./documents/client/requests"), exports);
 exports.folderEntities = __importStar(require("./folderEntities"));
 __exportStar(require("./folderEntities/client/requests"), exports);
+exports.mlModels = __importStar(require("./mlModels"));
+__exportStar(require("./mlModels/client/requests"), exports);
 exports.sandboxes = __importStar(require("./sandboxes"));
 __exportStar(require("./sandboxes/client/requests"), exports);
 exports.testSuiteRuns = __importStar(require("./testSuiteRuns"));

package/serialization/resources/mlModels/client/index.d.ts

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

package/serialization/resources/mlModels/client/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("./requests"), exports);

package/serialization/resources/mlModels/client/requests/MlModelCreateRequest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../index";
+import * as Vellum from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { MlModelFamily } from "../../../../types/MlModelFamily";
+import { HostedByEnum } from "../../../../types/HostedByEnum";
+import { MlModelDeveloper } from "../../../../types/MlModelDeveloper";
+import { MlModelBuildConfigRequest } from "../../../../types/MlModelBuildConfigRequest";
+import { MlModelExecConfigRequest } from "../../../../types/MlModelExecConfigRequest";
+import { MlModelParameterConfigRequest } from "../../../../types/MlModelParameterConfigRequest";
+import { MlModelDisplayConfigRequest } from "../../../../types/MlModelDisplayConfigRequest";
+import { VisibilityEnum } from "../../../../types/VisibilityEnum";
+export declare const MlModelCreateRequest: core.serialization.Schema<serializers.MlModelCreateRequest.Raw, Vellum.MlModelCreateRequest>;
+export declare namespace MlModelCreateRequest {
+    interface Raw {
+        name: string;
+        family: MlModelFamily.Raw;
+        hosted_by?: HostedByEnum.Raw | null;
+        developed_by?: MlModelDeveloper.Raw | null;
+        build_config?: MlModelBuildConfigRequest.Raw | null;
+        exec_config: MlModelExecConfigRequest.Raw;
+        parameter_config?: MlModelParameterConfigRequest.Raw | null;
+        display_config?: MlModelDisplayConfigRequest.Raw | null;
+        visibility?: VisibilityEnum.Raw | null;
+    }
+}

package/serialization/resources/mlModels/client/requests/MlModelCreateRequest.js

@@ -0,0 +1,49 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MlModelCreateRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+const MlModelFamily_1 = require("../../../../types/MlModelFamily");
+const HostedByEnum_1 = require("../../../../types/HostedByEnum");
+const MlModelDeveloper_1 = require("../../../../types/MlModelDeveloper");
+const MlModelBuildConfigRequest_1 = require("../../../../types/MlModelBuildConfigRequest");
+const MlModelExecConfigRequest_1 = require("../../../../types/MlModelExecConfigRequest");
+const MlModelParameterConfigRequest_1 = require("../../../../types/MlModelParameterConfigRequest");
+const MlModelDisplayConfigRequest_1 = require("../../../../types/MlModelDisplayConfigRequest");
+const VisibilityEnum_1 = require("../../../../types/VisibilityEnum");
+exports.MlModelCreateRequest = core.serialization.object({
+    name: core.serialization.string(),
+    family: MlModelFamily_1.MlModelFamily,
+    hostedBy: core.serialization.property("hosted_by", HostedByEnum_1.HostedByEnum.optional()),
+    developedBy: core.serialization.property("developed_by", MlModelDeveloper_1.MlModelDeveloper.optional()),
+    buildConfig: core.serialization.property("build_config", MlModelBuildConfigRequest_1.MlModelBuildConfigRequest.optional()),
+    execConfig: core.serialization.property("exec_config", MlModelExecConfigRequest_1.MlModelExecConfigRequest),
+    parameterConfig: core.serialization.property("parameter_config", MlModelParameterConfigRequest_1.MlModelParameterConfigRequest.optional()),
+    displayConfig: core.serialization.property("display_config", MlModelDisplayConfigRequest_1.MlModelDisplayConfigRequest.optional()),
+    visibility: VisibilityEnum_1.VisibilityEnum.optional(),
+});

package/serialization/resources/mlModels/client/requests/MlModelUpdateRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../index";
+import * as Vellum from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { MlModelDisplayConfigRequest } from "../../../../types/MlModelDisplayConfigRequest";
+import { VisibilityEnum } from "../../../../types/VisibilityEnum";
+export declare const MlModelUpdateRequest: core.serialization.Schema<serializers.MlModelUpdateRequest.Raw, Vellum.MlModelUpdateRequest>;
+export declare namespace MlModelUpdateRequest {
+    interface Raw {
+        display_config?: MlModelDisplayConfigRequest.Raw | null;
+        visibility?: VisibilityEnum.Raw | null;
+    }
+}

package/serialization/resources/mlModels/client/requests/MlModelUpdateRequest.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MlModelUpdateRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+const MlModelDisplayConfigRequest_1 = require("../../../../types/MlModelDisplayConfigRequest");
+const VisibilityEnum_1 = require("../../../../types/VisibilityEnum");
+exports.MlModelUpdateRequest = core.serialization.object({
+    displayConfig: core.serialization.property("display_config", MlModelDisplayConfigRequest_1.MlModelDisplayConfigRequest.optional()),
+    visibility: VisibilityEnum_1.VisibilityEnum.optional(),
+});

package/serialization/resources/mlModels/client/requests/PatchedMlModelUpdateRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../index";
+import * as Vellum from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { MlModelDisplayConfigRequest } from "../../../../types/MlModelDisplayConfigRequest";
+import { VisibilityEnum } from "../../../../types/VisibilityEnum";
+export declare const PatchedMlModelUpdateRequest: core.serialization.Schema<serializers.PatchedMlModelUpdateRequest.Raw, Vellum.PatchedMlModelUpdateRequest>;
+export declare namespace PatchedMlModelUpdateRequest {
+    interface Raw {
+        display_config?: MlModelDisplayConfigRequest.Raw | null;
+        visibility?: VisibilityEnum.Raw | null;
+    }
+}

package/serialization/resources/mlModels/client/requests/PatchedMlModelUpdateRequest.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PatchedMlModelUpdateRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+const MlModelDisplayConfigRequest_1 = require("../../../../types/MlModelDisplayConfigRequest");
+const VisibilityEnum_1 = require("../../../../types/VisibilityEnum");
+exports.PatchedMlModelUpdateRequest = core.serialization.object({
+    displayConfig: core.serialization.property("display_config", MlModelDisplayConfigRequest_1.MlModelDisplayConfigRequest.optional()),
+    visibility: VisibilityEnum_1.VisibilityEnum.optional(),
+});

package/serialization/resources/mlModels/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export { MlModelCreateRequest } from "./MlModelCreateRequest";
+export { MlModelUpdateRequest } from "./MlModelUpdateRequest";
+export { PatchedMlModelUpdateRequest } from "./PatchedMlModelUpdateRequest";