vellum-ai 0.0.17 → 0.0.19

package/api/types/index.d.ts

@@ -2,6 +2,14 @@ export * from "./BlockTypeEnum";
 export * from "./ChatMessage";
 export * from "./ChatMessageRequest";
 export * from "./ChatMessageRole";
+export * from "./ConditionalNodeResult";
+export * from "./ConditionalNodeResultData";
+export * from "./ConstantValueChatHistoryVariable";
+export * from "./ConstantValueJsonVariable";
+export * from "./ConstantValueStringVariable";
+export * from "./ContentType";
+export * from "./DeploymentNodeResult";
+export * from "./DeploymentNodeResultData";
 export * from "./DeploymentRead";
 export * from "./DeploymentReadStatusEnum";
 export * from "./Document";
@@ -29,8 +37,8 @@ export * from "./ModelTypeEnum";
 export * from "./ModelVersionBuildConfig";
 export * from "./ModelVersionCompilePromptResponse";
 export * from "./ModelVersionCompiledPrompt";
+export * from "./ModelVersionExecConfig";
 export * from "./ModelVersionExecConfigParameters";
-export * from "./ModelVersionExecConfigRead";
 export * from "./ModelVersionRead";
 export * from "./ModelVersionReadStatusEnum";
 export * from "./ModelVersionSandboxSnapshot";
@@ -39,6 +47,8 @@ export * from "./NormalizedTokenLogProbs";
 export * from "./PaginatedSlimDocumentList";
 export * from "./ProcessingFailureReasonEnum";
 export * from "./ProcessingStateEnum";
+export * from "./PromptNodeResult";
+export * from "./PromptNodeResultData";
 export * from "./PromptTemplateBlock";
 export * from "./PromptTemplateBlockData";
 export * from "./PromptTemplateBlockDataRequest";
@@ -59,11 +69,16 @@ export * from "./RegisteredPromptSandbox";
 export * from "./RegisteredPromptSandboxSnapshot";
 export * from "./SandboxMetricInputParams";
 export * from "./SandboxMetricInputParamsRequest";
+export * from "./SandboxNodeResult";
+export * from "./SandboxNodeResultData";
 export * from "./SandboxScenario";
 export * from "./ScenarioInput";
 export * from "./ScenarioInputRequest";
+export * from "./ScenarioInputTypeEnum";
 export * from "./SearchErrorResponse";
 export * from "./SearchFiltersRequest";
+export * from "./SearchNodeResult";
+export * from "./SearchNodeResultData";
 export * from "./SearchRequestOptionsRequest";
 export * from "./SearchResponse";
 export * from "./SearchResult";
@@ -73,7 +88,21 @@ export * from "./SlimDocument";
 export * from "./SlimDocumentStatusEnum";
 export * from "./SubmitCompletionActualRequest";
 export * from "./SubmitCompletionActualsErrorResponse";
+export * from "./TerminalNodeResult";
+export * from "./TerminalNodeResultData";
+export * from "./TerminalNodeResultOutput";
 export * from "./TestSuiteTestCase";
-export * from "./TypeEnum";
 export * from "./UploadDocumentErrorResponse";
 export * from "./UploadDocumentResponse";
+export * from "./WorkflowExecutionNodeResultEvent";
+export * from "./WorkflowExecutionWorkflowResultEvent";
+export * from "./WorkflowNodeResultData";
+export * from "./WorkflowNodeResultEvent";
+export * from "./WorkflowNodeResultEventStateEnum";
+export * from "./WorkflowRequestChatHistoryInputRequest";
+export * from "./WorkflowRequestInputRequest";
+export * from "./WorkflowRequestJsonInputRequest";
+export * from "./WorkflowRequestStringInputRequest";
+export * from "./WorkflowResultEvent";
+export * from "./WorkflowResultEventStateEnum";
+export * from "./WorkflowStreamEvent";

package/api/types/index.js

@@ -18,6 +18,14 @@ __exportStar(require("./BlockTypeEnum"), exports);
 __exportStar(require("./ChatMessage"), exports);
 __exportStar(require("./ChatMessageRequest"), exports);
 __exportStar(require("./ChatMessageRole"), exports);
+__exportStar(require("./ConditionalNodeResult"), exports);
+__exportStar(require("./ConditionalNodeResultData"), exports);
+__exportStar(require("./ConstantValueChatHistoryVariable"), exports);
+__exportStar(require("./ConstantValueJsonVariable"), exports);
+__exportStar(require("./ConstantValueStringVariable"), exports);
+__exportStar(require("./ContentType"), exports);
+__exportStar(require("./DeploymentNodeResult"), exports);
+__exportStar(require("./DeploymentNodeResultData"), exports);
 __exportStar(require("./DeploymentRead"), exports);
 __exportStar(require("./DeploymentReadStatusEnum"), exports);
 __exportStar(require("./Document"), exports);
@@ -45,8 +53,8 @@ __exportStar(require("./ModelTypeEnum"), exports);
 __exportStar(require("./ModelVersionBuildConfig"), exports);
 __exportStar(require("./ModelVersionCompilePromptResponse"), exports);
 __exportStar(require("./ModelVersionCompiledPrompt"), exports);
+__exportStar(require("./ModelVersionExecConfig"), exports);
 __exportStar(require("./ModelVersionExecConfigParameters"), exports);
-__exportStar(require("./ModelVersionExecConfigRead"), exports);
 __exportStar(require("./ModelVersionRead"), exports);
 __exportStar(require("./ModelVersionReadStatusEnum"), exports);
 __exportStar(require("./ModelVersionSandboxSnapshot"), exports);
@@ -55,6 +63,8 @@ __exportStar(require("./NormalizedTokenLogProbs"), exports);
 __exportStar(require("./PaginatedSlimDocumentList"), exports);
 __exportStar(require("./ProcessingFailureReasonEnum"), exports);
 __exportStar(require("./ProcessingStateEnum"), exports);
+__exportStar(require("./PromptNodeResult"), exports);
+__exportStar(require("./PromptNodeResultData"), exports);
 __exportStar(require("./PromptTemplateBlock"), exports);
 __exportStar(require("./PromptTemplateBlockData"), exports);
 __exportStar(require("./PromptTemplateBlockDataRequest"), exports);
@@ -75,11 +85,16 @@ __exportStar(require("./RegisteredPromptSandbox"), exports);
 __exportStar(require("./RegisteredPromptSandboxSnapshot"), exports);
 __exportStar(require("./SandboxMetricInputParams"), exports);
 __exportStar(require("./SandboxMetricInputParamsRequest"), exports);
+__exportStar(require("./SandboxNodeResult"), exports);
+__exportStar(require("./SandboxNodeResultData"), exports);
 __exportStar(require("./SandboxScenario"), exports);
 __exportStar(require("./ScenarioInput"), exports);
 __exportStar(require("./ScenarioInputRequest"), exports);
+__exportStar(require("./ScenarioInputTypeEnum"), exports);
 __exportStar(require("./SearchErrorResponse"), exports);
 __exportStar(require("./SearchFiltersRequest"), exports);
+__exportStar(require("./SearchNodeResult"), exports);
+__exportStar(require("./SearchNodeResultData"), exports);
 __exportStar(require("./SearchRequestOptionsRequest"), exports);
 __exportStar(require("./SearchResponse"), exports);
 __exportStar(require("./SearchResult"), exports);
@@ -89,7 +104,21 @@ __exportStar(require("./SlimDocument"), exports);
 __exportStar(require("./SlimDocumentStatusEnum"), exports);
 __exportStar(require("./SubmitCompletionActualRequest"), exports);
 __exportStar(require("./SubmitCompletionActualsErrorResponse"), exports);
+__exportStar(require("./TerminalNodeResult"), exports);
+__exportStar(require("./TerminalNodeResultData"), exports);
+__exportStar(require("./TerminalNodeResultOutput"), exports);
 __exportStar(require("./TestSuiteTestCase"), exports);
-__exportStar(require("./TypeEnum"), exports);
 __exportStar(require("./UploadDocumentErrorResponse"), exports);
 __exportStar(require("./UploadDocumentResponse"), exports);
+__exportStar(require("./WorkflowExecutionNodeResultEvent"), exports);
+__exportStar(require("./WorkflowExecutionWorkflowResultEvent"), exports);
+__exportStar(require("./WorkflowNodeResultData"), exports);
+__exportStar(require("./WorkflowNodeResultEvent"), exports);
+__exportStar(require("./WorkflowNodeResultEventStateEnum"), exports);
+__exportStar(require("./WorkflowRequestChatHistoryInputRequest"), exports);
+__exportStar(require("./WorkflowRequestInputRequest"), exports);
+__exportStar(require("./WorkflowRequestJsonInputRequest"), exports);
+__exportStar(require("./WorkflowRequestStringInputRequest"), exports);
+__exportStar(require("./WorkflowResultEvent"), exports);
+__exportStar(require("./WorkflowResultEventStateEnum"), exports);
+__exportStar(require("./WorkflowStreamEvent"), exports);

package/dist/Client.d.ts

@@ -20,6 +20,12 @@ export declare namespace VellumClient {
 export declare class VellumClient {
     protected readonly options: VellumClient.Options;
     constructor(options: VellumClient.Options);
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Executes a deployed Workflow and streams back its results.
+     */
+    executeWorkflowStream(request: Vellum.ExecuteWorkflowStreamRequest, cb: (data: Vellum.WorkflowStreamEvent) => 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>
      *
@@ -27,6 +33,7 @@ export declare class VellumClient {
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.ForbiddenError}
      * @throws {Vellum.NotFoundError}
      * @throws {Vellum.InternalServerError}
      */
@@ -38,6 +45,7 @@ export declare class VellumClient {
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.ForbiddenError}
      * @throws {Vellum.NotFoundError}
      * @throws {Vellum.InternalServerError}
      */

package/dist/Client.js

@@ -48,6 +48,40 @@ class VellumClient {
     constructor(options) {
         this.options = options;
     }
+    /**
+     * <strong style="background-color:#ffc107; color:white; padding:4px; border-radius:4px">Unstable</strong>
+     *
+     * Executes a deployed Workflow and streams back its results.
+     */
+    async executeWorkflowStream(request, cb, opts) {
+        const _queue = new core.CallbackQueue();
+        await core.streamingFetcher({
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/execute-workflow-stream"),
+            method: "POST",
+            headers: {
+                X_API_KEY: await core.Supplier.get(this.options.apiKey),
+            },
+            body: await serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, {
+                unrecognizedObjectKeys: "strip",
+            }),
+            onData: _queue.wrap(async (data) => {
+                const parsed = await serializers.WorkflowStreamEvent.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>
      *
@@ -55,6 +89,7 @@ class VellumClient {
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.ForbiddenError}
      * @throws {Vellum.NotFoundError}
      * @throws {Vellum.InternalServerError}
      */
@@ -79,6 +114,12 @@ class VellumClient {
             switch (_response.error.statusCode) {
                 case 400:
                     throw new Vellum.BadRequestError(_response.error.body);
+                case 403:
+                    throw new Vellum.ForbiddenError(await serializers.GenerateErrorResponse.parseOrThrow(_response.error.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                    }));
                 case 404:
                     throw new Vellum.NotFoundError(_response.error.body);
                 case 500:
@@ -111,13 +152,14 @@ class VellumClient {
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
      * @throws {Vellum.BadRequestError}
+     * @throws {Vellum.ForbiddenError}
      * @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"),
+            url: (0, url_join_1.default)((this.options.environment ?? environments.VellumEnvironment.Production).predict, "v1/generate-stream"),
             method: "POST",
             headers: {
                 X_API_KEY: await core.Supplier.get(this.options.apiKey),

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../..";
+export interface ExecuteWorkflowStreamRequest {
+    /** The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name. */
+    workflowDeploymentId?: string;
+    /** The name of the Workflow Deployment. Must provide either this or workflow_deployment_id. */
+    workflowDeploymentName?: string;
+    /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
+    releaseTag?: string;
+    inputs: Vellum.WorkflowRequestInputRequest[];
+    /** Optionally include a unique identifier for tracking purposes. */
+    externalId?: string;
+}

package/dist/api/client/requests/ExecuteWorkflowStreamRequest.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/dist/api/client/requests/index.d.ts

@@ -1,3 +1,4 @@
+export { ExecuteWorkflowStreamRequest } from "./ExecuteWorkflowStreamRequest";
 export { GenerateBodyRequest } from "./GenerateBodyRequest";
 export { GenerateStreamBodyRequest } from "./GenerateStreamBodyRequest";
 export { SearchRequestBodyRequest } from "./SearchRequestBodyRequest";

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

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

package/dist/api/errors/ForbiddenError.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.ForbiddenError = void 0;
+const errors = __importStar(require("../../errors"));
+class ForbiddenError extends errors.VellumError {
+    constructor(body) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
+exports.ForbiddenError = ForbiddenError;

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

@@ -1,4 +1,5 @@
 export * from "./BadRequestError";
+export * from "./ForbiddenError";
 export * from "./NotFoundError";
 export * from "./ConflictError";
 export * from "./InternalServerError";

package/dist/api/errors/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError"), exports);
+__exportStar(require("./ForbiddenError"), exports);
 __exportStar(require("./NotFoundError"), exports);
 __exportStar(require("./ConflictError"), exports);
 __exportStar(require("./InternalServerError"), exports);

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

@@ -7,8 +7,21 @@ export interface DocumentIndexCreateRequest {
     label: string;
     /** 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 */
+    /**
+     * The current status of the document index
+     *
+     * * `ACTIVE` - Active
+     * * `ARCHIVED` - Archived
+     */
     status?: Vellum.DocumentIndexStatus;
+    /**
+     * The environment this document index is used in
+     *
+     * * `DEVELOPMENT` - Development
+     * * `STAGING` - Staging
+     * * `PRODUCTION` - Production
+     */
+    environment?: Vellum.EnvironmentEnum;
     /** 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 */

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

@@ -9,7 +9,17 @@ export interface RegisterPromptRequestRequest {
     name: string;
     /** Information about how to execute the prompt template. */
     prompt: Vellum.RegisterPromptPromptInfoRequest;
-    /** The initial LLM provider to use for this prompt */
+    /**
+     * The initial LLM provider to use for this prompt
+     *
+     * * `ANTHROPIC` - Anthropic
+     * * `COHERE` - Cohere
+     * * `GOOGLE` - Google
+     * * `HOSTED` - Hosted
+     * * `MOSAICML` - MosaicML
+     * * `OPENAI` - OpenAI
+     * * `PYQ` - Pyq
+     */
     provider: Vellum.ProviderEnum;
     /** The initial model to use for this prompt <span style="white-space: nowrap">`non-empty`</span> */
     model: string;

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

@@ -1,9 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type BlockTypeEnum = "CHAT_MESSAGE" | "CHAT_HISTORY" | "JINJA";
+/**
+ * * `CHAT_MESSAGE` - CHAT_MESSAGE
+ * * `CHAT_HISTORY` - CHAT_HISTORY
+ * * `JINJA` - JINJA
+ * * `FUNCTION_DEFINITION` - FUNCTION_DEFINITION
+ */
+export declare type BlockTypeEnum = "CHAT_MESSAGE" | "CHAT_HISTORY" | "JINJA" | "FUNCTION_DEFINITION";
 export declare const BlockTypeEnum: {
     readonly ChatMessage: "CHAT_MESSAGE";
     readonly ChatHistory: "CHAT_HISTORY";
     readonly Jinja: "JINJA";
+    readonly FunctionDefinition: "FUNCTION_DEFINITION";
 };

package/dist/api/types/BlockTypeEnum.js

@@ -8,4 +8,5 @@ exports.BlockTypeEnum = {
     ChatMessage: "CHAT_MESSAGE",
     ChatHistory: "CHAT_HISTORY",
     Jinja: "JINJA",
+    FunctionDefinition: "FUNCTION_DEFINITION",
 };

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

@@ -1,9 +1,16 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ChatMessageRole = "SYSTEM" | "ASSISTANT" | "USER";
+/**
+ * * `SYSTEM` - System
+ * * `ASSISTANT` - Assistant
+ * * `USER` - User
+ * * `FUNCTION` - Function
+ */
+export declare type ChatMessageRole = "SYSTEM" | "ASSISTANT" | "USER" | "FUNCTION";
 export declare const ChatMessageRole: {
     readonly System: "SYSTEM";
     readonly Assistant: "ASSISTANT";
     readonly User: "USER";
+    readonly Function: "FUNCTION";
 };

package/dist/api/types/ChatMessageRole.js

@@ -8,4 +8,5 @@ exports.ChatMessageRole = {
     System: "SYSTEM",
     Assistant: "ASSISTANT",
     User: "USER",
+    Function: "FUNCTION",
 };

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ConditionalNodeResult {
+    data: Vellum.ConditionalNodeResultData;
+}

package/dist/api/types/ConditionalNodeResult.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/dist/api/types/ConditionalNodeResultData.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConditionalNodeResultData {
+    sourceHandleId?: string;
+}

package/dist/api/types/ConditionalNodeResultData.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/dist/api/types/ConstantValueChatHistoryVariable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface ConstantValueChatHistoryVariable {
+    value?: Vellum.ChatMessage[];
+}

package/dist/api/types/ConstantValueChatHistoryVariable.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/dist/api/types/ConstantValueJsonVariable.d.ts

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

package/dist/api/types/ConstantValueJsonVariable.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/dist/api/types/ConstantValueStringVariable.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ConstantValueStringVariable {
+    value?: string;
+}

package/dist/api/types/ConstantValueStringVariable.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/dist/api/types/ContentType.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * * `STRING` - STRING
+ * * `JSON` - JSON
+ */
+export declare type ContentType = "STRING" | "JSON";
+export declare const ContentType: {
+    readonly String: "STRING";
+    readonly Json: "JSON";
+};

package/dist/api/types/ContentType.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentType = void 0;
+exports.ContentType = {
+    String: "STRING",
+    Json: "JSON",
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface DeploymentNodeResult {
+    data: Vellum.DeploymentNodeResultData;
+}

package/dist/api/types/DeploymentNodeResult.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/dist/api/types/DeploymentNodeResultData.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DeploymentNodeResultData {
+    outputId: string;
+    text?: string;
+    delta?: string;
+}

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

@@ -9,11 +9,28 @@ export interface DeploymentRead {
     label: string;
     /** 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 */
+    /**
+     * The current status of the deployment
+     *
+     * * `ACTIVE` - Active
+     * * `INACTIVE` - Inactive
+     * * `ARCHIVED` - Archived
+     */
     status?: Vellum.DeploymentReadStatusEnum;
-    /** The environment this deployment is used in */
+    /**
+     * The environment this deployment is used in
+     *
+     * * `DEVELOPMENT` - Development
+     * * `STAGING` - Staging
+     * * `PRODUCTION` - Production
+     */
     environment?: Vellum.EnvironmentEnum;
-    /** The type of model this deployment serves */
+    /**
+     * The type of model this deployment serves
+     *
+     * * `GENERATE` - Generate
+     * * `CLASSIFY` - Classify
+     */
     modelType: Vellum.ModelTypeEnum;
     activeModelVersionIds: string[];
     lastDeployedOn: string;

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

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

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

@@ -7,6 +7,14 @@ export interface DocumentDocumentToDocumentIndex {
     id: string;
     /** Vellum-generated ID that uniquely identifies the index this document is included in. */
     documentIndexId: string;
-    /** An enum value representing where this document is along its indexing lifecycle for this index. */
+    /**
+     * An enum value representing where this document is along its indexing lifecycle for this index.
+     *
+     * * `AWAITING_PROCESSING` - Awaiting Processing
+     * * `QUEUED` - Queued
+     * * `INDEXING` - Indexing
+     * * `INDEXED` - Indexed
+     * * `FAILED` - Failed
+     */
     indexingState?: Vellum.IndexingStateEnum;
 }