vellum-ai 0.10.6 → 0.10.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/.mock/definition/__package__.yml +123 -0
  2. package/.mock/definition/adHoc.yml +25 -0
  3. package/.mock/definition/containerImages.yml +9 -0
  4. package/.mock/definition/deployments.yml +16 -0
  5. package/.mock/definition/documentIndexes.yml +19 -0
  6. package/.mock/definition/documents.yml +16 -1
  7. package/.mock/definition/folderEntities.yml +5 -0
  8. package/.mock/definition/metricDefinitions.yml +8 -0
  9. package/.mock/definition/mlModels.yml +2 -0
  10. package/.mock/definition/sandboxes.yml +8 -0
  11. package/.mock/definition/testSuiteRuns.yml +7 -0
  12. package/.mock/definition/testSuites.yml +29 -0
  13. package/.mock/definition/workflowDeployments.yml +13 -0
  14. package/.mock/definition/workflowSandboxes.yml +3 -0
  15. package/.mock/definition/workflows.yml +4 -0
  16. package/.mock/definition/workspaceSecrets.yml +5 -0
  17. package/.mock/fern.config.json +1 -1
  18. package/.mock/openapi/openapi.yml +3 -0
  19. package/Client.js +10 -10
  20. package/api/client/requests/ExecutePromptStreamRequest.d.ts +3 -35
  21. package/api/client/requests/ExecuteWorkflowStreamRequest.d.ts +3 -16
  22. package/api/client/requests/GenerateStreamBodyRequest.d.ts +3 -20
  23. package/api/resources/adHoc/client/Client.js +1 -1
  24. package/api/resources/adHoc/client/requests/AdHocExecutePromptStream.d.ts +9 -65
  25. package/api/resources/containerImages/client/Client.js +4 -4
  26. package/api/resources/deployments/client/Client.js +7 -7
  27. package/api/resources/documentIndexes/client/Client.js +8 -8
  28. package/api/resources/documents/client/Client.js +5 -5
  29. package/api/resources/folderEntities/client/Client.js +2 -2
  30. package/api/resources/metricDefinitions/client/Client.d.ts +9 -0
  31. package/api/resources/metricDefinitions/client/Client.js +52 -1
  32. package/api/resources/mlModels/client/Client.js +1 -1
  33. package/api/resources/sandboxes/client/Client.js +3 -3
  34. package/api/resources/testSuiteRuns/client/Client.js +3 -3
  35. package/api/resources/testSuites/client/Client.js +5 -5
  36. package/api/resources/workflowDeployments/client/Client.js +6 -6
  37. package/api/resources/workflowSandboxes/client/Client.js +1 -1
  38. package/api/resources/workflows/client/Client.js +2 -2
  39. package/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +0 -6
  40. package/api/resources/workspaceSecrets/client/Client.js +2 -2
  41. package/api/types/MetricDefinitionHistoryItem.d.ts +14 -0
  42. package/api/types/MetricDefinitionHistoryItem.js +5 -0
  43. package/api/types/index.d.ts +1 -0
  44. package/api/types/index.js +1 -0
  45. package/dist/Client.js +10 -10
  46. package/dist/api/client/requests/ExecutePromptStreamRequest.d.ts +3 -35
  47. package/dist/api/client/requests/ExecuteWorkflowStreamRequest.d.ts +3 -16
  48. package/dist/api/client/requests/GenerateStreamBodyRequest.d.ts +3 -20
  49. package/dist/api/resources/adHoc/client/Client.js +1 -1
  50. package/dist/api/resources/adHoc/client/requests/AdHocExecutePromptStream.d.ts +9 -65
  51. package/dist/api/resources/containerImages/client/Client.js +4 -4
  52. package/dist/api/resources/deployments/client/Client.js +7 -7
  53. package/dist/api/resources/documentIndexes/client/Client.js +8 -8
  54. package/dist/api/resources/documents/client/Client.js +5 -5
  55. package/dist/api/resources/folderEntities/client/Client.js +2 -2
  56. package/dist/api/resources/metricDefinitions/client/Client.d.ts +9 -0
  57. package/dist/api/resources/metricDefinitions/client/Client.js +52 -1
  58. package/dist/api/resources/mlModels/client/Client.js +1 -1
  59. package/dist/api/resources/sandboxes/client/Client.js +3 -3
  60. package/dist/api/resources/testSuiteRuns/client/Client.js +3 -3
  61. package/dist/api/resources/testSuites/client/Client.js +5 -5
  62. package/dist/api/resources/workflowDeployments/client/Client.js +6 -6
  63. package/dist/api/resources/workflowSandboxes/client/Client.js +1 -1
  64. package/dist/api/resources/workflows/client/Client.js +2 -2
  65. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +0 -6
  66. package/dist/api/resources/workspaceSecrets/client/Client.js +2 -2
  67. package/dist/api/types/MetricDefinitionHistoryItem.d.ts +14 -0
  68. package/dist/api/types/MetricDefinitionHistoryItem.js +5 -0
  69. package/dist/api/types/index.d.ts +1 -0
  70. package/dist/api/types/index.js +1 -0
  71. package/dist/serialization/types/MetricDefinitionHistoryItem.d.ts +18 -0
  72. package/dist/serialization/types/MetricDefinitionHistoryItem.js +39 -0
  73. package/dist/serialization/types/index.d.ts +1 -0
  74. package/dist/serialization/types/index.js +1 -0
  75. package/dist/version.d.ts +1 -1
  76. package/dist/version.js +1 -1
  77. package/package.json +1 -1
  78. package/reference.md +67 -146
  79. package/serialization/types/MetricDefinitionHistoryItem.d.ts +18 -0
  80. package/serialization/types/MetricDefinitionHistoryItem.js +39 -0
  81. package/serialization/types/index.d.ts +1 -0
  82. package/serialization/types/index.js +1 -0
  83. package/version.d.ts +1 -1
  84. package/version.js +1 -1
package/reference.md CHANGED
@@ -104,86 +104,28 @@ An internal-only endpoint that's subject to breaking changes without notice. Not
104
104
 
105
105
  ```typescript
106
106
  await client.adHoc.adhocExecutePromptStream({
107
- mlModel: "string",
107
+ mlModel: "ml_model",
108
108
  inputValues: [
109
109
  {
110
- key: "string",
110
+ key: "key",
111
111
  type: "STRING",
112
- value: "string",
112
+ value: "value",
113
113
  },
114
114
  ],
115
115
  inputVariables: [
116
116
  {
117
- id: "string",
118
- key: "string",
117
+ id: "id",
118
+ key: "key",
119
119
  type: "STRING",
120
- required: true,
121
- default: {
122
- type: "STRING",
123
- value: "string",
124
- },
125
- extensions: {
126
- color: {
127
- key: "value",
128
- },
129
- },
130
120
  },
131
121
  ],
132
- parameters: {
133
- stop: ["string"],
134
- temperature: 1.1,
135
- maxTokens: 1,
136
- topP: 1.1,
137
- topK: 1,
138
- frequencyPenalty: 1.1,
139
- presencePenalty: 1.1,
140
- logitBias: {
141
- string: {
142
- key: "value",
143
- },
144
- },
145
- customParameters: {
146
- string: {
147
- key: "value",
148
- },
149
- },
150
- },
151
- settings: {
152
- timeout: 1.1,
153
- },
122
+ parameters: {},
154
123
  blocks: [
155
124
  {
156
- state: "ENABLED",
157
- cacheConfig: {
158
- type: "EPHEMERAL",
159
- },
160
125
  blockType: "JINJA",
161
- template: "string",
126
+ template: "template",
162
127
  },
163
128
  ],
164
- functions: [
165
- {
166
- state: "ENABLED",
167
- cacheConfig: {
168
- type: "EPHEMERAL",
169
- },
170
- name: "string",
171
- description: "string",
172
- parameters: {
173
- string: {
174
- key: "value",
175
- },
176
- },
177
- forced: true,
178
- strict: true,
179
- },
180
- ],
181
- expandMeta: {
182
- cost: true,
183
- modelName: true,
184
- usage: true,
185
- finishReason: true,
186
- },
187
129
  });
188
130
  ```
189
131
 
@@ -2104,6 +2046,62 @@ await client.metricDefinitions.executeMetricDefinition("id", {
2104
2046
  </dl>
2105
2047
  </details>
2106
2048
 
2049
+ <details><summary><code>client.metricDefinitions.<a href="/src/api/resources/metricDefinitions/client/Client.ts">metricDefinitionHistoryItemRetrieve</a>(historyIdOrReleaseTag, id) -> Vellum.MetricDefinitionHistoryItem</code></summary>
2050
+ <dl>
2051
+ <dd>
2052
+
2053
+ #### 🔌 Usage
2054
+
2055
+ <dl>
2056
+ <dd>
2057
+
2058
+ <dl>
2059
+ <dd>
2060
+
2061
+ ```typescript
2062
+ await client.metricDefinitions.metricDefinitionHistoryItemRetrieve("history_id_or_release_tag", "id");
2063
+ ```
2064
+
2065
+ </dd>
2066
+ </dl>
2067
+ </dd>
2068
+ </dl>
2069
+
2070
+ #### ⚙️ Parameters
2071
+
2072
+ <dl>
2073
+ <dd>
2074
+
2075
+ <dl>
2076
+ <dd>
2077
+
2078
+ **historyIdOrReleaseTag:** `string` — Either the UUID of Metric Definition History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Metric Definition History Item you'd like to retrieve.
2079
+
2080
+ </dd>
2081
+ </dl>
2082
+
2083
+ <dl>
2084
+ <dd>
2085
+
2086
+ **id:** `string` — A UUID string identifying this metric definition.
2087
+
2088
+ </dd>
2089
+ </dl>
2090
+
2091
+ <dl>
2092
+ <dd>
2093
+
2094
+ **requestOptions:** `MetricDefinitions.RequestOptions`
2095
+
2096
+ </dd>
2097
+ </dl>
2098
+ </dd>
2099
+ </dl>
2100
+
2101
+ </dd>
2102
+ </dl>
2103
+ </details>
2104
+
2107
2105
  ## MlModels
2108
2106
 
2109
2107
  <details><summary><code>client.mlModels.<a href="/src/api/resources/mlModels/client/Client.ts">retrieve</a>(id) -> Vellum.MlModelRead</code></summary>
@@ -2779,27 +2777,23 @@ Created, replace, and delete Test Cases within the specified Test Suite in bulk
2779
2777
  <dd>
2780
2778
 
2781
2779
  ```typescript
2782
- await client.testSuites.testSuiteTestCasesBulk("string", [
2780
+ await client.testSuites.testSuiteTestCasesBulk("id", [
2783
2781
  {
2784
- id: "string",
2782
+ id: "id",
2785
2783
  type: "CREATE",
2786
2784
  data: {
2787
- label: "string",
2788
2785
  inputValues: [
2789
2786
  {
2790
2787
  type: "STRING",
2791
- value: "string",
2792
- name: "string",
2788
+ name: "name",
2793
2789
  },
2794
2790
  ],
2795
2791
  evaluationValues: [
2796
2792
  {
2797
2793
  type: "STRING",
2798
- value: "string",
2799
- name: "string",
2794
+ name: "name",
2800
2795
  },
2801
2796
  ],
2802
- externalId: "string",
2803
2797
  },
2804
2798
  },
2805
2799
  ]);
@@ -3404,79 +3398,6 @@ await client.workflowSandboxes.deployWorkflow("id", "workflow_id");
3404
3398
 
3405
3399
  ## Workflows
3406
3400
 
3407
- <details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">pull</a>(id, { ...params }) -> stream.Readable</code></summary>
3408
- <dl>
3409
- <dd>
3410
-
3411
- #### 📝 Description
3412
-
3413
- <dl>
3414
- <dd>
3415
-
3416
- <dl>
3417
- <dd>
3418
-
3419
- An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
3420
-
3421
- </dd>
3422
- </dl>
3423
- </dd>
3424
- </dl>
3425
-
3426
- #### 🔌 Usage
3427
-
3428
- <dl>
3429
- <dd>
3430
-
3431
- <dl>
3432
- <dd>
3433
-
3434
- ```typescript
3435
- await client.workflows.pull("string", {
3436
- format: "json",
3437
- });
3438
- ```
3439
-
3440
- </dd>
3441
- </dl>
3442
- </dd>
3443
- </dl>
3444
-
3445
- #### ⚙️ Parameters
3446
-
3447
- <dl>
3448
- <dd>
3449
-
3450
- <dl>
3451
- <dd>
3452
-
3453
- **id:** `string` — The ID of the Workflow to pull from
3454
-
3455
- </dd>
3456
- </dl>
3457
-
3458
- <dl>
3459
- <dd>
3460
-
3461
- **request:** `Vellum.WorkflowsPullRequest`
3462
-
3463
- </dd>
3464
- </dl>
3465
-
3466
- <dl>
3467
- <dd>
3468
-
3469
- **requestOptions:** `Workflows.RequestOptions`
3470
-
3471
- </dd>
3472
- </dl>
3473
- </dd>
3474
- </dl>
3475
-
3476
- </dd>
3477
- </dl>
3478
- </details>
3479
-
3480
3401
  <details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">push</a>(artifact, { ...params }) -> Vellum.WorkflowPushResponse</code></summary>
3481
3402
  <dl>
3482
3403
  <dd>
@@ -0,0 +1,18 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../index";
5
+ import * as Vellum from "../../api/index";
6
+ import * as core from "../../core";
7
+ import { VellumVariable } from "./VellumVariable";
8
+ export declare const MetricDefinitionHistoryItem: core.serialization.ObjectSchema<serializers.MetricDefinitionHistoryItem.Raw, Vellum.MetricDefinitionHistoryItem>;
9
+ export declare namespace MetricDefinitionHistoryItem {
10
+ interface Raw {
11
+ id: string;
12
+ label: string;
13
+ name: string;
14
+ description: string;
15
+ input_variables: VellumVariable.Raw[];
16
+ output_variables: VellumVariable.Raw[];
17
+ }
18
+ }
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.MetricDefinitionHistoryItem = void 0;
30
+ const core = __importStar(require("../../core"));
31
+ const VellumVariable_1 = require("./VellumVariable");
32
+ exports.MetricDefinitionHistoryItem = core.serialization.object({
33
+ id: core.serialization.string(),
34
+ label: core.serialization.string(),
35
+ name: core.serialization.string(),
36
+ description: core.serialization.string(),
37
+ inputVariables: core.serialization.property("input_variables", core.serialization.list(VellumVariable_1.VellumVariable)),
38
+ outputVariables: core.serialization.property("output_variables", core.serialization.list(VellumVariable_1.VellumVariable)),
39
+ });
@@ -183,6 +183,7 @@ export * from "./MetadataFilterRuleCombinator";
183
183
  export * from "./MetadataFilterRuleRequest";
184
184
  export * from "./MetadataFiltersRequest";
185
185
  export * from "./MetricDefinitionExecution";
186
+ export * from "./MetricDefinitionHistoryItem";
186
187
  export * from "./MetricDefinitionInput";
187
188
  export * from "./MetricNodeResult";
188
189
  export * from "./NamedScenarioInputChatHistoryVariableValueRequest";
@@ -199,6 +199,7 @@ __exportStar(require("./MetadataFilterRuleCombinator"), exports);
199
199
  __exportStar(require("./MetadataFilterRuleRequest"), exports);
200
200
  __exportStar(require("./MetadataFiltersRequest"), exports);
201
201
  __exportStar(require("./MetricDefinitionExecution"), exports);
202
+ __exportStar(require("./MetricDefinitionHistoryItem"), exports);
202
203
  __exportStar(require("./MetricDefinitionInput"), exports);
203
204
  __exportStar(require("./MetricNodeResult"), exports);
204
205
  __exportStar(require("./NamedScenarioInputChatHistoryVariableValueRequest"), exports);
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.10.6";
1
+ export declare const SDK_VERSION = "0.10.8";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "0.10.6";
4
+ exports.SDK_VERSION = "0.10.8";