vellum-ai 0.8.5 → 0.8.7

package/dist/serialization/types/index.js

@@ -14,6 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AdHocExecutePromptEvent"), exports);
+__exportStar(require("./AdHocExpandMetaRequest"), exports);
+__exportStar(require("./AdHocFulfilledPromptExecutionMeta"), exports);
+__exportStar(require("./AdHocInitiatedPromptExecutionMeta"), exports);
+__exportStar(require("./AdHocRejectedPromptExecutionMeta"), exports);
+__exportStar(require("./AdHocStreamingPromptExecutionMeta"), exports);
 __exportStar(require("./AddOpenaiApiKeyEnum"), exports);
 __exportStar(require("./ApiNodeResult"), exports);
 __exportStar(require("./ApiNodeResultData"), exports);
@@ -34,6 +40,8 @@ __exportStar(require("./ChatHistoryInputRequest"), exports);
 __exportStar(require("./ChatMessage"), exports);
 __exportStar(require("./ChatMessageContent"), exports);
 __exportStar(require("./ChatMessageContentRequest"), exports);
+__exportStar(require("./ChatMessagePromptBlockPropertiesRequest"), exports);
+__exportStar(require("./ChatMessagePromptBlockRequest"), exports);
 __exportStar(require("./ChatMessageRequest"), exports);
 __exportStar(require("./ChatMessageRole"), exports);
 __exportStar(require("./CodeExecutionNodeArrayResult"), exports);
@@ -68,6 +76,8 @@ __exportStar(require("./DocumentStatus"), exports);
 __exportStar(require("./EnrichedNormalizedCompletion"), exports);
 __exportStar(require("./EntityStatus"), exports);
 __exportStar(require("./EnvironmentEnum"), exports);
+__exportStar(require("./EphemeralPromptCacheConfigRequest"), exports);
+__exportStar(require("./EphemeralPromptCacheConfigTypeEnum"), exports);
 __exportStar(require("./ErrorVariableValue"), exports);
 __exportStar(require("./ErrorVellumValue"), exports);
 __exportStar(require("./ErrorVellumValueRequest"), exports);
@@ -87,6 +97,7 @@ __exportStar(require("./ExecutionVellumValue"), exports);
 __exportStar(require("./ExternalTestCaseExecution"), exports);
 __exportStar(require("./ExternalTestCaseExecutionRequest"), exports);
 __exportStar(require("./FinishReasonEnum"), exports);
+__exportStar(require("./FulfilledAdHocExecutePromptEvent"), exports);
 __exportStar(require("./FulfilledEnum"), exports);
 __exportStar(require("./FulfilledExecutePromptEvent"), exports);
 __exportStar(require("./FulfilledExecutePromptResponse"), exports);
@@ -102,6 +113,8 @@ __exportStar(require("./FunctionCallRequest"), exports);
 __exportStar(require("./FunctionCallVariableValue"), exports);
 __exportStar(require("./FunctionCallVellumValue"), exports);
 __exportStar(require("./FunctionCallVellumValueRequest"), exports);
+__exportStar(require("./FunctionDefinitionPromptBlockPropertiesRequest"), exports);
+__exportStar(require("./FunctionDefinitionPromptBlockRequest"), exports);
 __exportStar(require("./GenerateOptionsRequest"), exports);
 __exportStar(require("./GenerateRequest"), exports);
 __exportStar(require("./GenerateResponse"), exports);
@@ -113,9 +126,6 @@ __exportStar(require("./GenerateStreamResult"), exports);
 __exportStar(require("./GenerateStreamResultData"), exports);
 __exportStar(require("./HkunlpInstructorXlVectorizer"), exports);
 __exportStar(require("./HkunlpInstructorXlVectorizerRequest"), exports);
-__exportStar(require("./HostedByEnum"), exports);
-__exportStar(require("./HuggingFaceTokenizerConfig"), exports);
-__exportStar(require("./HuggingFaceTokenizerConfigRequest"), exports);
 __exportStar(require("./ImageChatMessageContent"), exports);
 __exportStar(require("./ImageChatMessageContentRequest"), exports);
 __exportStar(require("./ImageVariableValue"), exports);
@@ -124,6 +134,7 @@ __exportStar(require("./ImageVellumValueRequest"), exports);
 __exportStar(require("./IndexingConfigVectorizer"), exports);
 __exportStar(require("./IndexingConfigVectorizerRequest"), exports);
 __exportStar(require("./IndexingStateEnum"), exports);
+__exportStar(require("./InitiatedAdHocExecutePromptEvent"), exports);
 __exportStar(require("./InitiatedExecutePromptEvent"), exports);
 __exportStar(require("./InitiatedPromptExecutionMeta"), exports);
 __exportStar(require("./InitiatedWorkflowNodeResultEvent"), exports);
@@ -131,34 +142,13 @@ __exportStar(require("./InstructorVectorizerConfig"), exports);
 __exportStar(require("./InstructorVectorizerConfigRequest"), exports);
 __exportStar(require("./IterationStateEnum"), exports);
 __exportStar(require("./JsonInputRequest"), exports);
+__exportStar(require("./JinjaPromptBlockPropertiesRequest"), exports);
+__exportStar(require("./JinjaPromptBlockRequest"), exports);
 __exportStar(require("./JsonVariableValue"), exports);
 __exportStar(require("./JsonVellumValue"), exports);
 __exportStar(require("./JsonVellumValueRequest"), exports);
 __exportStar(require("./LogicalOperator"), exports);
 __exportStar(require("./LogprobsEnum"), exports);
-__exportStar(require("./MlModelDeveloper"), exports);
-__exportStar(require("./MlModelDeveloperEnumValueLabel"), exports);
-__exportStar(require("./MlModelDisplayConfigLabelled"), exports);
-__exportStar(require("./MlModelDisplayConfigRequest"), exports);
-__exportStar(require("./MlModelDisplayTag"), exports);
-__exportStar(require("./MlModelDisplayTagEnumValueLabel"), exports);
-__exportStar(require("./MlModelExecConfig"), exports);
-__exportStar(require("./MlModelExecConfigRequest"), exports);
-__exportStar(require("./MlModelFamily"), exports);
-__exportStar(require("./MlModelFamilyEnumValueLabel"), exports);
-__exportStar(require("./MlModelFeature"), exports);
-__exportStar(require("./MlModelParameterConfig"), exports);
-__exportStar(require("./MlModelParameterConfigRequest"), exports);
-__exportStar(require("./MlModelRead"), exports);
-__exportStar(require("./MlModelRequestAuthorizationConfig"), exports);
-__exportStar(require("./MlModelRequestAuthorizationConfigRequest"), exports);
-__exportStar(require("./MlModelRequestAuthorizationConfigTypeEnum"), exports);
-__exportStar(require("./MlModelRequestConfig"), exports);
-__exportStar(require("./MlModelRequestConfigRequest"), exports);
-__exportStar(require("./MlModelResponseConfig"), exports);
-__exportStar(require("./MlModelResponseConfigRequest"), exports);
-__exportStar(require("./MlModelTokenizerConfig"), exports);
-__exportStar(require("./MlModelTokenizerConfigRequest"), exports);
 __exportStar(require("./MlModelUsage"), exports);
 __exportStar(require("./MapNodeResult"), exports);
 __exportStar(require("./MapNodeResultData"), exports);
@@ -221,28 +211,7 @@ __exportStar(require("./OpenAiVectorizerTextEmbedding3Small"), exports);
 __exportStar(require("./OpenAiVectorizerTextEmbedding3SmallRequest"), exports);
 __exportStar(require("./OpenAiVectorizerTextEmbeddingAda002"), exports);
 __exportStar(require("./OpenAiVectorizerTextEmbeddingAda002Request"), exports);
-__exportStar(require("./OpenApiArrayProperty"), exports);
-__exportStar(require("./OpenApiArrayPropertyRequest"), exports);
-__exportStar(require("./OpenApiBooleanProperty"), exports);
-__exportStar(require("./OpenApiBooleanPropertyRequest"), exports);
-__exportStar(require("./OpenApiConstProperty"), exports);
-__exportStar(require("./OpenApiConstPropertyRequest"), exports);
-__exportStar(require("./OpenApiIntegerProperty"), exports);
-__exportStar(require("./OpenApiIntegerPropertyRequest"), exports);
-__exportStar(require("./OpenApiNumberProperty"), exports);
-__exportStar(require("./OpenApiNumberPropertyRequest"), exports);
-__exportStar(require("./OpenApiObjectProperty"), exports);
-__exportStar(require("./OpenApiObjectPropertyRequest"), exports);
-__exportStar(require("./OpenApiOneOfProperty"), exports);
-__exportStar(require("./OpenApiOneOfPropertyRequest"), exports);
-__exportStar(require("./OpenApiProperty"), exports);
-__exportStar(require("./OpenApiPropertyRequest"), exports);
-__exportStar(require("./OpenApiRefProperty"), exports);
-__exportStar(require("./OpenApiRefPropertyRequest"), exports);
-__exportStar(require("./OpenApiStringProperty"), exports);
-__exportStar(require("./OpenApiStringPropertyRequest"), exports);
 __exportStar(require("./PaginatedDocumentIndexReadList"), exports);
-__exportStar(require("./PaginatedMlModelReadList"), exports);
 __exportStar(require("./PaginatedSlimDeploymentReadList"), exports);
 __exportStar(require("./PaginatedSlimDocumentList"), exports);
 __exportStar(require("./PaginatedSlimWorkflowDeploymentList"), exports);
@@ -250,20 +219,29 @@ __exportStar(require("./PaginatedTestSuiteRunExecutionList"), exports);
 __exportStar(require("./PaginatedTestSuiteTestCaseList"), exports);
 __exportStar(require("./PdfSearchResultMetaSource"), exports);
 __exportStar(require("./PdfSearchResultMetaSourceRequest"), exports);
+__exportStar(require("./PlainTextPromptBlockRequest"), exports);
 __exportStar(require("./ProcessingFailureReasonEnum"), exports);
 __exportStar(require("./ProcessingStateEnum"), exports);
-__exportStar(require("./PromptDeploymentExpandMetaRequestRequest"), exports);
+__exportStar(require("./PromptBlockRequest"), exports);
+__exportStar(require("./PromptBlockState"), exports);
+__exportStar(require("./PromptDeploymentExpandMetaRequest"), exports);
 __exportStar(require("./PromptDeploymentInputRequest"), exports);
 __exportStar(require("./PromptExecutionMeta"), exports);
 __exportStar(require("./PromptNodeExecutionMeta"), exports);
 __exportStar(require("./PromptNodeResult"), exports);
 __exportStar(require("./PromptNodeResultData"), exports);
 __exportStar(require("./PromptOutput"), exports);
+__exportStar(require("./PromptParametersRequest"), exports);
+__exportStar(require("./PromptRequestChatHistoryInputRequest"), exports);
+__exportStar(require("./PromptRequestInputRequest"), exports);
+__exportStar(require("./PromptRequestJsonInputRequest"), exports);
+__exportStar(require("./PromptRequestStringInputRequest"), exports);
 __exportStar(require("./RawPromptExecutionOverridesRequest"), exports);
 __exportStar(require("./ReductoChunkerConfig"), exports);
 __exportStar(require("./ReductoChunkerConfigRequest"), exports);
 __exportStar(require("./ReductoChunking"), exports);
 __exportStar(require("./ReductoChunkingRequest"), exports);
+__exportStar(require("./RejectedAdHocExecutePromptEvent"), exports);
 __exportStar(require("./RejectedExecutePromptEvent"), exports);
 __exportStar(require("./RejectedExecutePromptResponse"), exports);
 __exportStar(require("./RejectedExecuteWorkflowWorkflowResultEvent"), exports);
@@ -271,6 +249,8 @@ __exportStar(require("./RejectedPromptExecutionMeta"), exports);
 __exportStar(require("./RejectedWorkflowNodeResultEvent"), exports);
 __exportStar(require("./ReleaseTagSource"), exports);
 __exportStar(require("./ReplaceTestSuiteTestCaseRequest"), exports);
+__exportStar(require("./RichTextChildBlockRequest"), exports);
+__exportStar(require("./RichTextPromptBlockRequest"), exports);
 __exportStar(require("./SandboxScenario"), exports);
 __exportStar(require("./ScenarioInput"), exports);
 __exportStar(require("./ScenarioInputChatHistoryVariableValue"), exports);
@@ -298,6 +278,7 @@ __exportStar(require("./SentenceChunkingRequest"), exports);
 __exportStar(require("./SlimDeploymentRead"), exports);
 __exportStar(require("./SlimDocument"), exports);
 __exportStar(require("./SlimWorkflowDeployment"), exports);
+__exportStar(require("./StreamingAdHocExecutePromptEvent"), exports);
 __exportStar(require("./StreamingExecutePromptEvent"), exports);
 __exportStar(require("./StreamingPromptExecutionMeta"), exports);
 __exportStar(require("./StreamingWorkflowNodeResultEvent"), exports);
@@ -390,22 +371,21 @@ __exportStar(require("./TestSuiteTestCaseReplaceBulkOperationRequest"), exports)
 __exportStar(require("./TestSuiteTestCaseReplacedBulkResult"), exports);
 __exportStar(require("./TestSuiteTestCaseReplacedBulkResultData"), exports);
 __exportStar(require("./TestSuiteTestCaseUpsertBulkOperationRequest"), exports);
-__exportStar(require("./TikTokenTokenizerConfig"), exports);
-__exportStar(require("./TikTokenTokenizerConfigRequest"), exports);
 __exportStar(require("./TokenOverlappingWindowChunkerConfig"), exports);
 __exportStar(require("./TokenOverlappingWindowChunkerConfigRequest"), exports);
 __exportStar(require("./TokenOverlappingWindowChunking"), exports);
 __exportStar(require("./TokenOverlappingWindowChunkingRequest"), exports);
 __exportStar(require("./UploadDocumentResponse"), exports);
 __exportStar(require("./UpsertTestSuiteTestCaseRequest"), exports);
+__exportStar(require("./VariablePromptBlockRequest"), exports);
 __exportStar(require("./VellumError"), exports);
 __exportStar(require("./VellumErrorCodeEnum"), exports);
 __exportStar(require("./VellumErrorRequest"), exports);
 __exportStar(require("./VellumImage"), exports);
 __exportStar(require("./VellumImageRequest"), exports);
 __exportStar(require("./VellumVariable"), exports);
+__exportStar(require("./VellumVariableRequest"), exports);
 __exportStar(require("./VellumVariableType"), exports);
-__exportStar(require("./VisibilityEnum"), exports);
 __exportStar(require("./WorkflowDeploymentRead"), exports);
 __exportStar(require("./WorkflowEventError"), exports);
 __exportStar(require("./WorkflowExecutionActualChatHistoryRequest"), exports);

package/package.json

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

package/reference.md

@@ -73,6 +73,126 @@ await client.submitWorkflowExecutionActuals({
 
 ##
 
+## AdHoc
+
+<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>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.adHoc.adhocExecutePromptStream({
+    mlModel: "string",
+    inputValues: [
+        {
+            key: "string",
+            type: "STRING",
+            value: "string",
+        },
+    ],
+    inputVariables: [
+        {
+            id: "string",
+            key: "string",
+            type: Vellum.VellumVariableType.String,
+        },
+    ],
+    parameters: {
+        stop: ["string"],
+        temperature: 1.1,
+        maxTokens: 1,
+        topP: 1.1,
+        topK: 1,
+        frequencyPenalty: 1.1,
+        presencePenalty: 1.1,
+        logitBias: {
+            string: {
+                key: "value",
+            },
+        },
+        customParameters: {
+            string: {
+                key: "value",
+            },
+        },
+    },
+    blocks: [
+        {
+            blockType: "JINJA",
+            properties: {
+                template: "string",
+                templateType: Vellum.VellumVariableType.String,
+            },
+            id: "string",
+            state: Vellum.PromptBlockState.Enabled,
+            cacheConfig: {
+                type: "EPHEMERAL",
+            },
+        },
+    ],
+    expandMeta: {
+        cost: true,
+        modelName: true,
+        usage: true,
+        finishReason: true,
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Vellum.AdHocExecutePromptStreamRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AdHoc.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Deployments
 
 <details><summary><code>client.deployments.<a href="/src/api/resources/deployments/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedSlimDeploymentReadList</code></summary>
@@ -1412,352 +1532,6 @@ await client.folderEntities.addEntityToFolder("folder_id", {
 </dl>
 </details>
 
-## MlModels
-
-<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">list</a>({ ...params }) -> Vellum.PaginatedMlModelReadList</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-List all ML Models that your Workspace has access to.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.mlModels.list();
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Vellum.MlModelsListRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `MlModels.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">create</a>({ ...params }) -> Vellum.MlModelRead</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates a new ML Model.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.mlModels.create({
-    name: "name",
-    family: Vellum.MlModelFamily.Capybara,
-    hostedBy: Vellum.HostedByEnum.Anthropic,
-    developedBy: Vellum.MlModelDeveloper.OneAi,
-    execConfig: {
-        modelIdentifier: "model_identifier",
-        baseUrl: "base_url",
-        metadata: {
-            key: "value",
-        },
-        features: [Vellum.MlModelFeature.Text],
-    },
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Vellum.MlModelCreateRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `MlModels.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">retrieve</a>(id) -> Vellum.MlModelRead</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieve an ML Model by its UUID.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.mlModels.retrieve("id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**id:** `string` — Either the ML Model's ID or its unique name
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `MlModels.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">update</a>(id, { ...params }) -> Vellum.MlModelRead</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Replace an ML Model with a new representation, keying off of its UUID.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.mlModels.update("id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**id:** `string` — Either the ML Model's ID or its unique name
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Vellum.MlModelUpdateRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `MlModels.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">partialUpdate</a>(id, { ...params }) -> Vellum.MlModelRead</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Partially update an ML Model, keying off of its UUID.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.mlModels.partialUpdate("id");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**id:** `string` — Either the ML Model's ID or its unique name
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Vellum.PatchedMlModelUpdateRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `MlModels.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>
@@ -1896,7 +1670,7 @@ await client.sandboxes.upsertSandboxScenario("id", {
 <dl>
 <dd>
 
-**request:** `Vellum.UpsertSandboxScenarioRequestRequest`
+**request:** `Vellum.UpsertSandboxScenarioRequest`
 
 </dd>
 </dl>