vellum-ai 0.0.17 → 0.0.19

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

@@ -9,8 +9,21 @@ export interface DocumentIndexRead {
     label: string;
     /** 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 */
+    /**
+     * 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>;
 }

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

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

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

@@ -9,10 +9,17 @@ export interface EnrichedNormalizedCompletion {
     externalId?: string;
     /** The text generated by the LLM. */
     text: string;
-    /** The reason the generation finished. */
+    /**
+     * The reason the generation finished.
+     *
+     * * `LENGTH` - LENGTH
+     * * `STOP` - STOP
+     * * `UNKNOWN` - UNKNOWN
+     */
     finishReason?: Vellum.FinishReasonEnum;
     /** The logprobs of the completion. Only present if specified in the original request options. */
     logprobs?: Vellum.NormalizedLogProbs;
     /** The ID of the model version used to generate this completion. */
     modelVersionId: string;
+    type?: Vellum.ContentType;
 }

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

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

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

@@ -1,6 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * * `LENGTH` - LENGTH
+ * * `STOP` - STOP
+ * * `UNKNOWN` - UNKNOWN
+ */
 export declare type FinishReasonEnum = "LENGTH" | "STOP" | "UNKNOWN";
 export declare const FinishReasonEnum: {
     readonly Length: "LENGTH";

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

@@ -3,6 +3,11 @@
  */
 import * as Vellum from "..";
 export interface GenerateOptionsRequest {
-    /** Which logprobs to include, if any. Defaults to NONE. */
+    /**
+     * Which logprobs to include, if any. Defaults to NONE.
+     *
+     * * `ALL` - ALL
+     * * `NONE` - NONE
+     */
     logprobs?: Vellum.LogprobsEnum;
 }

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

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * * `AWAITING_PROCESSING` - Awaiting Processing
+ * * `QUEUED` - Queued
+ * * `INDEXING` - Indexing
+ * * `INDEXED` - Indexed
+ * * `FAILED` - Failed
+ */
 export declare type IndexingStateEnum = "AWAITING_PROCESSING" | "QUEUED" | "INDEXING" | "INDEXED" | "FAILED";
 export declare const IndexingStateEnum: {
     readonly AwaitingProcessing: "AWAITING_PROCESSING";

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

@@ -1,6 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * * `ALL` - ALL
+ * * `NONE` - NONE
+ */
 export declare type LogprobsEnum = "ALL" | "NONE";
 export declare const LogprobsEnum: {
     readonly All: "ALL";

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

@@ -1,6 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * * `GENERATE` - Generate
+ * * `CLASSIFY` - Classify
+ */
 export declare type ModelTypeEnum = "GENERATE" | "CLASSIFY";
 export declare const ModelTypeEnum: {
     readonly Generate: "GENERATE";

package/dist/api/types/{ModelVersionExecConfigRead.d.ts → ModelVersionExecConfig.d.ts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "..";
-export interface ModelVersionExecConfigRead {
+export interface ModelVersionExecConfig {
     /** The generation parameters that are passed to the LLM provider at runtime. */
     parameters: Vellum.ModelVersionExecConfigParameters;
     /** Names of the input variables specified in the prompt template. */
@@ -10,5 +10,5 @@ export interface ModelVersionExecConfigRead {
     /** The template used to generate prompts for this model version. */
     promptTemplate?: string;
     promptBlockData?: Vellum.PromptTemplateBlockData;
-    promptSyntaxVersion: number;
+    promptSyntaxVersion?: number;
 }

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

@@ -4,10 +4,10 @@
 export interface ModelVersionExecConfigParameters {
     temperature: number;
     maxTokens: number;
-    stop?: string[];
     topP: number;
-    topK?: number;
     frequencyPenalty: number;
     presencePenalty: number;
     logitBias?: Record<string, number | undefined>;
+    stop?: string[];
+    topK?: number;
 }

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

@@ -9,15 +9,30 @@ export interface ModelVersionRead {
     created: string;
     /** 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. */
+    /**
+     * The type of task this model is used for.
+     *
+     * * `GENERATE` - Generate
+     * * `CLASSIFY` - Classify
+     */
     modelType: Vellum.ModelTypeEnum;
-    /** Which LLM provider this model version is associated with. */
+    /**
+     * Which LLM provider this model version is associated with.
+     *
+     * * `ANTHROPIC` - Anthropic
+     * * `COHERE` - Cohere
+     * * `GOOGLE` - Google
+     * * `HOSTED` - Hosted
+     * * `MOSAICML` - MosaicML
+     * * `OPENAI` - OpenAI
+     * * `PYQ` - Pyq
+     */
     provider: Vellum.ProviderEnum;
     /** 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;
     /** Configuration used to execute this model version. */
-    execConfig: Vellum.ModelVersionExecConfigRead;
+    execConfig: Vellum.ModelVersionExecConfig;
     status?: Vellum.ModelVersionReadStatusEnum;
 }

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

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * * `CREATING` - Creating
+ * * `READY` - Ready
+ * * `CREATION_FAILED` - Creation Failed
+ * * `DISABLED` - Disabled
+ */
 export declare type ModelVersionReadStatusEnum = "CREATING" | "READY" | "CREATION_FAILED" | "DISABLED";
 export declare const ModelVersionReadStatusEnum: {
     readonly Creating: "CREATING";

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

@@ -1,6 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * * `QUEUED` - Queued
+ * * `PROCESSING` - Processing
+ * * `PROCESSED` - Processed
+ * * `FAILED` - Failed
+ */
 export declare type ProcessingStateEnum = "QUEUED" | "PROCESSING" | "PROCESSED" | "FAILED";
 export declare const ProcessingStateEnum: {
     readonly Queued: "QUEUED";

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

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

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

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

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

@@ -6,5 +6,9 @@ export interface PromptTemplateBlockProperties {
     chatRole?: Vellum.ChatMessageRole;
     chatMessageUnterminated?: boolean;
     template?: string;
-    blocks?: Record<string, unknown>[];
+    templateType?: Vellum.ContentType;
+    functionName?: string;
+    functionDescription?: string;
+    functionParameters?: Record<string, unknown>;
+    blocks?: Vellum.PromptTemplateBlock[];
 }

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

@@ -6,5 +6,11 @@ export interface PromptTemplateBlockPropertiesRequest {
     chatRole?: Vellum.ChatMessageRole;
     chatMessageUnterminated?: boolean;
     template?: string;
-    blocks?: Record<string, unknown>[];
+    templateType?: Vellum.ContentType;
+    /** <span style="white-space: nowrap">`non-empty`</span> */
+    functionName?: string;
+    /** <span style="white-space: nowrap">`non-empty`</span> */
+    functionDescription?: string;
+    functionParameters?: Record<string, unknown>;
+    blocks?: Vellum.PromptTemplateBlockRequest[];
 }

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

@@ -1,12 +1,22 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ProviderEnum = "ANTHROPIC" | "COHERE" | "GOOGLE" | "HOSTED" | "OPENAI" | "PYQ";
+/**
+ * * `ANTHROPIC` - Anthropic
+ * * `COHERE` - Cohere
+ * * `GOOGLE` - Google
+ * * `HOSTED` - Hosted
+ * * `MOSAICML` - MosaicML
+ * * `OPENAI` - OpenAI
+ * * `PYQ` - Pyq
+ */
+export declare type ProviderEnum = "ANTHROPIC" | "COHERE" | "GOOGLE" | "HOSTED" | "MOSAICML" | "OPENAI" | "PYQ";
 export declare const ProviderEnum: {
     readonly Anthropic: "ANTHROPIC";
     readonly Cohere: "COHERE";
     readonly Google: "GOOGLE";
     readonly Hosted: "HOSTED";
+    readonly Mosaicml: "MOSAICML";
     readonly Openai: "OPENAI";
     readonly Pyq: "PYQ";
 };

package/dist/api/types/ProviderEnum.js

@@ -9,6 +9,7 @@ exports.ProviderEnum = {
     Cohere: "COHERE",
     Google: "GOOGLE",
     Hosted: "HOSTED",
+    Mosaicml: "MOSAICML",
     Openai: "OPENAI",
     Pyq: "PYQ",
 };

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

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

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

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

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

@@ -4,7 +4,7 @@
 import * as Vellum from "..";
 export interface ScenarioInput {
     key: string;
-    type?: Vellum.TypeEnum;
+    type?: Vellum.ScenarioInputTypeEnum;
     value?: string;
     chatHistory?: Vellum.ChatMessage[];
 }

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * * `TEXT` - Text
+ * * `CHAT_HISTORY` - Chat History
+ */
+export declare type ScenarioInputTypeEnum = "TEXT" | "CHAT_HISTORY";
+export declare const ScenarioInputTypeEnum: {
+    readonly Text: "TEXT";
+    readonly ChatHistory: "CHAT_HISTORY";
+};

package/{api/types/TypeEnum.js → dist/api/types/ScenarioInputTypeEnum.js}

@@ -3,8 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeEnum = void 0;
-exports.TypeEnum = {
+exports.ScenarioInputTypeEnum = void 0;
+exports.ScenarioInputTypeEnum = {
     Text: "TEXT",
     ChatHistory: "CHAT_HISTORY",
 };

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SearchNodeResultData {
+    resultsOutputId: string;
+    results: Record<string, unknown>[];
+    textOutputId?: string;
+    text?: string;
+}

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

@@ -11,11 +11,26 @@ export interface SlimDocument {
     lastUploadedAt: string;
     /** 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. */
+    /**
+     * An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle.
+     *
+     * * `QUEUED` - Queued
+     * * `PROCESSING` - Processing
+     * * `PROCESSED` - Processed
+     * * `FAILED` - Failed
+     */
     processingState?: Vellum.ProcessingStateEnum;
-    /** An enum value representing why the document could not be processed. Is null unless processing_state is FAILED. */
+    /**
+     * An enum value representing why the document could not be processed. Is null unless processing_state is FAILED.
+     *
+     * * `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
+     */
     processingFailureReason?: Vellum.ProcessingFailureReasonEnum;
-    /** The document's current status. */
+    /**
+     * The document's current status.
+     *
+     * * `ACTIVE` - Active
+     */
     status?: Vellum.SlimDocumentStatusEnum;
     /** A list of keywords associated with this document. Originally provided when uploading the document. */
     keywords?: string[];

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

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type TerminalNodeResultOutput = Vellum.TerminalNodeResultOutput.String | Vellum.TerminalNodeResultOutput.Json | Vellum.TerminalNodeResultOutput.ChatHistory;
+export declare namespace TerminalNodeResultOutput {
+    interface String extends Vellum.ConstantValueStringVariable {
+        type: "STRING";
+    }
+    interface Json extends Vellum.ConstantValueJsonVariable {
+        type: "JSON";
+    }
+    interface ChatHistory extends Vellum.ConstantValueChatHistoryVariable {
+        type: "CHAT_HISTORY";
+    }
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface WorkflowExecutionNodeResultEvent {
+    runId: string;
+    externalId?: string;
+    data: Vellum.WorkflowNodeResultEvent;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface WorkflowExecutionWorkflowResultEvent {
+    runId: string;
+    externalId?: string;
+    data: Vellum.WorkflowResultEvent;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export declare type WorkflowNodeResultData = Vellum.WorkflowNodeResultData.Prompt | Vellum.WorkflowNodeResultData.Sandbox | Vellum.WorkflowNodeResultData.Deployment | Vellum.WorkflowNodeResultData.Search | Vellum.WorkflowNodeResultData.Conditional | Vellum.WorkflowNodeResultData.Terminal;
+export declare namespace WorkflowNodeResultData {
+    interface Prompt extends Vellum.PromptNodeResult {
+        type: "PROMPT";
+    }
+    interface Sandbox extends Vellum.SandboxNodeResult {
+        type: "SANDBOX";
+    }
+    interface Deployment extends Vellum.DeploymentNodeResult {
+        type: "DEPLOYMENT";
+    }
+    interface Search extends Vellum.SearchNodeResult {
+        type: "SEARCH";
+    }
+    interface Conditional extends Vellum.ConditionalNodeResult {
+        type: "CONDITIONAL";
+    }
+    interface Terminal extends Vellum.TerminalNodeResult {
+        type: "TERMINAL";
+    }
+}

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "..";
+export interface WorkflowNodeResultEvent {
+    id: string;
+    nodeId: string;
+    nodeResultId: string;
+    state: Vellum.WorkflowNodeResultEventStateEnum;
+    ts?: string;
+    data?: Vellum.WorkflowNodeResultData;
+    error?: string;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * * `INITIATED` - INITIATED
+ * * `STREAMING` - STREAMING
+ * * `FULFILLED` - FULFILLED
+ * * `REJECTED` - REJECTED
+ */
+export declare type WorkflowNodeResultEventStateEnum = "INITIATED" | "STREAMING" | "FULFILLED" | "REJECTED";
+export declare const WorkflowNodeResultEventStateEnum: {
+    readonly Initiated: "INITIATED";
+    readonly Streaming: "STREAMING";
+    readonly Fulfilled: "FULFILLED";
+    readonly Rejected: "REJECTED";
+};