vellum-ai 0.0.12 → 0.0.14

package/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import * as Vellum from "./api";
+import { Deployments } from "./api/resources/deployments/client/Client";
 import { Documents } from "./api/resources/documents/client/Client";
 import { ModelVersions } from "./api/resources/modelVersions/client/Client";
 import { Sandboxes } from "./api/resources/sandboxes/client/Client";
@@ -29,6 +30,11 @@ export declare class VellumClient {
      */
     generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
     /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a stream of completions using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
      * @throws {Vellum.NotFoundError}
      * @throws {Vellum.InternalServerError}
@@ -56,6 +62,8 @@ export declare class VellumClient {
      * @throws {Vellum.InternalServerError}
      */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
+    protected _deployments: Deployments | undefined;
+    get deployments(): Deployments;
     protected _documents: Documents | undefined;
     get documents(): Documents;
     protected _modelVersions: ModelVersions | undefined;

package/Client.js

@@ -36,10 +36,11 @@ const Vellum = __importStar(require("./api"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("./serialization"));
 const errors = __importStar(require("./errors"));
-const Client_1 = require("./api/resources/documents/client/Client");
-const Client_2 = require("./api/resources/modelVersions/client/Client");
-const Client_3 = require("./api/resources/sandboxes/client/Client");
-const Client_4 = require("./api/resources/testSuites/client/Client");
+const Client_1 = require("./api/resources/deployments/client/Client");
+const Client_2 = require("./api/resources/documents/client/Client");
+const Client_3 = require("./api/resources/modelVersions/client/Client");
+const Client_4 = require("./api/resources/sandboxes/client/Client");
+const Client_5 = require("./api/resources/testSuites/client/Client");
 class VellumClient {
     options;
     constructor(options) {
@@ -102,6 +103,11 @@ class VellumClient {
         }
     }
     /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a stream of completions using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
      * @throws {Vellum.NotFoundError}
      * @throws {Vellum.InternalServerError}
@@ -243,21 +249,25 @@ class VellumClient {
                 });
         }
     }
+    _deployments;
+    get deployments() {
+        return (this._deployments ??= new Client_1.Deployments(this.options));
+    }
     _documents;
     get documents() {
-        return (this._documents ??= new Client_1.Documents(this.options));
+        return (this._documents ??= new Client_2.Documents(this.options));
     }
     _modelVersions;
     get modelVersions() {
-        return (this._modelVersions ??= new Client_2.ModelVersions(this.options));
+        return (this._modelVersions ??= new Client_3.ModelVersions(this.options));
     }
     _sandboxes;
     get sandboxes() {
-        return (this._sandboxes ??= new Client_3.Sandboxes(this.options));
+        return (this._sandboxes ??= new Client_4.Sandboxes(this.options));
     }
     _testSuites;
     get testSuites() {
-        return (this._testSuites ??= new Client_4.TestSuites(this.options));
+        return (this._testSuites ??= new Client_5.TestSuites(this.options));
     }
 }
 exports.VellumClient = VellumClient;

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

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Vellum from "../../..";
+export declare namespace Deployments {
+    interface Options {
+        environment?: environments.VellumEnvironment | environments.VellumEnvironmentUrls;
+        apiKey: core.Supplier<string>;
+    }
+}
+export declare class Deployments {
+    protected readonly options: Deployments.Options;
+    constructor(options: Deployments.Options);
+    /**
+     *
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Used to retrieve a deployment given its ID or name.
+     *
+     */
+    retrieve(id: string): Promise<Vellum.DeploymentRead>;
+}

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

@@ -0,0 +1,87 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Deployments = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const url_join_1 = __importDefault(require("url-join"));
+const serializers = __importStar(require("../../../../serialization"));
+const errors = __importStar(require("../../../../errors"));
+class Deployments {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    /**
+     *
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Used to retrieve a deployment given its ID or name.
+     *
+     */
+    async retrieve(id) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/deployments/${id}`),
+            method: "GET",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+        });
+        if (_response.ok) {
+            return await serializers.DeploymentRead.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            });
+        }
+        if (_response.error.reason === "status-code") {
+            throw new errors.VellumError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+            });
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.VellumError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                });
+            case "timeout":
+                throw new errors.VellumTimeoutError();
+            case "unknown":
+                throw new errors.VellumError({
+                    message: _response.error.errorMessage,
+                });
+        }
+    }
+}
+exports.Deployments = Deployments;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/deployments/index.d.ts

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

package/api/resources/deployments/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("./client"), exports);

package/api/resources/index.d.ts

@@ -1,7 +1,9 @@
+export * as deployments from "./deployments";
 export * as documents from "./documents";
 export * as modelVersions from "./modelVersions";
 export * as sandboxes from "./sandboxes";
 export * as testSuites from "./testSuites";
 export * from "./documents/client/requests";
+export * from "./modelVersions/client/requests";
 export * from "./sandboxes/client/requests";
 export * from "./testSuites/client/requests";

package/api/resources/index.js

@@ -26,11 +26,13 @@ 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.testSuites = exports.sandboxes = exports.modelVersions = exports.documents = void 0;
+exports.testSuites = exports.sandboxes = exports.modelVersions = exports.documents = exports.deployments = void 0;
+exports.deployments = __importStar(require("./deployments"));
 exports.documents = __importStar(require("./documents"));
 exports.modelVersions = __importStar(require("./modelVersions"));
 exports.sandboxes = __importStar(require("./sandboxes"));
 exports.testSuites = __importStar(require("./testSuites"));
 __exportStar(require("./documents/client/requests"), exports);
+__exportStar(require("./modelVersions/client/requests"), exports);
 __exportStar(require("./sandboxes/client/requests"), exports);
 __exportStar(require("./testSuites/client/requests"), exports);

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

@@ -21,4 +21,10 @@ export declare class ModelVersions {
      *
      */
     retrieve(id: string): Promise<Vellum.ModelVersionRead>;
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Compiles the prompt backing the model version using the provided input values.
+     */
+    modelVersionCompilePrompt(id: string, request: Vellum.ModelVersionCompilePromptRequestRequest): Promise<Vellum.ModelVersionCompilePromptResponse>;
 }

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

@@ -83,5 +83,49 @@ class ModelVersions {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Compiles the prompt backing the model version using the provided input values.
+     */
+    async modelVersionCompilePrompt(id, request) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/model-versions/${id}/compile-prompt`),
+            method: "POST",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+            body: await serializers.ModelVersionCompilePromptRequestRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "strip",
+            }),
+        });
+        if (_response.ok) {
+            return await serializers.ModelVersionCompilePromptResponse.parseOrThrow(_response.body, {
+                unrecognizedObjectKeys: "passthrough",
+                allowUnrecognizedUnionMembers: true,
+                allowUnrecognizedEnumValues: true,
+            });
+        }
+        if (_response.error.reason === "status-code") {
+            throw new errors.VellumError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+            });
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.VellumError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                });
+            case "timeout":
+                throw new errors.VellumTimeoutError();
+            case "unknown":
+                throw new errors.VellumError({
+                    message: _response.error.errorMessage,
+                });
+        }
+    }
 }
 exports.ModelVersions = ModelVersions;

package/api/resources/modelVersions/client/index.d.ts

@@ -1 +1 @@
-export {};
+export * from "./requests";

package/api/resources/modelVersions/client/index.js

@@ -1,2 +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/api/resources/modelVersions/client/requests/ModelVersionCompilePromptRequestRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelVersionCompilePromptRequestRequest {
+    /** Key/value pairs for each variable found within the model version's prompt template. */
+    inputValues: Record<string, unknown>;
+}

package/api/resources/modelVersions/client/requests/ModelVersionCompilePromptRequestRequest.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/resources/modelVersions/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { ModelVersionCompilePromptRequestRequest } from "./ModelVersionCompilePromptRequestRequest";

package/api/resources/modelVersions/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/DeploymentRead.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface DeploymentRead {
+    id: string;
+    created: string;
+    /** 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 */
+    status?: Vellum.DeploymentReadStatusEnum;
+    /** The environment this deployment is used in */
+    environment?: Vellum.EnvironmentEnum;
+    /** The type of model this deployment serves */
+    modelType: Vellum.ModelTypeEnum;
+    activeModelVersionIds: string[];
+    lastDeployedOn: string;
+}

package/api/types/DeploymentRead.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/DeploymentReadStatusEnum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type DeploymentReadStatusEnum = "ACTIVE" | "INACTIVE" | "ARCHIVED";
+export declare const DeploymentReadStatusEnum: {
+    readonly Active: "ACTIVE";
+    readonly Inactive: "INACTIVE";
+    readonly Archived: "ARCHIVED";
+};

package/api/types/DeploymentReadStatusEnum.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeploymentReadStatusEnum = void 0;
+exports.DeploymentReadStatusEnum = {
+    Active: "ACTIVE",
+    Inactive: "INACTIVE",
+    Archived: "ARCHIVED",
+};

package/api/types/EnvironmentEnum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type EnvironmentEnum = "DEVELOPMENT" | "STAGING" | "PRODUCTION";
+export declare const EnvironmentEnum: {
+    readonly Development: "DEVELOPMENT";
+    readonly Staging: "STAGING";
+    readonly Production: "PRODUCTION";
+};

package/api/types/EnvironmentEnum.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentEnum = void 0;
+exports.EnvironmentEnum = {
+    Development: "DEVELOPMENT",
+    Staging: "STAGING",
+    Production: "PRODUCTION",
+};

package/api/types/ModelVersionCompilePromptResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ModelVersionCompilePromptResponse {
+    /** Information about the compiled prompt. */
+    prompt: Vellum.ModelVersionCompiledPrompt;
+}

package/api/types/ModelVersionCompilePromptResponse.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/ModelVersionCompiledPrompt.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelVersionCompiledPrompt {
+    /** The fully compiled prompt in normalized ChatML syntax after all variable substitutions and templating functions are applied. */
+    text: string;
+    /** The approximate number of tokens used by the compiled prompt. */
+    numTokens: number;
+}

package/api/types/ModelVersionCompiledPrompt.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/ModelVersionExecConfigRead.d.ts

@@ -5,8 +5,8 @@ import * as Vellum from "..";
 export interface ModelVersionExecConfigRead {
     /** The generation parameters that are passed to the LLM provider at runtime. */
     parameters: Vellum.ModelVersionExecConfigParameters;
-    /** Names of the template variables specified in the prompt template. */
-    inputVariables: string[];
+    /** Names of the input variables specified in the prompt template. */
+    inputVariables: Vellum.PromptTemplateInputVariable[];
     /** The template used to generate prompts for this model version. */
     promptTemplate?: string;
     promptBlockData?: Vellum.PromptTemplateBlockData;

package/api/types/ModelVersionSandboxSnapshot.d.ts

@@ -8,4 +8,5 @@ export interface ModelVersionSandboxSnapshot {
     promptIndex?: number;
     /** The id of the prompt in the sandbox snapshot. */
     promptId?: string;
+    sandboxId: string;
 }

package/api/types/PromptTemplateInputVariable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PromptTemplateInputVariable {
+    /** The name of the input variable. */
+    key: string;
+}

package/api/types/PromptTemplateInputVariable.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/index.d.ts

@@ -2,9 +2,12 @@ export * from "./BlockTypeEnum";
 export * from "./ChatMessage";
 export * from "./ChatMessageRequest";
 export * from "./ChatMessageRole";
+export * from "./DeploymentRead";
+export * from "./DeploymentReadStatusEnum";
 export * from "./Document";
 export * from "./DocumentDocumentToDocumentIndex";
 export * from "./EnrichedNormalizedCompletion";
+export * from "./EnvironmentEnum";
 export * from "./EvaluationParams";
 export * from "./EvaluationParamsRequest";
 export * from "./FinishReasonEnum";
@@ -22,6 +25,8 @@ export * from "./IndexingStateEnum";
 export * from "./LogprobsEnum";
 export * from "./ModelTypeEnum";
 export * from "./ModelVersionBuildConfig";
+export * from "./ModelVersionCompilePromptResponse";
+export * from "./ModelVersionCompiledPrompt";
 export * from "./ModelVersionExecConfigParameters";
 export * from "./ModelVersionExecConfigRead";
 export * from "./ModelVersionRead";
@@ -35,6 +40,7 @@ export * from "./ProcessingStateEnum";
 export * from "./PromptTemplateBlock";
 export * from "./PromptTemplateBlockData";
 export * from "./PromptTemplateBlockProperties";
+export * from "./PromptTemplateInputVariable";
 export * from "./ProviderEnum";
 export * from "./SandboxMetricInputParams";
 export * from "./SandboxMetricInputParamsRequest";

package/api/types/index.js

@@ -18,9 +18,12 @@ __exportStar(require("./BlockTypeEnum"), exports);
 __exportStar(require("./ChatMessage"), exports);
 __exportStar(require("./ChatMessageRequest"), exports);
 __exportStar(require("./ChatMessageRole"), exports);
+__exportStar(require("./DeploymentRead"), exports);
+__exportStar(require("./DeploymentReadStatusEnum"), exports);
 __exportStar(require("./Document"), exports);
 __exportStar(require("./DocumentDocumentToDocumentIndex"), exports);
 __exportStar(require("./EnrichedNormalizedCompletion"), exports);
+__exportStar(require("./EnvironmentEnum"), exports);
 __exportStar(require("./EvaluationParams"), exports);
 __exportStar(require("./EvaluationParamsRequest"), exports);
 __exportStar(require("./FinishReasonEnum"), exports);
@@ -38,6 +41,8 @@ __exportStar(require("./IndexingStateEnum"), exports);
 __exportStar(require("./LogprobsEnum"), exports);
 __exportStar(require("./ModelTypeEnum"), exports);
 __exportStar(require("./ModelVersionBuildConfig"), exports);
+__exportStar(require("./ModelVersionCompilePromptResponse"), exports);
+__exportStar(require("./ModelVersionCompiledPrompt"), exports);
 __exportStar(require("./ModelVersionExecConfigParameters"), exports);
 __exportStar(require("./ModelVersionExecConfigRead"), exports);
 __exportStar(require("./ModelVersionRead"), exports);
@@ -51,6 +56,7 @@ __exportStar(require("./ProcessingStateEnum"), exports);
 __exportStar(require("./PromptTemplateBlock"), exports);
 __exportStar(require("./PromptTemplateBlockData"), exports);
 __exportStar(require("./PromptTemplateBlockProperties"), exports);
+__exportStar(require("./PromptTemplateInputVariable"), exports);
 __exportStar(require("./ProviderEnum"), exports);
 __exportStar(require("./SandboxMetricInputParams"), exports);
 __exportStar(require("./SandboxMetricInputParamsRequest"), exports);

package/dist/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import * as Vellum from "./api";
+import { Deployments } from "./api/resources/deployments/client/Client";
 import { Documents } from "./api/resources/documents/client/Client";
 import { ModelVersions } from "./api/resources/modelVersions/client/Client";
 import { Sandboxes } from "./api/resources/sandboxes/client/Client";
@@ -29,6 +30,11 @@ export declare class VellumClient {
      */
     generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
     /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a stream of completions using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
      * @throws {Vellum.NotFoundError}
      * @throws {Vellum.InternalServerError}
@@ -56,6 +62,8 @@ export declare class VellumClient {
      * @throws {Vellum.InternalServerError}
      */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
+    protected _deployments: Deployments | undefined;
+    get deployments(): Deployments;
     protected _documents: Documents | undefined;
     get documents(): Documents;
     protected _modelVersions: ModelVersions | undefined;