vellum-ai 0.0.9 → 0.0.11

package/dist/Client.d.ts

@@ -7,6 +7,7 @@ import * as Vellum from "./api";
 import { Documents } from "./api/resources/documents/client/Client";
 import { ModelVersions } from "./api/resources/modelVersions/client/Client";
 import { Sandboxes } from "./api/resources/sandboxes/client/Client";
+import { TestSuites } from "./api/resources/testSuites/client/Client";
 export declare namespace VellumClient {
     interface Options {
         environment?: environments.VellumEnvironment | environments.VellumEnvironmentUrls;
@@ -16,8 +17,44 @@ export declare namespace VellumClient {
 export declare class VellumClient {
     protected readonly options: VellumClient.Options;
     constructor(options: VellumClient.Options);
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a completion using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
+    /**
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
+    generateStream(request: Vellum.GenerateBodyRequest, cb: (data: Vellum.GenerateStreamResponse) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Perform a search against a document index.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     search(request: Vellum.SearchRequestBodyRequest): Promise<Vellum.SearchResponse>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previously generated completions.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
     protected _documents: Documents | undefined;
     get documents(): Documents;
@@ -25,4 +62,6 @@ export declare class VellumClient {
     get modelVersions(): ModelVersions;
     protected _sandboxes: Sandboxes | undefined;
     get sandboxes(): Sandboxes;
+    protected _testSuites: TestSuites | undefined;
+    get testSuites(): TestSuites;
 }

package/dist/Client.js

@@ -32,17 +32,29 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VellumClient = void 0;
 const environments = __importStar(require("./environments"));
 const core = __importStar(require("./core"));
+const Vellum = __importStar(require("./api"));
 const 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");
 class VellumClient {
     options;
     constructor(options) {
         this.options = options;
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Generate a completion using a previously defined deployment.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async generate(request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/generate"),
@@ -61,10 +73,19 @@ class VellumClient {
             });
         }
         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 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":
@@ -80,6 +101,48 @@ class VellumClient {
                 });
         }
     }
+    /**
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
+    async generateStream(request, cb, opts) {
+        const _queue = new core.CallbackQueue();
+        await core.streamingFetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, "v1/generate-stream"),
+            method: "POST",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            body: await serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+            onData: _queue.wrap(async (data) => {
+                const parsed = await serializers.GenerateStreamResponse.parse(data, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                });
+                if (parsed.ok) {
+                    cb(parsed.value);
+                }
+                else {
+                    opts?.onError?.(parsed.errors);
+                }
+            }),
+            onError: opts?.onError != null ? _queue.wrap(opts.onError) : undefined,
+            onFinish: opts?.onFinish != null ? _queue.wrap(opts.onFinish) : undefined,
+            abortController: opts?.abortController,
+        });
+    }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Perform a search against a document index.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async search(request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/search"),
@@ -98,10 +161,19 @@ class VellumClient {
             });
         }
         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 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":
@@ -117,6 +189,16 @@ class VellumClient {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to submit feedback regarding the quality of previously generated completions.
+     *
+     * **Note:** Uses a base url of `https://predict.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async submitCompletionActuals(request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/submit-completion-actuals"),
@@ -133,10 +215,19 @@ class VellumClient {
             return;
         }
         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 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":
@@ -164,5 +255,9 @@ class VellumClient {
     get sandboxes() {
         return (this._sandboxes ??= new Client_3.Sandboxes(this.options));
     }
+    _testSuites;
+    get testSuites() {
+        return (this._testSuites ??= new Client_4.TestSuites(this.options));
+    }
 }
 exports.VellumClient = VellumClient;

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

@@ -1,3 +1,2 @@
-export { GenerateBodyRequest } from "./GenerateBodyRequest";
 export { SearchRequestBodyRequest } from "./SearchRequestBodyRequest";
 export { SubmitCompletionActualsRequest } from "./SubmitCompletionActualsRequest";

package/dist/api/errors/BadRequestError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+export declare class BadRequestError extends errors.VellumError {
+    constructor(body?: unknown);
+}

package/dist/api/errors/BadRequestError.js

@@ -0,0 +1,41 @@
+"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.BadRequestError = void 0;
+const errors = __importStar(require("../../errors"));
+class BadRequestError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, BadRequestError.prototype);
+    }
+}
+exports.BadRequestError = BadRequestError;

package/dist/api/errors/InternalServerError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+export declare class InternalServerError extends errors.VellumError {
+    constructor(body?: unknown);
+}

package/dist/api/errors/InternalServerError.js

@@ -0,0 +1,41 @@
+"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.InternalServerError = void 0;
+const errors = __importStar(require("../../errors"));
+class InternalServerError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+        });
+        Object.setPrototypeOf(this, InternalServerError.prototype);
+    }
+}
+exports.InternalServerError = InternalServerError;

package/dist/api/errors/NotFoundError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors";
+export declare class NotFoundError extends errors.VellumError {
+    constructor(body?: unknown);
+}

package/dist/api/errors/NotFoundError.js

@@ -0,0 +1,41 @@
+"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.NotFoundError = void 0;
+const errors = __importStar(require("../../errors"));
+class NotFoundError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/dist/api/errors/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./BadRequestError";
+export * from "./NotFoundError";
+export * from "./InternalServerError";

package/dist/api/errors/index.js

@@ -0,0 +1,19 @@
+"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("./BadRequestError"), exports);
+__exportStar(require("./NotFoundError"), exports);
+__exportStar(require("./InternalServerError"), exports);

package/dist/api/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./types";
+export * from "./errors";
 export * from "./resources";
 export * from "./client";

package/dist/api/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);
 __exportStar(require("./resources"), exports);
 __exportStar(require("./client"), exports);

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

@@ -15,6 +15,23 @@ export declare namespace Documents {
 export declare class Documents {
     protected readonly options: Documents.Options;
     constructor(options: Documents.Options);
+    /**
+     *
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to list documents. Optionally filter on supported fields.
+     *
+     */
     list(request?: Vellum.DocumentsListRequest): Promise<Vellum.PaginatedSlimDocumentList>;
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Upload a document to be indexed and used for search.
+     *
+     * **Note:** Uses a base url of `https://documents.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     upload(contents: File | fs.ReadStream, request: Vellum.UploadDocumentBodyRequest): Promise<Vellum.UploadDocumentResponse>;
 }

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

@@ -32,6 +32,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Documents = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
+const Vellum = __importStar(require("../../.."));
 const url_search_params_1 = __importDefault(require("@ungap/url-search-params"));
 const url_join_1 = __importDefault(require("url-join"));
 const serializers = __importStar(require("../../../../serialization"));
@@ -42,6 +43,13 @@ class Documents {
     constructor(options) {
         this.options = options;
     }
+    /**
+     *
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Used to list documents. Optionally filter on supported fields.
+     *
+     */
     async list(request = {}) {
         const { documentIndexId, limit, offset, ordering } = request;
         const _queryParams = new url_search_params_1.default();
@@ -93,6 +101,16 @@ class Documents {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#4caf50; color:white; padding:4px; border-radius:4px">Stable</strong>
+     *
+     * Upload a document to be indexed and used for search.
+     *
+     * **Note:** Uses a base url of `https://documents.vellum.ai`.
+     * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.NotFoundError}
+     * @throws {Vellum.InternalServerError}
+     */
     async upload(contents, request) {
         const _request = new form_data_1.default();
         if (request.addToIndexNames != null) {
@@ -128,10 +146,19 @@ class Documents {
             });
         }
         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 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/documents/client/requests/DocumentsListRequest.d.ts

@@ -2,8 +2,20 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface DocumentsListRequest {
+    /**
+     * Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
+     */
     documentIndexId?: string;
+    /**
+     * Number of results to return per page.
+     */
     limit?: number;
+    /**
+     * The initial index from which to return the results.
+     */
     offset?: number;
+    /**
+     * Which field to use when ordering the results.
+     */
     ordering?: string;
 }

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

@@ -1,5 +1,7 @@
 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 "./sandboxes/client/requests";
+export * from "./testSuites/client/requests";

package/dist/api/resources/index.js

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

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

@@ -13,5 +13,12 @@ export declare namespace ModelVersions {
 export declare class ModelVersions {
     protected readonly options: ModelVersions.Options;
     constructor(options: ModelVersions.Options);
+    /**
+     *
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Used to retrieve a model version given its ID.
+     *
+     */
     retrieve(id: string): Promise<Vellum.ModelVersionRead>;
 }

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

@@ -40,6 +40,13 @@ class ModelVersions {
     constructor(options) {
         this.options = options;
     }
+    /**
+     *
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Used to retrieve a model version given its ID.
+     *
+     */
     async retrieve(id) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/model-versions/${id}`),

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

@@ -13,5 +13,16 @@ export declare namespace Sandboxes {
 export declare class Sandboxes {
     protected readonly options: Sandboxes.Options;
     constructor(options: Sandboxes.Options);
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
+     *
+     * If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
+     * is found, a new scenario will be appended to the end.
+     *
+     * Note that a full replacement of the scenario is performed, so any fields not provided will be removed
+     * or overwritten with default values.
+     */
     upsertSandboxScenario(id: string, request: Vellum.UpsertSandboxScenarioRequestRequest): Promise<Vellum.SandboxScenario>;
 }

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

@@ -40,6 +40,17 @@ class Sandboxes {
     constructor(options) {
         this.options = options;
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
+     *
+     * If an id is provided and has a match, the scenario will be updated. If no id is provided or no match
+     * is found, a new scenario will be appended to the end.
+     *
+     * Note that a full replacement of the scenario is performed, so any fields not provided will be removed
+     * or overwritten with default values.
+     */
     async upsertSandboxScenario(id, request) {
         const _response = await core.fetcher({
             url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/sandboxes/${id}/scenarios`),

package/dist/api/resources/sandboxes/client/requests/UpsertSandboxScenarioRequestRequest.d.ts

@@ -5,7 +5,7 @@ import * as Vellum from "../../../..";
 export interface UpsertSandboxScenarioRequestRequest {
     label?: string;
     /** The inputs for the scenario */
-    inputs: Vellum.SandboxInputRequest[];
+    inputs: Vellum.ScenarioInputRequest[];
     /** The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended. */
     scenarioId?: string;
     metricInputParams?: Vellum.SandboxMetricInputParamsRequest;