vellum-ai 0.14.40 → 0.14.42

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "vellum-ai",
-    "version": "0.14.40",
+    "version": "0.14.42",
     "private": false,
     "repository": "https://github.com/vellum-ai/vellum-client-node",
     "license": "MIT",

package/reference.md

@@ -75,6 +75,77 @@ await client.submitWorkflowExecutionActuals({
 
 ## AdHoc
 
+<details><summary><code>client.adHoc.<a href="/src/api/resources/adHoc/client/Client.ts">adhocExecutePrompt</a>({ ...params }) -> Vellum.AdHocExecutePromptEvent</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.adHoc.adhocExecutePrompt({
+    mlModel: "ml_model",
+    inputValues: [
+        {
+            key: "key",
+            type: "STRING",
+            value: "value",
+        },
+    ],
+    inputVariables: [
+        {
+            id: "id",
+            key: "key",
+            type: "STRING",
+        },
+    ],
+    parameters: {},
+    blocks: [
+        {
+            blockType: "JINJA",
+            template: "template",
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Vellum.AdHocExecutePrompt`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AdHoc.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.adHoc.<a href="/src/api/resources/adHoc/client/Client.ts">adhocExecutePromptStream</a>({ ...params }) -> core.Stream<Vellum.AdHocExecutePromptEvent></code></summary>
 <dl>
 <dd>
@@ -1682,7 +1753,7 @@ await client.documents.retrieve("id");
 <dl>
 <dd>
 
-**id:** `string` — A UUID string identifying this document.
+**id:** `string`
 
 </dd>
 </dl>
@@ -1745,7 +1816,7 @@ await client.documents.destroy("id");
 <dl>
 <dd>
 
-**id:** `string` — A UUID string identifying this document.
+**id:** `string`
 
 </dd>
 </dl>
@@ -1808,7 +1879,7 @@ await client.documents.partialUpdate("id");
 <dl>
 <dd>
 
-**id:** `string` — A UUID string identifying this document.
+**id:** `string`
 
 </dd>
 </dl>

package/serialization/resources/adHoc/client/requests/AdHocExecutePrompt.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../index";
+import * as Vellum from "../../../../../api/index";
+import * as core from "../../../../../core";
+import { PromptRequestInput } from "../../../../types/PromptRequestInput";
+import { VellumVariable } from "../../../../types/VellumVariable";
+import { PromptParameters } from "../../../../types/PromptParameters";
+import { PromptSettings } from "../../../../types/PromptSettings";
+import { FunctionDefinition } from "../../../../types/FunctionDefinition";
+import { AdHocExpandMeta } from "../../../../types/AdHocExpandMeta";
+export declare const AdHocExecutePrompt: core.serialization.Schema<serializers.AdHocExecutePrompt.Raw, Vellum.AdHocExecutePrompt>;
+export declare namespace AdHocExecutePrompt {
+    interface Raw {
+        ml_model: string;
+        input_values: PromptRequestInput.Raw[];
+        input_variables: VellumVariable.Raw[];
+        parameters: PromptParameters.Raw;
+        settings?: PromptSettings.Raw | null;
+        blocks: serializers.PromptBlock.Raw[];
+        functions?: FunctionDefinition.Raw[] | null;
+        expand_meta?: AdHocExpandMeta.Raw | null;
+    }
+}

package/serialization/{types/NodeEventDisplayContext.js → resources/adHoc/client/requests/AdHocExecutePrompt.js}

@@ -36,12 +36,22 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NodeEventDisplayContext = void 0;
-const serializers = __importStar(require("../index"));
-const core = __importStar(require("../../core"));
-exports.NodeEventDisplayContext = core.serialization.object({
-    inputDisplay: core.serialization.property("input_display", core.serialization.record(core.serialization.string(), core.serialization.string())),
-    outputDisplay: core.serialization.property("output_display", core.serialization.record(core.serialization.string(), core.serialization.string())),
-    portDisplay: core.serialization.property("port_display", core.serialization.record(core.serialization.string(), core.serialization.string())),
-    subworkflowDisplay: core.serialization.property("subworkflow_display", core.serialization.lazyObject(() => serializers.WorkflowEventDisplayContext).optional()),
+exports.AdHocExecutePrompt = void 0;
+const serializers = __importStar(require("../../../../index"));
+const core = __importStar(require("../../../../../core"));
+const PromptRequestInput_1 = require("../../../../types/PromptRequestInput");
+const VellumVariable_1 = require("../../../../types/VellumVariable");
+const PromptParameters_1 = require("../../../../types/PromptParameters");
+const PromptSettings_1 = require("../../../../types/PromptSettings");
+const FunctionDefinition_1 = require("../../../../types/FunctionDefinition");
+const AdHocExpandMeta_1 = require("../../../../types/AdHocExpandMeta");
+exports.AdHocExecutePrompt = core.serialization.object({
+    mlModel: core.serialization.property("ml_model", core.serialization.string()),
+    inputValues: core.serialization.property("input_values", core.serialization.list(PromptRequestInput_1.PromptRequestInput)),
+    inputVariables: core.serialization.property("input_variables", core.serialization.list(VellumVariable_1.VellumVariable)),
+    parameters: PromptParameters_1.PromptParameters,
+    settings: PromptSettings_1.PromptSettings.optional(),
+    blocks: core.serialization.list(core.serialization.lazy(() => serializers.PromptBlock)),
+    functions: core.serialization.list(FunctionDefinition_1.FunctionDefinition).optional(),
+    expandMeta: core.serialization.property("expand_meta", AdHocExpandMeta_1.AdHocExpandMeta.optional()),
 });

package/serialization/resources/adHoc/client/requests/index.d.ts

@@ -1 +1,2 @@
+export { AdHocExecutePrompt } from "./AdHocExecutePrompt";
 export { AdHocExecutePromptStream } from "./AdHocExecutePromptStream";

package/serialization/resources/adHoc/client/requests/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdHocExecutePromptStream = void 0;
+exports.AdHocExecutePromptStream = exports.AdHocExecutePrompt = void 0;
+var AdHocExecutePrompt_1 = require("./AdHocExecutePrompt");
+Object.defineProperty(exports, "AdHocExecutePrompt", { enumerable: true, get: function () { return AdHocExecutePrompt_1.AdHocExecutePrompt; } });
 var AdHocExecutePromptStream_1 = require("./AdHocExecutePromptStream");
 Object.defineProperty(exports, "AdHocExecutePromptStream", { enumerable: true, get: function () { return AdHocExecutePromptStream_1.AdHocExecutePromptStream; } });

package/serialization/types/ExecuteApiResponse.d.ts

@@ -4,12 +4,13 @@
 import * as serializers from "../index";
 import * as Vellum from "../../api/index";
 import * as core from "../../core";
+import { ExecuteApiResponseJson } from "./ExecuteApiResponseJson";
 export declare const ExecuteApiResponse: core.serialization.ObjectSchema<serializers.ExecuteApiResponse.Raw, Vellum.ExecuteApiResponse>;
 export declare namespace ExecuteApiResponse {
     interface Raw {
         status_code: number;
         text: string;
-        json?: Record<string, unknown> | null;
+        json: ExecuteApiResponseJson.Raw;
         headers: Record<string, string>;
     }
 }

package/serialization/types/ExecuteApiResponse.js

@@ -38,9 +38,10 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExecuteApiResponse = void 0;
 const core = __importStar(require("../../core"));
+const ExecuteApiResponseJson_1 = require("./ExecuteApiResponseJson");
 exports.ExecuteApiResponse = core.serialization.object({
     statusCode: core.serialization.property("status_code", core.serialization.number()),
     text: core.serialization.string(),
-    json: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
+    json: ExecuteApiResponseJson_1.ExecuteApiResponseJson,
     headers: core.serialization.record(core.serialization.string(), core.serialization.string()),
 });

package/serialization/types/ExecuteApiResponseJson.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Vellum from "../../api/index";
+import * as core from "../../core";
+export declare const ExecuteApiResponseJson: core.serialization.Schema<serializers.ExecuteApiResponseJson.Raw, Vellum.ExecuteApiResponseJson>;
+export declare namespace ExecuteApiResponseJson {
+    type Raw = Record<string, unknown> | unknown[];
+}

package/serialization/types/{WorkflowEventDisplayContext.js → ExecuteApiResponseJson.js}

@@ -36,11 +36,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowEventDisplayContext = void 0;
-const serializers = __importStar(require("../index"));
+exports.ExecuteApiResponseJson = void 0;
 const core = __importStar(require("../../core"));
-exports.WorkflowEventDisplayContext = core.serialization.object({
-    nodeDisplays: core.serialization.property("node_displays", core.serialization.record(core.serialization.string(), core.serialization.lazyObject(() => serializers.NodeEventDisplayContext))),
-    workflowInputs: core.serialization.property("workflow_inputs", core.serialization.record(core.serialization.string(), core.serialization.string())),
-    workflowOutputs: core.serialization.property("workflow_outputs", core.serialization.record(core.serialization.string(), core.serialization.string())),
-});
+exports.ExecuteApiResponseJson = core.serialization.undiscriminatedUnion([
+    core.serialization.record(core.serialization.string(), core.serialization.unknown()),
+    core.serialization.list(core.serialization.unknown()),
+]);

package/serialization/types/PromptSettings.d.ts

@@ -8,5 +8,6 @@ export declare const PromptSettings: core.serialization.ObjectSchema<serializers
 export declare namespace PromptSettings {
     interface Raw {
         timeout?: number | null;
+        stream_enabled?: boolean | null;
     }
 }

package/serialization/types/PromptSettings.js

@@ -40,4 +40,5 @@ exports.PromptSettings = void 0;
 const core = __importStar(require("../../core"));
 exports.PromptSettings = core.serialization.object({
     timeout: core.serialization.number().optional(),
+    streamEnabled: core.serialization.property("stream_enabled", core.serialization.boolean().optional()),
 });

package/serialization/types/WorkflowExecutionInitiatedBody.d.ts

@@ -9,7 +9,6 @@ export declare const WorkflowExecutionInitiatedBody: core.serialization.ObjectSc
 export declare namespace WorkflowExecutionInitiatedBody {
     interface Raw {
         workflow_definition: VellumCodeResourceDefinition.Raw;
-        display_context?: serializers.WorkflowEventDisplayContext.Raw | null;
         inputs: Record<string, unknown>;
     }
 }

package/serialization/types/WorkflowExecutionInitiatedBody.js

@@ -37,11 +37,9 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowExecutionInitiatedBody = void 0;
-const serializers = __importStar(require("../index"));
 const core = __importStar(require("../../core"));
 const VellumCodeResourceDefinition_1 = require("./VellumCodeResourceDefinition");
 exports.WorkflowExecutionInitiatedBody = core.serialization.object({
     workflowDefinition: core.serialization.property("workflow_definition", VellumCodeResourceDefinition_1.VellumCodeResourceDefinition),
-    displayContext: core.serialization.property("display_context", core.serialization.lazyObject(() => serializers.WorkflowEventDisplayContext).optional()),
     inputs: core.serialization.record(core.serialization.string(), core.serialization.unknown()),
 });

package/serialization/types/index.d.ts

@@ -96,6 +96,7 @@ export * from "./EphemeralPromptCacheConfigTypeEnum";
 export * from "./ErrorInput";
 export * from "./ErrorVellumValue";
 export * from "./ErrorVellumValueRequest";
+export * from "./ExecuteApiResponseJson";
 export * from "./ExecuteApiResponse";
 export * from "./ExecutePromptEvent";
 export * from "./ExecutePromptResponse";
@@ -221,7 +222,6 @@ export * from "./NamedTestCaseStringVariableValueRequest";
 export * from "./NamedTestCaseVariableValue";
 export * from "./NamedTestCaseVariableValueRequest";
 export * from "./NewMemberJoinBehaviorEnum";
-export * from "./NodeEventDisplayContext";
 export * from "./NodeExecutionFulfilledBody";
 export * from "./NodeExecutionFulfilledEvent";
 export * from "./NodeExecutionInitiatedBody";
@@ -512,7 +512,6 @@ export * from "./WorkflowDeploymentRelease";
 export * from "./WorkflowDeploymentReleaseWorkflowDeployment";
 export * from "./WorkflowDeploymentReleaseWorkflowVersion";
 export * from "./WorkflowError";
-export * from "./WorkflowEventDisplayContext";
 export * from "./WorkflowEventError";
 export * from "./WorkflowEventExecutionRead";
 export * from "./WorkflowExecutionActual";

package/serialization/types/index.js

@@ -112,6 +112,7 @@ __exportStar(require("./EphemeralPromptCacheConfigTypeEnum"), exports);
 __exportStar(require("./ErrorInput"), exports);
 __exportStar(require("./ErrorVellumValue"), exports);
 __exportStar(require("./ErrorVellumValueRequest"), exports);
+__exportStar(require("./ExecuteApiResponseJson"), exports);
 __exportStar(require("./ExecuteApiResponse"), exports);
 __exportStar(require("./ExecutePromptEvent"), exports);
 __exportStar(require("./ExecutePromptResponse"), exports);
@@ -237,7 +238,6 @@ __exportStar(require("./NamedTestCaseStringVariableValueRequest"), exports);
 __exportStar(require("./NamedTestCaseVariableValue"), exports);
 __exportStar(require("./NamedTestCaseVariableValueRequest"), exports);
 __exportStar(require("./NewMemberJoinBehaviorEnum"), exports);
-__exportStar(require("./NodeEventDisplayContext"), exports);
 __exportStar(require("./NodeExecutionFulfilledBody"), exports);
 __exportStar(require("./NodeExecutionFulfilledEvent"), exports);
 __exportStar(require("./NodeExecutionInitiatedBody"), exports);
@@ -528,7 +528,6 @@ __exportStar(require("./WorkflowDeploymentRelease"), exports);
 __exportStar(require("./WorkflowDeploymentReleaseWorkflowDeployment"), exports);
 __exportStar(require("./WorkflowDeploymentReleaseWorkflowVersion"), exports);
 __exportStar(require("./WorkflowError"), exports);
-__exportStar(require("./WorkflowEventDisplayContext"), exports);
 __exportStar(require("./WorkflowEventError"), exports);
 __exportStar(require("./WorkflowEventExecutionRead"), exports);
 __exportStar(require("./WorkflowExecutionActual"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.40";
+export declare const SDK_VERSION = "0.14.42";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.14.40";
+exports.SDK_VERSION = "0.14.42";

package/api/types/NodeEventDisplayContext.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Vellum from "../index";
-export interface NodeEventDisplayContext {
-    inputDisplay: Record<string, string>;
-    outputDisplay: Record<string, string>;
-    portDisplay: Record<string, string>;
-    subworkflowDisplay?: Vellum.WorkflowEventDisplayContext;
-}

package/api/types/WorkflowEventDisplayContext.d.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Vellum from "../index";
-export interface WorkflowEventDisplayContext {
-    nodeDisplays: Record<string, Vellum.NodeEventDisplayContext>;
-    workflowInputs: Record<string, string>;
-    workflowOutputs: Record<string, string>;
-}

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

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Vellum from "../index";
-export interface NodeEventDisplayContext {
-    inputDisplay: Record<string, string>;
-    outputDisplay: Record<string, string>;
-    portDisplay: Record<string, string>;
-    subworkflowDisplay?: Vellum.WorkflowEventDisplayContext;
-}

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

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Vellum from "../index";
-export interface WorkflowEventDisplayContext {
-    nodeDisplays: Record<string, Vellum.NodeEventDisplayContext>;
-    workflowInputs: Record<string, string>;
-    workflowOutputs: Record<string, string>;
-}

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

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Vellum from "../../api/index";
-import * as core from "../../core";
-export declare const NodeEventDisplayContext: core.serialization.ObjectSchema<serializers.NodeEventDisplayContext.Raw, Vellum.NodeEventDisplayContext>;
-export declare namespace NodeEventDisplayContext {
-    interface Raw {
-        input_display: Record<string, string>;
-        output_display: Record<string, string>;
-        port_display: Record<string, string>;
-        subworkflow_display?: serializers.WorkflowEventDisplayContext.Raw | null;
-    }
-}

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

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Vellum from "../../api/index";
-import * as core from "../../core";
-export declare const WorkflowEventDisplayContext: core.serialization.ObjectSchema<serializers.WorkflowEventDisplayContext.Raw, Vellum.WorkflowEventDisplayContext>;
-export declare namespace WorkflowEventDisplayContext {
-    interface Raw {
-        node_displays: Record<string, serializers.NodeEventDisplayContext.Raw>;
-        workflow_inputs: Record<string, string>;
-        workflow_outputs: Record<string, string>;
-    }
-}

package/serialization/types/NodeEventDisplayContext.d.ts

@@ -1,15 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Vellum from "../../api/index";
-import * as core from "../../core";
-export declare const NodeEventDisplayContext: core.serialization.ObjectSchema<serializers.NodeEventDisplayContext.Raw, Vellum.NodeEventDisplayContext>;
-export declare namespace NodeEventDisplayContext {
-    interface Raw {
-        input_display: Record<string, string>;
-        output_display: Record<string, string>;
-        port_display: Record<string, string>;
-        subworkflow_display?: serializers.WorkflowEventDisplayContext.Raw | null;
-    }
-}

package/serialization/types/WorkflowEventDisplayContext.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Vellum from "../../api/index";
-import * as core from "../../core";
-export declare const WorkflowEventDisplayContext: core.serialization.ObjectSchema<serializers.WorkflowEventDisplayContext.Raw, Vellum.WorkflowEventDisplayContext>;
-export declare namespace WorkflowEventDisplayContext {
-    interface Raw {
-        node_displays: Record<string, serializers.NodeEventDisplayContext.Raw>;
-        workflow_inputs: Record<string, string>;
-        workflow_outputs: Record<string, string>;
-    }
-}