vellum-ai 0.0.16 → 0.0.17

package/api/client/requests/SearchRequestBodyRequest.d.ts

@@ -7,7 +7,7 @@ export interface SearchRequestBodyRequest {
     indexId?: string;
     /** The name of the index to search against. Must provide either this or index_id. */
     indexName?: string;
-    /** The query to search for. */
+    /** The query to search for. <span style="white-space: nowrap">`non-empty`</span> */
     query: string;
     /** Configuration options for the search. */
     options?: Vellum.SearchRequestOptionsRequest;

package/api/resources/documentIndexes/client/requests/DocumentIndexCreateRequest.d.ts

@@ -3,13 +3,14 @@
  */
 import * as Vellum from "../../../..";
 export interface DocumentIndexCreateRequest {
-    /** A human-readable label for the document index. */
+    /** A human-readable label for the document index <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
-    /** A name that uniquely identifies this index within its workspace */
+    /** A name that uniquely identifies this index within its workspace <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 150 characters`</span> */
     name: string;
     /** The current status of the document index */
     status?: Vellum.DocumentIndexStatus;
-    /** Configuration representing how documents should be indexed. */
+    /** Configuration representing how documents should be indexed */
     indexingConfig: Record<string, unknown>;
+    /** Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index */
     copyDocumentsFromIndexId?: string;
 }

package/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts

@@ -6,7 +6,7 @@ export interface UploadDocumentBodyRequest {
     addToIndexNames?: string[];
     /** Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed. */
     externalId?: string;
-    /** A human-friendly name for this document. Typically the filename. */
+    /** A human-friendly name for this document. Typically the filename. <span style="white-space: nowrap">`non-empty`</span> */
     label: string;
     /** Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches. */
     keywords?: string[];

package/api/resources/registeredPrompts/client/requests/RegisterPromptRequestRequest.d.ts

@@ -3,15 +3,15 @@
  */
 import * as Vellum from "../../../..";
 export interface RegisterPromptRequestRequest {
-    /** A human-friendly label for corresponding entities created in Vellum. */
+    /** A human-friendly label for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span> */
     label: string;
-    /** A uniquely-identifying name for corresponding entities created in Vellum. */
+    /** A uniquely-identifying name for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span> */
     name: string;
     /** Information about how to execute the prompt template. */
     prompt: Vellum.RegisterPromptPromptInfoRequest;
     /** The initial LLM provider to use for this prompt */
     provider: Vellum.ProviderEnum;
-    /** The initial model to use for this prompt */
+    /** The initial model to use for this prompt <span style="white-space: nowrap">`non-empty`</span> */
     model: string;
     /** The initial model parameters to use for  this prompt */
     parameters: Vellum.RegisterPromptModelParametersRequest;

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

@@ -25,4 +25,10 @@ export declare class Sandboxes {
      * or overwritten with default values.
      */
     upsertSandboxScenario(id: string, request: Vellum.UpsertSandboxScenarioRequestRequest): Promise<Vellum.SandboxScenario>;
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
+     */
+    deleteSandboxScenario(id: string, scenarioId: string): Promise<void>;
 }

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

@@ -90,5 +90,42 @@ class Sandboxes {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
+     */
+    async deleteSandboxScenario(id, scenarioId) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/sandboxes/${id}/scenarios/${scenarioId}`),
+            method: "DELETE",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+        });
+        if (_response.ok) {
+            return;
+        }
+        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.Sandboxes = Sandboxes;

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

@@ -6,7 +6,7 @@ export interface UpsertSandboxScenarioRequestRequest {
     label?: string;
     /** The inputs for the scenario */
     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. */
+    /** The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended. <span style="white-space: nowrap">`non-empty`</span> */
     scenarioId?: string;
     metricInputParams?: Vellum.SandboxMetricInputParamsRequest;
 }

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

@@ -25,4 +25,10 @@ export declare class TestSuites {
      * or overwritten with default values.
      */
     upsertTestSuiteTestCase(id: string, request: Vellum.TestSuiteTestCaseRequest): Promise<Vellum.TestSuiteTestCase>;
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing test case for a test suite, keying off of the test case id.
+     */
+    deleteTestSuiteTestCase(id: string, testCaseId: string): Promise<void>;
 }

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

@@ -88,5 +88,42 @@ class TestSuites {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing test case for a test suite, keying off of the test case id.
+     */
+    async deleteTestSuiteTestCase(id, testCaseId) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/test-suites/${id}/test-cases/${testCaseId}`),
+            method: "DELETE",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+        });
+        if (_response.ok) {
+            return;
+        }
+        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.TestSuites = TestSuites;

package/api/resources/testSuites/client/requests/TestSuiteTestCaseRequest.d.ts

@@ -3,7 +3,7 @@
  */
 import * as Vellum from "../../../..";
 export interface TestSuiteTestCaseRequest {
-    /** The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. */
+    /** The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. <span style="white-space: nowrap">`non-empty`</span> */
     testCaseId?: string;
     /** A human-friendly label for the test case. */
     label?: string;

package/api/types/DeploymentRead.d.ts

@@ -5,9 +5,9 @@ import * as Vellum from "..";
 export interface DeploymentRead {
     id: string;
     created: string;
-    /** A human-readable label for the deployment */
+    /** A human-readable label for the deployment <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
-    /** A name that uniquely identifies this deployment within its workspace */
+    /** A name that uniquely identifies this deployment within its workspace <span style="white-space: nowrap">`<= 150 characters`</span> */
     name: string;
     /** The current status of the deployment */
     status?: Vellum.DeploymentReadStatusEnum;

package/api/types/Document.d.ts

@@ -4,7 +4,7 @@
 export interface Document {
     /** The ID of the document. */
     id: string;
-    /** The human-readable name for the document. */
+    /** The human-readable name for the document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
     label: string;
     /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
     externalId?: string;

package/api/types/DocumentIndexRead.d.ts

@@ -5,12 +5,12 @@ import * as Vellum from "..";
 export interface DocumentIndexRead {
     id: string;
     created: string;
-    /** A human-readable label for the document index. */
+    /** A human-readable label for the document index <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
-    /** A name that uniquely identifies this index within its workspace */
+    /** A name that uniquely identifies this index within its workspace <span style="white-space: nowrap">`<= 150 characters`</span> */
     name: string;
     /** The current status of the document index */
     status?: Vellum.DocumentIndexStatus;
-    /** Configuration representing how documents should be indexed. */
+    /** Configuration representing how documents should be indexed */
     indexingConfig: Record<string, unknown>;
 }

package/api/types/ModelVersionRead.d.ts

@@ -7,13 +7,13 @@ export interface ModelVersionRead {
     id: string;
     /** Timestamp of when this model version was created. */
     created: string;
-    /** Human-friendly name for this model version. */
+    /** Human-friendly name for this model version. <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
     /** The type of task this model is used for. */
     modelType: Vellum.ModelTypeEnum;
     /** Which LLM provider this model version is associated with. */
     provider: Vellum.ProviderEnum;
-    /** The unique id of this model version as it exists in the above provider's system. */
+    /** The unique id of this model version as it exists in the above provider's system. <span style="white-space: nowrap">`<= 250 characters`</span> */
     externalId: string;
     /** Configuration used to build this model version. */
     buildConfig: Vellum.ModelVersionBuildConfig;

package/api/types/ModelVersionSandboxSnapshot.d.ts

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

package/api/types/ProcessingFailureReasonEnum.d.ts

@@ -2,6 +2,3 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare type ProcessingFailureReasonEnum = "EXCEEDED_CHARACTER_LIMIT";
-export declare const ProcessingFailureReasonEnum: {
-    readonly ExceededCharacterLimit: "EXCEEDED_CHARACTER_LIMIT";
-};

package/api/types/ProcessingFailureReasonEnum.js

@@ -3,7 +3,3 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessingFailureReasonEnum = void 0;
-exports.ProcessingFailureReasonEnum = {
-    ExceededCharacterLimit: "EXCEEDED_CHARACTER_LIMIT",
-};

package/api/types/PromptTemplateBlockRequest.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "..";
 export interface PromptTemplateBlockRequest {
+    /** <span style="white-space: nowrap">`non-empty`</span> */
     id: string;
     blockType: Vellum.BlockTypeEnum;
     properties: Vellum.PromptTemplateBlockPropertiesRequest;

package/api/types/PromptTemplateInputVariableRequest.d.ts

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface PromptTemplateInputVariableRequest {
-    /** The name of the input variable. */
+    /** The name of the input variable. <span style="white-space: nowrap">`non-empty`</span> */
     key: string;
 }

package/api/types/RegisterPromptPromptInfoRequest.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "..";
 export interface RegisterPromptPromptInfoRequest {
     promptSyntaxVersion?: number;
-    promptBlockData?: Vellum.PromptTemplateBlockDataRequest;
+    promptBlockData: Vellum.PromptTemplateBlockDataRequest;
     /** Names of the input variables specified in the prompt template. */
-    inputVariables?: Vellum.PromptTemplateInputVariableRequest[];
+    inputVariables: Vellum.PromptTemplateInputVariableRequest[];
 }

package/api/types/ScenarioInputRequest.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "..";
 export interface ScenarioInputRequest {
+    /** <span style="white-space: nowrap">`non-empty`</span> */
     key: string;
     type?: Vellum.TypeEnum;
     value?: string;

package/api/types/SlimDocument.d.ts

@@ -9,7 +9,7 @@ export interface SlimDocument {
     externalId?: string;
     /** A timestamp representing when this document was most recently uploaded. */
     lastUploadedAt: string;
-    /** Human-friendly name for this document. */
+    /** Human-friendly name for this document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
     label: string;
     /** An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle. */
     processingState?: Vellum.ProcessingStateEnum;

package/api/types/SlimDocumentStatusEnum.d.ts

@@ -2,6 +2,3 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare type SlimDocumentStatusEnum = "ACTIVE";
-export declare const SlimDocumentStatusEnum: {
-    readonly Active: "ACTIVE";
-};

package/api/types/SlimDocumentStatusEnum.js

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

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

@@ -7,7 +7,7 @@ export interface SearchRequestBodyRequest {
     indexId?: string;
     /** The name of the index to search against. Must provide either this or index_id. */
     indexName?: string;
-    /** The query to search for. */
+    /** The query to search for. <span style="white-space: nowrap">`non-empty`</span> */
     query: string;
     /** Configuration options for the search. */
     options?: Vellum.SearchRequestOptionsRequest;

package/dist/api/resources/documentIndexes/client/requests/DocumentIndexCreateRequest.d.ts

@@ -3,13 +3,14 @@
  */
 import * as Vellum from "../../../..";
 export interface DocumentIndexCreateRequest {
-    /** A human-readable label for the document index. */
+    /** A human-readable label for the document index <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
-    /** A name that uniquely identifies this index within its workspace */
+    /** A name that uniquely identifies this index within its workspace <span style="white-space: nowrap">`non-empty`</span> <span style="white-space: nowrap">`<= 150 characters`</span> */
     name: string;
     /** The current status of the document index */
     status?: Vellum.DocumentIndexStatus;
-    /** Configuration representing how documents should be indexed. */
+    /** Configuration representing how documents should be indexed */
     indexingConfig: Record<string, unknown>;
+    /** Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index */
     copyDocumentsFromIndexId?: string;
 }

package/dist/api/resources/documents/client/requests/UploadDocumentBodyRequest.d.ts

@@ -6,7 +6,7 @@ export interface UploadDocumentBodyRequest {
     addToIndexNames?: string[];
     /** Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed. */
     externalId?: string;
-    /** A human-friendly name for this document. Typically the filename. */
+    /** A human-friendly name for this document. Typically the filename. <span style="white-space: nowrap">`non-empty`</span> */
     label: string;
     /** Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches. */
     keywords?: string[];

package/dist/api/resources/registeredPrompts/client/requests/RegisterPromptRequestRequest.d.ts

@@ -3,15 +3,15 @@
  */
 import * as Vellum from "../../../..";
 export interface RegisterPromptRequestRequest {
-    /** A human-friendly label for corresponding entities created in Vellum. */
+    /** A human-friendly label for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span> */
     label: string;
-    /** A uniquely-identifying name for corresponding entities created in Vellum. */
+    /** A uniquely-identifying name for corresponding entities created in Vellum. <span style="white-space: nowrap">`non-empty`</span> */
     name: string;
     /** Information about how to execute the prompt template. */
     prompt: Vellum.RegisterPromptPromptInfoRequest;
     /** The initial LLM provider to use for this prompt */
     provider: Vellum.ProviderEnum;
-    /** The initial model to use for this prompt */
+    /** The initial model to use for this prompt <span style="white-space: nowrap">`non-empty`</span> */
     model: string;
     /** The initial model parameters to use for  this prompt */
     parameters: Vellum.RegisterPromptModelParametersRequest;

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

@@ -25,4 +25,10 @@ export declare class Sandboxes {
      * or overwritten with default values.
      */
     upsertSandboxScenario(id: string, request: Vellum.UpsertSandboxScenarioRequestRequest): Promise<Vellum.SandboxScenario>;
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
+     */
+    deleteSandboxScenario(id: string, scenarioId: string): Promise<void>;
 }

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

@@ -90,5 +90,42 @@ class Sandboxes {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
+     */
+    async deleteSandboxScenario(id, scenarioId) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/sandboxes/${id}/scenarios/${scenarioId}`),
+            method: "DELETE",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+        });
+        if (_response.ok) {
+            return;
+        }
+        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.Sandboxes = Sandboxes;

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

@@ -6,7 +6,7 @@ export interface UpsertSandboxScenarioRequestRequest {
     label?: string;
     /** The inputs for the scenario */
     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. */
+    /** The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended. <span style="white-space: nowrap">`non-empty`</span> */
     scenarioId?: string;
     metricInputParams?: Vellum.SandboxMetricInputParamsRequest;
 }

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

@@ -25,4 +25,10 @@ export declare class TestSuites {
      * or overwritten with default values.
      */
     upsertTestSuiteTestCase(id: string, request: Vellum.TestSuiteTestCaseRequest): Promise<Vellum.TestSuiteTestCase>;
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing test case for a test suite, keying off of the test case id.
+     */
+    deleteTestSuiteTestCase(id: string, testCaseId: string): Promise<void>;
 }

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

@@ -88,5 +88,42 @@ class TestSuites {
                 });
         }
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Deletes an existing test case for a test suite, keying off of the test case id.
+     */
+    async deleteTestSuiteTestCase(id, testCaseId) {
+        const _response = await core.fetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).default, `v1/test-suites/${id}/test-cases/${testCaseId}`),
+            method: "DELETE",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            contentType: "application/json",
+        });
+        if (_response.ok) {
+            return;
+        }
+        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.TestSuites = TestSuites;

package/dist/api/resources/testSuites/client/requests/TestSuiteTestCaseRequest.d.ts

@@ -3,7 +3,7 @@
  */
 import * as Vellum from "../../../..";
 export interface TestSuiteTestCaseRequest {
-    /** The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. */
+    /** The id of the test case to update. If none is provided, an id will be generated and a new test case will be appended. <span style="white-space: nowrap">`non-empty`</span> */
     testCaseId?: string;
     /** A human-friendly label for the test case. */
     label?: string;

package/dist/api/types/DeploymentRead.d.ts

@@ -5,9 +5,9 @@ import * as Vellum from "..";
 export interface DeploymentRead {
     id: string;
     created: string;
-    /** A human-readable label for the deployment */
+    /** A human-readable label for the deployment <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
-    /** A name that uniquely identifies this deployment within its workspace */
+    /** A name that uniquely identifies this deployment within its workspace <span style="white-space: nowrap">`<= 150 characters`</span> */
     name: string;
     /** The current status of the deployment */
     status?: Vellum.DeploymentReadStatusEnum;

package/dist/api/types/Document.d.ts

@@ -4,7 +4,7 @@
 export interface Document {
     /** The ID of the document. */
     id: string;
-    /** The human-readable name for the document. */
+    /** The human-readable name for the document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
     label: string;
     /** The unique ID of the document as represented in an external system and specified when it was originally uploaded. */
     externalId?: string;

package/dist/api/types/DocumentIndexRead.d.ts

@@ -5,12 +5,12 @@ import * as Vellum from "..";
 export interface DocumentIndexRead {
     id: string;
     created: string;
-    /** A human-readable label for the document index. */
+    /** A human-readable label for the document index <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
-    /** A name that uniquely identifies this index within its workspace */
+    /** A name that uniquely identifies this index within its workspace <span style="white-space: nowrap">`<= 150 characters`</span> */
     name: string;
     /** The current status of the document index */
     status?: Vellum.DocumentIndexStatus;
-    /** Configuration representing how documents should be indexed. */
+    /** Configuration representing how documents should be indexed */
     indexingConfig: Record<string, unknown>;
 }

package/dist/api/types/ModelVersionRead.d.ts

@@ -7,13 +7,13 @@ export interface ModelVersionRead {
     id: string;
     /** Timestamp of when this model version was created. */
     created: string;
-    /** Human-friendly name for this model version. */
+    /** Human-friendly name for this model version. <span style="white-space: nowrap">`<= 150 characters`</span> */
     label: string;
     /** The type of task this model is used for. */
     modelType: Vellum.ModelTypeEnum;
     /** Which LLM provider this model version is associated with. */
     provider: Vellum.ProviderEnum;
-    /** The unique id of this model version as it exists in the above provider's system. */
+    /** The unique id of this model version as it exists in the above provider's system. <span style="white-space: nowrap">`<= 250 characters`</span> */
     externalId: string;
     /** Configuration used to build this model version. */
     buildConfig: Vellum.ModelVersionBuildConfig;

package/dist/api/types/ModelVersionSandboxSnapshot.d.ts

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

package/dist/api/types/ProcessingFailureReasonEnum.d.ts

@@ -2,6 +2,3 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare type ProcessingFailureReasonEnum = "EXCEEDED_CHARACTER_LIMIT";
-export declare const ProcessingFailureReasonEnum: {
-    readonly ExceededCharacterLimit: "EXCEEDED_CHARACTER_LIMIT";
-};

package/dist/api/types/ProcessingFailureReasonEnum.js

@@ -3,7 +3,3 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessingFailureReasonEnum = void 0;
-exports.ProcessingFailureReasonEnum = {
-    ExceededCharacterLimit: "EXCEEDED_CHARACTER_LIMIT",
-};

package/dist/api/types/PromptTemplateBlockRequest.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "..";
 export interface PromptTemplateBlockRequest {
+    /** <span style="white-space: nowrap">`non-empty`</span> */
     id: string;
     blockType: Vellum.BlockTypeEnum;
     properties: Vellum.PromptTemplateBlockPropertiesRequest;

package/dist/api/types/PromptTemplateInputVariableRequest.d.ts

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface PromptTemplateInputVariableRequest {
-    /** The name of the input variable. */
+    /** The name of the input variable. <span style="white-space: nowrap">`non-empty`</span> */
     key: string;
 }

package/dist/api/types/RegisterPromptPromptInfoRequest.d.ts

@@ -4,7 +4,7 @@
 import * as Vellum from "..";
 export interface RegisterPromptPromptInfoRequest {
     promptSyntaxVersion?: number;
-    promptBlockData?: Vellum.PromptTemplateBlockDataRequest;
+    promptBlockData: Vellum.PromptTemplateBlockDataRequest;
     /** Names of the input variables specified in the prompt template. */
-    inputVariables?: Vellum.PromptTemplateInputVariableRequest[];
+    inputVariables: Vellum.PromptTemplateInputVariableRequest[];
 }

package/dist/api/types/ScenarioInputRequest.d.ts

@@ -3,6 +3,7 @@
  */
 import * as Vellum from "..";
 export interface ScenarioInputRequest {
+    /** <span style="white-space: nowrap">`non-empty`</span> */
     key: string;
     type?: Vellum.TypeEnum;
     value?: string;

package/dist/api/types/SlimDocument.d.ts

@@ -9,7 +9,7 @@ export interface SlimDocument {
     externalId?: string;
     /** A timestamp representing when this document was most recently uploaded. */
     lastUploadedAt: string;
-    /** Human-friendly name for this document. */
+    /** Human-friendly name for this document. <span style="white-space: nowrap">`<= 1000 characters`</span> */
     label: string;
     /** An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle. */
     processingState?: Vellum.ProcessingStateEnum;

package/dist/api/types/SlimDocumentStatusEnum.d.ts

@@ -2,6 +2,3 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare type SlimDocumentStatusEnum = "ACTIVE";
-export declare const SlimDocumentStatusEnum: {
-    readonly Active: "ACTIVE";
-};

package/dist/api/types/SlimDocumentStatusEnum.js

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

package/dist/serialization/types/ModelVersionSandboxSnapshot.d.ts

@@ -10,6 +10,6 @@ export declare namespace ModelVersionSandboxSnapshot {
         id: string;
         prompt_index?: number | null;
         prompt_id?: string | null;
-        sandbox_id: string;
+        sandbox_id?: string | null;
     }
 }

package/dist/serialization/types/ModelVersionSandboxSnapshot.js

@@ -32,5 +32,5 @@ exports.ModelVersionSandboxSnapshot = core.serialization.object({
     id: core.serialization.string(),
     promptIndex: core.serialization.property("prompt_index", core.serialization.number().optional()),
     promptId: core.serialization.property("prompt_id", core.serialization.string().optional()),
-    sandboxId: core.serialization.property("sandbox_id", core.serialization.string()),
+    sandboxId: core.serialization.property("sandbox_id", core.serialization.string().optional()),
 });

package/dist/serialization/types/ProcessingFailureReasonEnum.js

@@ -28,4 +28,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProcessingFailureReasonEnum = void 0;
 const core = __importStar(require("../../core"));
-exports.ProcessingFailureReasonEnum = core.serialization.enum_(["EXCEEDED_CHARACTER_LIMIT"]);
+exports.ProcessingFailureReasonEnum = core.serialization.stringLiteral("EXCEEDED_CHARACTER_LIMIT");

package/dist/serialization/types/RegisterPromptPromptInfoRequest.d.ts

@@ -8,7 +8,7 @@ export declare const RegisterPromptPromptInfoRequest: core.serialization.ObjectS
 export declare namespace RegisterPromptPromptInfoRequest {
     interface Raw {
         prompt_syntax_version?: number | null;
-        prompt_block_data?: serializers.PromptTemplateBlockDataRequest.Raw | null;
-        input_variables?: serializers.PromptTemplateInputVariableRequest.Raw[] | null;
+        prompt_block_data: serializers.PromptTemplateBlockDataRequest.Raw;
+        input_variables: serializers.PromptTemplateInputVariableRequest.Raw[];
     }
 }

package/dist/serialization/types/RegisterPromptPromptInfoRequest.js

@@ -30,8 +30,6 @@ exports.RegisterPromptPromptInfoRequest = void 0;
 const core = __importStar(require("../../core"));
 exports.RegisterPromptPromptInfoRequest = core.serialization.object({
     promptSyntaxVersion: core.serialization.property("prompt_syntax_version", core.serialization.number().optional()),
-    promptBlockData: core.serialization.property("prompt_block_data", core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateBlockDataRequest).optional()),
-    inputVariables: core.serialization.property("input_variables", core.serialization
-        .list(core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateInputVariableRequest))
-        .optional()),
+    promptBlockData: core.serialization.property("prompt_block_data", core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateBlockDataRequest)),
+    inputVariables: core.serialization.property("input_variables", core.serialization.list(core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateInputVariableRequest))),
 });

package/dist/serialization/types/SlimDocumentStatusEnum.js

@@ -28,4 +28,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SlimDocumentStatusEnum = void 0;
 const core = __importStar(require("../../core"));
-exports.SlimDocumentStatusEnum = core.serialization.enum_(["ACTIVE"]);
+exports.SlimDocumentStatusEnum = core.serialization.stringLiteral("ACTIVE");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vellum-ai",
-    "version": "v0.0.16",
+    "version": "v0.0.17",
     "private": false,
     "repository": "https://github.com/vellum-ai/vellum-client-node",
     "main": "./index.js",

package/serialization/types/ModelVersionSandboxSnapshot.d.ts

@@ -10,6 +10,6 @@ export declare namespace ModelVersionSandboxSnapshot {
         id: string;
         prompt_index?: number | null;
         prompt_id?: string | null;
-        sandbox_id: string;
+        sandbox_id?: string | null;
     }
 }

package/serialization/types/ModelVersionSandboxSnapshot.js

@@ -32,5 +32,5 @@ exports.ModelVersionSandboxSnapshot = core.serialization.object({
     id: core.serialization.string(),
     promptIndex: core.serialization.property("prompt_index", core.serialization.number().optional()),
     promptId: core.serialization.property("prompt_id", core.serialization.string().optional()),
-    sandboxId: core.serialization.property("sandbox_id", core.serialization.string()),
+    sandboxId: core.serialization.property("sandbox_id", core.serialization.string().optional()),
 });

package/serialization/types/ProcessingFailureReasonEnum.js

@@ -28,4 +28,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProcessingFailureReasonEnum = void 0;
 const core = __importStar(require("../../core"));
-exports.ProcessingFailureReasonEnum = core.serialization.enum_(["EXCEEDED_CHARACTER_LIMIT"]);
+exports.ProcessingFailureReasonEnum = core.serialization.stringLiteral("EXCEEDED_CHARACTER_LIMIT");

package/serialization/types/RegisterPromptPromptInfoRequest.d.ts

@@ -8,7 +8,7 @@ export declare const RegisterPromptPromptInfoRequest: core.serialization.ObjectS
 export declare namespace RegisterPromptPromptInfoRequest {
     interface Raw {
         prompt_syntax_version?: number | null;
-        prompt_block_data?: serializers.PromptTemplateBlockDataRequest.Raw | null;
-        input_variables?: serializers.PromptTemplateInputVariableRequest.Raw[] | null;
+        prompt_block_data: serializers.PromptTemplateBlockDataRequest.Raw;
+        input_variables: serializers.PromptTemplateInputVariableRequest.Raw[];
     }
 }

package/serialization/types/RegisterPromptPromptInfoRequest.js

@@ -30,8 +30,6 @@ exports.RegisterPromptPromptInfoRequest = void 0;
 const core = __importStar(require("../../core"));
 exports.RegisterPromptPromptInfoRequest = core.serialization.object({
     promptSyntaxVersion: core.serialization.property("prompt_syntax_version", core.serialization.number().optional()),
-    promptBlockData: core.serialization.property("prompt_block_data", core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateBlockDataRequest).optional()),
-    inputVariables: core.serialization.property("input_variables", core.serialization
-        .list(core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateInputVariableRequest))
-        .optional()),
+    promptBlockData: core.serialization.property("prompt_block_data", core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateBlockDataRequest)),
+    inputVariables: core.serialization.property("input_variables", core.serialization.list(core.serialization.lazyObject(async () => (await Promise.resolve().then(() => __importStar(require("..")))).PromptTemplateInputVariableRequest))),
 });

package/serialization/types/SlimDocumentStatusEnum.js

@@ -28,4 +28,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SlimDocumentStatusEnum = void 0;
 const core = __importStar(require("../../core"));
-exports.SlimDocumentStatusEnum = core.serialization.enum_(["ACTIVE"]);
+exports.SlimDocumentStatusEnum = core.serialization.stringLiteral("ACTIVE");