vellum-ai 0.8.5 → 0.8.7

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

@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
 export declare namespace WorkflowSandboxes {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -20,7 +20,7 @@ export declare namespace WorkflowSandboxes {
 }
 export declare class WorkflowSandboxes {
     protected readonly _options: WorkflowSandboxes.Options;
-    constructor(_options: WorkflowSandboxes.Options);
+    constructor(_options?: WorkflowSandboxes.Options);
     /**
      * @param {string} id - A UUID string identifying this workflow sandbox.
      * @param {string} workflowId - An ID identifying the Workflow you'd like to deploy.
@@ -32,6 +32,6 @@ export declare class WorkflowSandboxes {
      */
     deployWorkflow(id: string, workflowId: string, request?: Vellum.DeploySandboxWorkflowRequest, requestOptions?: WorkflowSandboxes.RequestOptions): Promise<Vellum.WorkflowDeploymentRead>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        X_API_KEY: string;
+        X_API_KEY: string | undefined;
     }>;
 }

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

@@ -45,7 +45,7 @@ const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
 const errors = __importStar(require("../../../../errors/index"));
 class WorkflowSandboxes {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -64,7 +64,7 @@ class WorkflowSandboxes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/workflow-sandboxes/${encodeURIComponent(id)}/workflows/${encodeURIComponent(workflowId)}/deploy`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.5", "User-Agent": "vellum-ai/0.8.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.8.7", "User-Agent": "vellum-ai/0.8.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.DeploySandboxWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/api/types/AdHocExecutePromptEvent.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export declare type AdHocExecutePromptEvent = Vellum.InitiatedAdHocExecutePromptEvent | Vellum.StreamingAdHocExecutePromptEvent | Vellum.FulfilledAdHocExecutePromptEvent | Vellum.RejectedAdHocExecutePromptEvent;

package/api/types/AdHocExpandMetaRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AdHocExpandMetaRequest {
+    cost?: boolean;
+    /** If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt. */
+    modelName?: boolean;
+    /** If enabled, the response will include model host usage tracking. This may increase latency for some model hosts. */
+    usage?: boolean;
+    /** If enabled, the response will include the reason provided by the model for why the execution finished. */
+    finishReason?: boolean;
+}

package/api/types/AdHocFulfilledPromptExecutionMeta.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
+ */
+export interface AdHocFulfilledPromptExecutionMeta {
+    latency?: number;
+    finishReason?: Vellum.FinishReasonEnum;
+    usage?: Vellum.MlModelUsage;
+}

package/api/types/AdHocInitiatedPromptExecutionMeta.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
+ */
+export interface AdHocInitiatedPromptExecutionMeta {
+    modelName?: string;
+    latency?: number;
+}

package/api/types/AdHocRejectedPromptExecutionMeta.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
+ */
+export interface AdHocRejectedPromptExecutionMeta {
+    latency?: number;
+    finishReason?: Vellum.FinishReasonEnum;
+}

package/api/types/AdHocStreamingPromptExecutionMeta.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
+ */
+export interface AdHocStreamingPromptExecutionMeta {
+    latency?: number;
+}

package/api/types/ChatMessagePromptBlockPropertiesRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The properties of a ChatMessagePromptTemplateBlock
+ */
+export interface ChatMessagePromptBlockPropertiesRequest {
+    blocks: Vellum.PromptBlockRequest[];
+    chatRole?: Vellum.ChatMessageRole;
+    chatSource?: string;
+    chatMessageUnterminated?: boolean;
+}

package/api/types/ChatMessagePromptBlockRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * A block that represents a chat message in a prompt template.
+ */
+export interface ChatMessagePromptBlockRequest {
+    blockType: "CHAT_MESSAGE";
+    properties: Vellum.ChatMessagePromptBlockPropertiesRequest;
+    id: string;
+    state?: Vellum.PromptBlockState;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfigRequest;
+}

package/api/types/{MlModelDeveloperEnumValueLabel.d.ts → EphemeralPromptCacheConfigRequest.d.ts}

@@ -2,7 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../index";
-export interface MlModelDeveloperEnumValueLabel {
-    label: string;
-    value: Vellum.MlModelDeveloper;
+export interface EphemeralPromptCacheConfigRequest {
+    type?: Vellum.EphemeralPromptCacheConfigTypeEnum;
 }

package/api/types/EphemeralPromptCacheConfigTypeEnum.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * - `EPHEMERAL` - EPHEMERAL
+ */
+export declare type EphemeralPromptCacheConfigTypeEnum = "EPHEMERAL";

package/api/types/FulfilledAdHocExecutePromptEvent.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.
+ */
+export interface FulfilledAdHocExecutePromptEvent {
+    state: "FULFILLED";
+    outputs: Vellum.PromptOutput[];
+    executionId: string;
+    meta?: Vellum.AdHocFulfilledPromptExecutionMeta;
+}

package/api/types/FunctionDefinitionPromptBlockPropertiesRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface FunctionDefinitionPromptBlockPropertiesRequest {
+    /** The name identifying the function. */
+    functionName?: string;
+    /** A description to help guide the model when to invoke this function. */
+    functionDescription?: string;
+    /** An OpenAPI specification of parameters that are supported by this function. */
+    functionParameters?: Record<string, unknown>;
+    /** Set this option to true to force the model to return a function call of this function. */
+    functionForced?: boolean;
+    /** Set this option to use strict schema decoding when available. */
+    functionStrict?: boolean;
+}

package/api/types/FunctionDefinitionPromptBlockRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * A block that represents a function definition in a prompt template.
+ */
+export interface FunctionDefinitionPromptBlockRequest {
+    blockType: "FUNCTION_DEFINITION";
+    properties: Vellum.FunctionDefinitionPromptBlockPropertiesRequest;
+    id: string;
+    state?: Vellum.PromptBlockState;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfigRequest;
+}

package/api/types/InitiatedAdHocExecutePromptEvent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The initial data returned indicating that the response from the model has returned and begun streaming.
+ */
+export interface InitiatedAdHocExecutePromptEvent {
+    state: "INITIATED";
+    meta?: Vellum.AdHocInitiatedPromptExecutionMeta;
+    executionId: string;
+}

package/api/types/JinjaPromptBlockPropertiesRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export interface JinjaPromptBlockPropertiesRequest {
+    template?: string;
+    templateType?: Vellum.VellumVariableType;
+}

package/api/types/JinjaPromptBlockRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * A block of Jinja template code that is used to generate a prompt
+ */
+export interface JinjaPromptBlockRequest {
+    blockType: "JINJA";
+    properties: Vellum.JinjaPromptBlockPropertiesRequest;
+    id: string;
+    state?: Vellum.PromptBlockState;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfigRequest;
+}

package/api/types/MlModelUsage.d.ts

@@ -7,4 +7,6 @@ export interface MlModelUsage {
     inputCharCount?: number;
     outputCharCount?: number;
     computeNanos?: number;
+    cacheCreationInputTokens?: number;
+    cacheReadInputTokens?: number;
 }

package/api/types/PlainTextPromptBlockRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * A block that holds a plain text string value.
+ */
+export interface PlainTextPromptBlockRequest {
+    blockType: "PLAIN_TEXT";
+    text: string;
+    id: string;
+    state?: Vellum.PromptBlockState;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfigRequest;
+}

package/api/types/PromptBlockRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export declare type PromptBlockRequest = Vellum.JinjaPromptBlockRequest | Vellum.ChatMessagePromptBlockRequest | Vellum.FunctionDefinitionPromptBlockRequest | Vellum.VariablePromptBlockRequest | Vellum.RichTextPromptBlockRequest;

package/api/types/PromptBlockState.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * - `ENABLED` - ENABLED
+ * - `DISABLED` - DISABLED
+ */
+export declare type PromptBlockState = "ENABLED" | "DISABLED";
+export declare const PromptBlockState: {
+    readonly Enabled: "ENABLED";
+    readonly Disabled: "DISABLED";
+};

package/api/types/{VisibilityEnum.js → PromptBlockState.js}

@@ -3,10 +3,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VisibilityEnum = void 0;
-exports.VisibilityEnum = {
-    Default: "DEFAULT",
-    Public: "PUBLIC",
-    Private: "PRIVATE",
+exports.PromptBlockState = void 0;
+exports.PromptBlockState = {
+    Enabled: "ENABLED",
     Disabled: "DISABLED",
 };

package/api/types/{PromptDeploymentExpandMetaRequestRequest.d.ts → PromptDeploymentExpandMetaRequest.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface PromptDeploymentExpandMetaRequestRequest {
+export interface PromptDeploymentExpandMetaRequest {
     /** If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt. */
     modelName?: boolean;
     /** If enabled, the response will include model host usage tracking. This may increase latency for some model hosts. */

package/api/types/PromptParametersRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PromptParametersRequest {
+    stop?: string[];
+    temperature?: number;
+    maxTokens?: number;
+    topP?: number;
+    topK?: number;
+    frequencyPenalty?: number;
+    presencePenalty?: number;
+    logitBias?: Record<string, number | undefined>;
+    customParameters?: Record<string, unknown>;
+}

package/api/types/PromptRequestChatHistoryInputRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export interface PromptRequestChatHistoryInputRequest {
+    /** The variable's name, as defined in the Prompt. */
+    key: string;
+    type: "CHAT_HISTORY";
+    value: Vellum.ChatMessageRequest[];
+}

package/api/types/PromptRequestInputRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export declare type PromptRequestInputRequest = Vellum.PromptRequestStringInputRequest | Vellum.PromptRequestJsonInputRequest | Vellum.PromptRequestChatHistoryInputRequest;

package/api/types/PromptRequestJsonInputRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PromptRequestJsonInputRequest {
+    /** The variable's name, as defined in the Prompt. */
+    key: string;
+    type: "JSON";
+    value: Record<string, unknown>;
+}

package/api/types/PromptRequestStringInputRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PromptRequestStringInputRequest {
+    /** The variable's name, as defined in the Prompt. */
+    key: string;
+    type: "STRING";
+    value: string;
+}

package/api/types/RejectedAdHocExecutePromptEvent.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The final data returned indicating an error occurred during the stream.
+ */
+export interface RejectedAdHocExecutePromptEvent {
+    state: "REJECTED";
+    error: Vellum.VellumError;
+    executionId: string;
+    meta?: Vellum.AdHocRejectedPromptExecutionMeta;
+}

package/api/types/RichTextChildBlockRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+export declare type RichTextChildBlockRequest = Vellum.VariablePromptBlockRequest | Vellum.PlainTextPromptBlockRequest;

package/api/types/RichTextPromptBlockRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * A block that includes a combination of plain text and variable blocks.
+ */
+export interface RichTextPromptBlockRequest {
+    blockType: "RICH_TEXT";
+    blocks: Vellum.RichTextChildBlockRequest[];
+    id: string;
+    state?: Vellum.PromptBlockState;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfigRequest;
+}

package/api/types/StreamingAdHocExecutePromptEvent.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * The data returned for each delta during the prompt execution stream.
+ */
+export interface StreamingAdHocExecutePromptEvent {
+    state: "STREAMING";
+    output: Vellum.PromptOutput;
+    outputIndex: number;
+    executionId: string;
+    meta?: Vellum.AdHocStreamingPromptExecutionMeta;
+    /** The subset of the raw response from the model that the request opted into with `expand_raw`. */
+    raw?: Record<string, unknown>;
+}

package/api/types/VariablePromptBlockRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Vellum from "../index";
+/**
+ * A block that represents a variable in a prompt template.
+ */
+export interface VariablePromptBlockRequest {
+    blockType: "VARIABLE";
+    id: string;
+    state?: Vellum.PromptBlockState;
+    cacheConfig?: Vellum.EphemeralPromptCacheConfigRequest;
+    inputVariableId: string;
+}

package/api/types/{MlModelFamilyEnumValueLabel.d.ts → VellumVariableRequest.d.ts}

@@ -2,7 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Vellum from "../index";
-export interface MlModelFamilyEnumValueLabel {
-    label: string;
-    value: Vellum.MlModelFamily;
+export interface VellumVariableRequest {
+    id: string;
+    key: string;
+    type: Vellum.VellumVariableType;
 }