vellum-ai 0.14.26 → 0.14.28

package/dist/api/types/index.js

@@ -308,6 +308,7 @@ __exportStar(require("./PromptBlockState"), exports);
 __exportStar(require("./PromptDeploymentExpandMetaRequest"), exports);
 __exportStar(require("./PromptDeploymentInputRequest"), exports);
 __exportStar(require("./PromptDeploymentParentContext"), exports);
+__exportStar(require("./PromptExecConfig"), exports);
 __exportStar(require("./PromptExecutionMeta"), exports);
 __exportStar(require("./PromptNodeExecutionMeta"), exports);
 __exportStar(require("./PromptNodeResult"), exports);

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

@@ -0,0 +1,21 @@
+/**
+ * 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 { VellumVariable } from "./VellumVariable";
+import { PromptParameters } from "./PromptParameters";
+import { PromptSettings } from "./PromptSettings";
+import { FunctionDefinition } from "./FunctionDefinition";
+export declare const PromptExecConfig: core.serialization.ObjectSchema<serializers.PromptExecConfig.Raw, Vellum.PromptExecConfig>;
+export declare namespace PromptExecConfig {
+    interface Raw {
+        ml_model: string;
+        input_variables: VellumVariable.Raw[];
+        parameters: PromptParameters.Raw;
+        settings?: PromptSettings.Raw | null;
+        blocks: serializers.PromptBlock.Raw[];
+        functions?: FunctionDefinition.Raw[] | null;
+    }
+}

package/dist/serialization/types/PromptExecConfig.js

@@ -0,0 +1,53 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptExecConfig = void 0;
+const serializers = __importStar(require("../index"));
+const core = __importStar(require("../../core"));
+const VellumVariable_1 = require("./VellumVariable");
+const PromptParameters_1 = require("./PromptParameters");
+const PromptSettings_1 = require("./PromptSettings");
+const FunctionDefinition_1 = require("./FunctionDefinition");
+exports.PromptExecConfig = core.serialization.object({
+    mlModel: core.serialization.property("ml_model", core.serialization.string()),
+    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(),
+});

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

@@ -292,6 +292,7 @@ export * from "./PromptBlockState";
 export * from "./PromptDeploymentExpandMetaRequest";
 export * from "./PromptDeploymentInputRequest";
 export * from "./PromptDeploymentParentContext";
+export * from "./PromptExecConfig";
 export * from "./PromptExecutionMeta";
 export * from "./PromptNodeExecutionMeta";
 export * from "./PromptNodeResult";

package/dist/serialization/types/index.js

@@ -308,6 +308,7 @@ __exportStar(require("./PromptBlockState"), exports);
 __exportStar(require("./PromptDeploymentExpandMetaRequest"), exports);
 __exportStar(require("./PromptDeploymentInputRequest"), exports);
 __exportStar(require("./PromptDeploymentParentContext"), exports);
+__exportStar(require("./PromptExecConfig"), exports);
 __exportStar(require("./PromptExecutionMeta"), exports);
 __exportStar(require("./PromptNodeExecutionMeta"), exports);
 __exportStar(require("./PromptNodeResult"), exports);

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.26";
+export declare const SDK_VERSION = "0.14.28";

package/dist/version.js

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

package/package.json

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

package/reference.md

@@ -1707,17 +1707,10 @@ Upload a document to be indexed and used for search.
 
 **Note:** Uses a base url of `https://documents.vellum.ai`.
 
-This is a multipart/form-data request. The `contents` field should be a file upload. It also expects a JSON body with the following fields:
-
-- `add_to_index_names: list[str]` - Optionally include the names of all indexes that you'd like this document to be included in
-- `external_id: str | None` - 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.
-- `label: str` - A human-friendly name for this document. Typically the filename.
-- `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
-- `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
-  </dd>
-  </dl>
-  </dd>
-  </dl>
+</dd>
+</dl>
+</dd>
+</dl>
 
 #### 🔌 Usage
 
@@ -2167,6 +2160,79 @@ await client.organizations.organizationIdentity();
 </dl>
 </details>
 
+## Prompts
+
+<details><summary><code>client.prompts.<a href="/src/api/resources/prompts/client/Client.ts">pull</a>(id, { ...params }) -> Vellum.PromptExecConfig</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Used to pull the definition of a Prompt from Vellum.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.prompts.pull("id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` — The ID of the Prompt to pull from. Prompt Sandbox IDs are currently supported.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Vellum.PromptsPullRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Prompts.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Sandboxes
 
 <details><summary><code>client.sandboxes.<a href="/src/api/resources/sandboxes/client/Client.ts">deployPrompt</a>(id, promptVariantId, { ...params }) -> Vellum.DeploymentRead</code></summary>

package/serialization/types/PromptExecConfig.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 { VellumVariable } from "./VellumVariable";
+import { PromptParameters } from "./PromptParameters";
+import { PromptSettings } from "./PromptSettings";
+import { FunctionDefinition } from "./FunctionDefinition";
+export declare const PromptExecConfig: core.serialization.ObjectSchema<serializers.PromptExecConfig.Raw, Vellum.PromptExecConfig>;
+export declare namespace PromptExecConfig {
+    interface Raw {
+        ml_model: string;
+        input_variables: VellumVariable.Raw[];
+        parameters: PromptParameters.Raw;
+        settings?: PromptSettings.Raw | null;
+        blocks: serializers.PromptBlock.Raw[];
+        functions?: FunctionDefinition.Raw[] | null;
+    }
+}

package/serialization/types/PromptExecConfig.js

@@ -0,0 +1,53 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptExecConfig = void 0;
+const serializers = __importStar(require("../index"));
+const core = __importStar(require("../../core"));
+const VellumVariable_1 = require("./VellumVariable");
+const PromptParameters_1 = require("./PromptParameters");
+const PromptSettings_1 = require("./PromptSettings");
+const FunctionDefinition_1 = require("./FunctionDefinition");
+exports.PromptExecConfig = core.serialization.object({
+    mlModel: core.serialization.property("ml_model", core.serialization.string()),
+    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(),
+});

package/serialization/types/index.d.ts

@@ -292,6 +292,7 @@ export * from "./PromptBlockState";
 export * from "./PromptDeploymentExpandMetaRequest";
 export * from "./PromptDeploymentInputRequest";
 export * from "./PromptDeploymentParentContext";
+export * from "./PromptExecConfig";
 export * from "./PromptExecutionMeta";
 export * from "./PromptNodeExecutionMeta";
 export * from "./PromptNodeResult";

package/serialization/types/index.js

@@ -308,6 +308,7 @@ __exportStar(require("./PromptBlockState"), exports);
 __exportStar(require("./PromptDeploymentExpandMetaRequest"), exports);
 __exportStar(require("./PromptDeploymentInputRequest"), exports);
 __exportStar(require("./PromptDeploymentParentContext"), exports);
+__exportStar(require("./PromptExecConfig"), exports);
 __exportStar(require("./PromptExecutionMeta"), exports);
 __exportStar(require("./PromptNodeExecutionMeta"), exports);
 __exportStar(require("./PromptNodeResult"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.14.26";
+export declare const SDK_VERSION = "0.14.28";

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.26";
+exports.SDK_VERSION = "0.14.28";