vellum-ai 0.12.14 → 0.12.15

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 (128) hide show
  1. package/.mock/definition/__package__.yml +48 -4
  2. package/.mock/definition/adHoc.yml +1 -4
  3. package/.mock/definition/api.yml +1 -1
  4. package/.mock/definition/containerImages.yml +0 -6
  5. package/.mock/definition/folderEntities.yml +1 -1
  6. package/.mock/definition/metricDefinitions.yml +1 -4
  7. package/.mock/definition/workflows.yml +3 -6
  8. package/.mock/openapi/openapi.yml +99 -14
  9. package/Client.d.ts +3 -5
  10. package/Client.js +12 -14
  11. package/api/resources/adHoc/client/Client.d.ts +3 -6
  12. package/api/resources/adHoc/client/Client.js +3 -6
  13. package/api/resources/containerImages/client/Client.d.ts +3 -7
  14. package/api/resources/containerImages/client/Client.js +5 -9
  15. package/api/resources/deployments/client/Client.d.ts +3 -3
  16. package/api/resources/deployments/client/Client.js +8 -8
  17. package/api/resources/documentIndexes/client/Client.d.ts +3 -3
  18. package/api/resources/documentIndexes/client/Client.js +9 -9
  19. package/api/resources/documents/client/Client.d.ts +3 -3
  20. package/api/resources/documents/client/Client.js +6 -6
  21. package/api/resources/folderEntities/client/Client.d.ts +3 -3
  22. package/api/resources/folderEntities/client/Client.js +3 -3
  23. package/api/resources/metricDefinitions/client/Client.d.ts +3 -5
  24. package/api/resources/metricDefinitions/client/Client.js +4 -6
  25. package/api/resources/mlModels/client/Client.d.ts +3 -3
  26. package/api/resources/mlModels/client/Client.js +2 -2
  27. package/api/resources/sandboxes/client/Client.d.ts +3 -3
  28. package/api/resources/sandboxes/client/Client.js +4 -4
  29. package/api/resources/testSuiteRuns/client/Client.d.ts +3 -3
  30. package/api/resources/testSuiteRuns/client/Client.js +4 -4
  31. package/api/resources/testSuites/client/Client.d.ts +3 -3
  32. package/api/resources/testSuites/client/Client.js +5 -5
  33. package/api/resources/workflowDeployments/client/Client.d.ts +3 -3
  34. package/api/resources/workflowDeployments/client/Client.js +7 -7
  35. package/api/resources/workflowSandboxes/client/Client.d.ts +3 -3
  36. package/api/resources/workflowSandboxes/client/Client.js +2 -2
  37. package/api/resources/workflows/client/Client.d.ts +3 -6
  38. package/api/resources/workflows/client/Client.js +6 -6
  39. package/api/resources/workflows/client/requests/WorkflowPushRequest.d.ts +1 -0
  40. package/api/resources/workspaceSecrets/client/Client.d.ts +3 -3
  41. package/api/resources/workspaceSecrets/client/Client.js +3 -3
  42. package/api/types/AudioPromptBlock.d.ts +14 -0
  43. package/api/types/AudioPromptBlock.js +5 -0
  44. package/api/types/FunctionCallPromptBlock.d.ts +15 -0
  45. package/api/types/FunctionCallPromptBlock.js +5 -0
  46. package/api/types/ImagePromptBlock.d.ts +14 -0
  47. package/api/types/ImagePromptBlock.js +5 -0
  48. package/api/types/PromptBlock.d.ts +1 -1
  49. package/api/types/WorkflowPushResponse.d.ts +1 -0
  50. package/api/types/index.d.ts +3 -0
  51. package/api/types/index.js +3 -0
  52. package/dist/Client.d.ts +3 -5
  53. package/dist/Client.js +12 -14
  54. package/dist/api/resources/adHoc/client/Client.d.ts +3 -6
  55. package/dist/api/resources/adHoc/client/Client.js +3 -6
  56. package/dist/api/resources/containerImages/client/Client.d.ts +3 -7
  57. package/dist/api/resources/containerImages/client/Client.js +5 -9
  58. package/dist/api/resources/deployments/client/Client.d.ts +3 -3
  59. package/dist/api/resources/deployments/client/Client.js +8 -8
  60. package/dist/api/resources/documentIndexes/client/Client.d.ts +3 -3
  61. package/dist/api/resources/documentIndexes/client/Client.js +9 -9
  62. package/dist/api/resources/documents/client/Client.d.ts +3 -3
  63. package/dist/api/resources/documents/client/Client.js +6 -6
  64. package/dist/api/resources/folderEntities/client/Client.d.ts +3 -3
  65. package/dist/api/resources/folderEntities/client/Client.js +3 -3
  66. package/dist/api/resources/metricDefinitions/client/Client.d.ts +3 -5
  67. package/dist/api/resources/metricDefinitions/client/Client.js +4 -6
  68. package/dist/api/resources/mlModels/client/Client.d.ts +3 -3
  69. package/dist/api/resources/mlModels/client/Client.js +2 -2
  70. package/dist/api/resources/sandboxes/client/Client.d.ts +3 -3
  71. package/dist/api/resources/sandboxes/client/Client.js +4 -4
  72. package/dist/api/resources/testSuiteRuns/client/Client.d.ts +3 -3
  73. package/dist/api/resources/testSuiteRuns/client/Client.js +4 -4
  74. package/dist/api/resources/testSuites/client/Client.d.ts +3 -3
  75. package/dist/api/resources/testSuites/client/Client.js +5 -5
  76. package/dist/api/resources/workflowDeployments/client/Client.d.ts +3 -3
  77. package/dist/api/resources/workflowDeployments/client/Client.js +7 -7
  78. package/dist/api/resources/workflowSandboxes/client/Client.d.ts +3 -3
  79. package/dist/api/resources/workflowSandboxes/client/Client.js +2 -2
  80. package/dist/api/resources/workflows/client/Client.d.ts +3 -6
  81. package/dist/api/resources/workflows/client/Client.js +6 -6
  82. package/dist/api/resources/workflows/client/requests/WorkflowPushRequest.d.ts +1 -0
  83. package/dist/api/resources/workspaceSecrets/client/Client.d.ts +3 -3
  84. package/dist/api/resources/workspaceSecrets/client/Client.js +3 -3
  85. package/dist/api/types/AudioPromptBlock.d.ts +14 -0
  86. package/dist/api/types/AudioPromptBlock.js +5 -0
  87. package/dist/api/types/FunctionCallPromptBlock.d.ts +15 -0
  88. package/dist/api/types/FunctionCallPromptBlock.js +5 -0
  89. package/dist/api/types/ImagePromptBlock.d.ts +14 -0
  90. package/dist/api/types/ImagePromptBlock.js +5 -0
  91. package/dist/api/types/PromptBlock.d.ts +1 -1
  92. package/dist/api/types/WorkflowPushResponse.d.ts +1 -0
  93. package/dist/api/types/index.d.ts +3 -0
  94. package/dist/api/types/index.js +3 -0
  95. package/dist/environments.d.ts +2 -2
  96. package/dist/environments.js +1 -1
  97. package/dist/serialization/types/AudioPromptBlock.d.ts +18 -0
  98. package/dist/serialization/types/AudioPromptBlock.js +39 -0
  99. package/dist/serialization/types/FunctionCallPromptBlock.d.ts +19 -0
  100. package/dist/serialization/types/FunctionCallPromptBlock.js +40 -0
  101. package/dist/serialization/types/ImagePromptBlock.d.ts +18 -0
  102. package/dist/serialization/types/ImagePromptBlock.js +39 -0
  103. package/dist/serialization/types/PromptBlock.d.ts +4 -1
  104. package/dist/serialization/types/PromptBlock.js +6 -0
  105. package/dist/serialization/types/WorkflowPushResponse.d.ts +1 -0
  106. package/dist/serialization/types/WorkflowPushResponse.js +1 -0
  107. package/dist/serialization/types/index.d.ts +3 -0
  108. package/dist/serialization/types/index.js +3 -0
  109. package/dist/version.d.ts +1 -1
  110. package/dist/version.js +1 -1
  111. package/environments.d.ts +2 -2
  112. package/environments.js +1 -1
  113. package/package.json +1 -1
  114. package/reference.md +0 -75
  115. package/serialization/types/AudioPromptBlock.d.ts +18 -0
  116. package/serialization/types/AudioPromptBlock.js +39 -0
  117. package/serialization/types/FunctionCallPromptBlock.d.ts +19 -0
  118. package/serialization/types/FunctionCallPromptBlock.js +40 -0
  119. package/serialization/types/ImagePromptBlock.d.ts +18 -0
  120. package/serialization/types/ImagePromptBlock.js +39 -0
  121. package/serialization/types/PromptBlock.d.ts +4 -1
  122. package/serialization/types/PromptBlock.js +6 -0
  123. package/serialization/types/WorkflowPushResponse.d.ts +1 -0
  124. package/serialization/types/WorkflowPushResponse.js +1 -0
  125. package/serialization/types/index.d.ts +3 -0
  126. package/serialization/types/index.js +3 -0
  127. package/version.d.ts +1 -1
  128. package/version.js +1 -1
@@ -42,9 +42,6 @@ service:
42
42
  path: /v1/execute-code
43
43
  method: POST
44
44
  auth: true
45
- docs: >-
46
- An internal-only endpoint that's subject to breaking changes without
47
- notice. Not intended for public use.
48
45
  source:
49
46
  openapi: openapi/openapi.yml
50
47
  request:
@@ -63,7 +60,7 @@ service:
63
60
  response:
64
61
  docs: ''
65
62
  type: CodeExecutorResponse
66
- url: Default
63
+ url: Predict
67
64
  availability: pre-release
68
65
  errors:
69
66
  - BadRequestError
@@ -986,6 +983,19 @@ types:
986
983
  source:
987
984
  openapi: openapi/openapi.yml
988
985
  AudioEnum: literal<"AUDIO">
986
+ AudioPromptBlock:
987
+ docs: A block that represents an audio file in a prompt template.
988
+ properties:
989
+ block_type: literal<"AUDIO">
990
+ state: optional<PromptBlockState>
991
+ cache_config: optional<EphemeralPromptCacheConfig>
992
+ src:
993
+ type: string
994
+ validation:
995
+ minLength: 1
996
+ metadata: optional<map<string, unknown>>
997
+ source:
998
+ openapi: openapi/openapi.yml
989
999
  AudioVariableValue:
990
1000
  docs: A base Vellum primitive value representing audio.
991
1001
  properties:
@@ -2265,6 +2275,23 @@ types:
2265
2275
  value: FunctionCall
2266
2276
  source:
2267
2277
  openapi: openapi/openapi.yml
2278
+ FunctionCallPromptBlock:
2279
+ docs: A block that represents a function call in a prompt template.
2280
+ properties:
2281
+ block_type: literal<"FUNCTION_CALL">
2282
+ state: optional<PromptBlockState>
2283
+ cache_config: optional<EphemeralPromptCacheConfig>
2284
+ id:
2285
+ type: optional<string>
2286
+ validation:
2287
+ minLength: 1
2288
+ name:
2289
+ type: string
2290
+ validation:
2291
+ minLength: 1
2292
+ arguments: map<string, unknown>
2293
+ source:
2294
+ openapi: openapi/openapi.yml
2268
2295
  FunctionCallRequest:
2269
2296
  docs: The final resolved function call value.
2270
2297
  properties:
@@ -2495,6 +2522,19 @@ types:
2495
2522
  source:
2496
2523
  openapi: openapi/openapi.yml
2497
2524
  ImageEnum: literal<"IMAGE">
2525
+ ImagePromptBlock:
2526
+ docs: A block that represents an image in a prompt template.
2527
+ properties:
2528
+ block_type: literal<"IMAGE">
2529
+ state: optional<PromptBlockState>
2530
+ cache_config: optional<EphemeralPromptCacheConfig>
2531
+ src:
2532
+ type: string
2533
+ validation:
2534
+ minLength: 1
2535
+ metadata: optional<map<string, unknown>>
2536
+ source:
2537
+ openapi: openapi/openapi.yml
2498
2538
  ImageVariableValue:
2499
2539
  docs: A base Vellum primitive value representing an image.
2500
2540
  properties:
@@ -3621,6 +3661,9 @@ types:
3621
3661
  - ChatMessagePromptBlock
3622
3662
  - VariablePromptBlock
3623
3663
  - RichTextPromptBlock
3664
+ - AudioPromptBlock
3665
+ - FunctionCallPromptBlock
3666
+ - ImagePromptBlock
3624
3667
  source:
3625
3668
  openapi: openapi/openapi.yml
3626
3669
  PromptBlockState:
@@ -6478,6 +6521,7 @@ types:
6478
6521
  type: optional<string>
6479
6522
  validation:
6480
6523
  format: uuid
6524
+ proposed_diffs: optional<map<string, unknown>>
6481
6525
  source:
6482
6526
  openapi: openapi/openapi.yml
6483
6527
  WorkflowReleaseTagRead:
@@ -8,9 +8,6 @@ service:
8
8
  path: /v1/ad-hoc/execute-prompt-stream
9
9
  method: POST
10
10
  auth: true
11
- docs: >-
12
- An internal-only endpoint that's subject to breaking changes without
13
- notice. Not intended for public use.
14
11
  source:
15
12
  openapi: openapi/openapi.yml
16
13
  request:
@@ -33,7 +30,7 @@ service:
33
30
  docs: ''
34
31
  type: root.AdHocExecutePromptEvent
35
32
  format: json
36
- url: Default
33
+ url: Predict
37
34
  availability: pre-release
38
35
  errors:
39
36
  - root.BadRequestError
@@ -6,8 +6,8 @@ environments:
6
6
  Production:
7
7
  urls:
8
8
  Default: https://api.vellum.ai
9
- Documents: https://documents.vellum.ai
10
9
  Predict: https://predict.vellum.ai
10
+ Documents: https://documents.vellum.ai
11
11
  default-environment: Production
12
12
  auth-schemes:
13
13
  apiKeyAuth:
@@ -82,9 +82,6 @@ service:
82
82
  path: /v1/container-images/docker-service-token
83
83
  method: GET
84
84
  auth: true
85
- docs: >-
86
- An internal-only endpoint that's subject to breaking changes without
87
- notice. Not intended for public use.
88
85
  source:
89
86
  openapi: openapi/openapi.yml
90
87
  response:
@@ -104,9 +101,6 @@ service:
104
101
  path: /v1/container-images/push
105
102
  method: POST
106
103
  auth: true
107
- docs: >-
108
- An internal-only endpoint that's subject to breaking changes without
109
- notice. Not intended for public use.
110
104
  source:
111
105
  openapi: openapi/openapi.yml
112
106
  request:
@@ -14,7 +14,7 @@ service:
14
14
  list:
15
15
  path: /v1/folder-entities
16
16
  method: GET
17
- auth: false
17
+ auth: true
18
18
  docs: List all folder entities within a specified folder.
19
19
  source:
20
20
  openapi: openapi/openapi.yml
@@ -8,9 +8,6 @@ service:
8
8
  path: /v1/metric-definitions/{id}/execute
9
9
  method: POST
10
10
  auth: true
11
- docs: >-
12
- An internal-only endpoint that's subject to breaking changes without
13
- notice. Not intended for public use.
14
11
  source:
15
12
  openapi: openapi/openapi.yml
16
13
  path-parameters:
@@ -30,7 +27,7 @@ service:
30
27
  response:
31
28
  docs: ''
32
29
  type: root.MetricDefinitionExecution
33
- url: Default
30
+ url: Predict
34
31
  availability: pre-release
35
32
  examples:
36
33
  - path-parameters:
@@ -15,9 +15,6 @@ service:
15
15
  path: /v1/workflows/{id}/pull
16
16
  method: GET
17
17
  auth: true
18
- docs: >-
19
- An internal-only endpoint that's subject to breaking changes without
20
- notice. Not intended for public use.
21
18
  source:
22
19
  openapi: openapi/openapi.yml
23
20
  path-parameters:
@@ -45,9 +42,6 @@ service:
45
42
  path: /v1/workflows/push
46
43
  method: POST
47
44
  auth: true
48
- docs: >-
49
- An internal-only endpoint that's subject to breaking changes without
50
- notice. Not intended for public use.
51
45
  source:
52
46
  openapi: openapi/openapi.yml
53
47
  request:
@@ -67,6 +61,7 @@ service:
67
61
  format: uuid
68
62
  deployment_config: optional<root.WorkflowPushDeploymentConfigRequest>
69
63
  artifact: optional<file>
64
+ dry_run: optional<boolean>
70
65
  content-type: multipart/form-data
71
66
  response:
72
67
  docs: ''
@@ -81,6 +76,8 @@ service:
81
76
  body:
82
77
  workflow_sandbox_id: workflow_sandbox_id
83
78
  workflow_deployment_id: workflow_deployment_id
79
+ proposed_diffs:
80
+ key: value
84
81
  audiences:
85
82
  - internal
86
83
  source:
@@ -40,8 +40,6 @@ paths:
40
40
  /v1/ad-hoc/execute-prompt-stream:
41
41
  post:
42
42
  operationId: adhoc_execute_prompt_stream
43
- description: An internal-only endpoint that's subject to breaking changes without
44
- notice. Not intended for public use.
45
43
  tags:
46
44
  - ad-hoc
47
45
  requestBody:
@@ -81,6 +79,9 @@ paths:
81
79
  x-fern-availability: beta
82
80
  x-fern-audiences:
83
81
  - internal
82
+ servers:
83
+ - url: https://predict.vellum.ai
84
+ x-name: Predict
84
85
  /v1/container-images:
85
86
  get:
86
87
  operationId: container_images_list
@@ -148,8 +149,6 @@ paths:
148
149
  /v1/container-images/docker-service-token:
149
150
  get:
150
151
  operationId: docker-service-token
151
- description: An internal-only endpoint that's subject to breaking changes without
152
- notice. Not intended for public use.
153
152
  tags:
154
153
  - container-images
155
154
  security:
@@ -167,8 +166,6 @@ paths:
167
166
  /v1/container-images/push:
168
167
  post:
169
168
  operationId: push_container_image
170
- description: An internal-only endpoint that's subject to breaking changes without
171
- notice. Not intended for public use.
172
169
  tags:
173
170
  - container-images
174
171
  requestBody:
@@ -919,8 +916,6 @@ paths:
919
916
  /v1/execute-code:
920
917
  post:
921
918
  operationId: execute_code
922
- description: An internal-only endpoint that's subject to breaking changes without
923
- notice. Not intended for public use.
924
919
  tags:
925
920
  - execute-code
926
921
  requestBody:
@@ -947,6 +942,9 @@ paths:
947
942
  x-fern-availability: beta
948
943
  x-fern-audiences:
949
944
  - internal
945
+ servers:
946
+ - url: https://predict.vellum.ai
947
+ x-name: Predict
950
948
  /v1/execute-prompt:
951
949
  post:
952
950
  operationId: execute_prompt
@@ -1195,6 +1193,8 @@ paths:
1195
1193
  required: true
1196
1194
  tags:
1197
1195
  - folder-entities
1196
+ security:
1197
+ - apiKeyAuth: []
1198
1198
  responses:
1199
1199
  '200':
1200
1200
  content:
@@ -1356,8 +1356,6 @@ paths:
1356
1356
  /v1/metric-definitions/{id}/execute:
1357
1357
  post:
1358
1358
  operationId: execute_metric_definition
1359
- description: An internal-only endpoint that's subject to breaking changes without
1360
- notice. Not intended for public use.
1361
1359
  parameters:
1362
1360
  - in: path
1363
1361
  name: id
@@ -1385,6 +1383,9 @@ paths:
1385
1383
  x-fern-availability: beta
1386
1384
  x-fern-audiences:
1387
1385
  - internal
1386
+ servers:
1387
+ - url: https://predict.vellum.ai
1388
+ x-name: Predict
1388
1389
  /v1/metric-definitions/{id}/history/{history_id_or_release_tag}:
1389
1390
  get:
1390
1391
  operationId: metric_definition_history_item_retrieve
@@ -2273,8 +2274,6 @@ paths:
2273
2274
  /v1/workflows/{id}/pull:
2274
2275
  get:
2275
2276
  operationId: workflows_pull
2276
- description: An internal-only endpoint that's subject to breaking changes without
2277
- notice. Not intended for public use.
2278
2277
  parameters:
2279
2278
  - in: query
2280
2279
  name: exclude_code
@@ -2330,8 +2329,6 @@ paths:
2330
2329
  /v1/workflows/push:
2331
2330
  post:
2332
2331
  operationId: workflows_push
2333
- description: An internal-only endpoint that's subject to breaking changes without
2334
- notice. Not intended for public use.
2335
2332
  tags:
2336
2333
  - workflows
2337
2334
  requestBody:
@@ -2747,6 +2744,30 @@ components:
2747
2744
  type: string
2748
2745
  enum:
2749
2746
  - AUDIO
2747
+ AudioPromptBlock:
2748
+ type: object
2749
+ description: A block that represents an audio file in a prompt template.
2750
+ properties:
2751
+ block_type:
2752
+ $ref: '#/components/schemas/AudioEnum'
2753
+ state:
2754
+ allOf:
2755
+ - $ref: '#/components/schemas/PromptBlockState'
2756
+ default: ENABLED
2757
+ cache_config:
2758
+ allOf:
2759
+ - $ref: '#/components/schemas/EphemeralPromptCacheConfig'
2760
+ nullable: true
2761
+ src:
2762
+ type: string
2763
+ minLength: 1
2764
+ metadata:
2765
+ type: object
2766
+ additionalProperties: {}
2767
+ nullable: true
2768
+ required:
2769
+ - block_type
2770
+ - src
2750
2771
  AudioVariableValue:
2751
2772
  type: object
2752
2773
  description: A base Vellum primitive value representing audio.
@@ -5137,6 +5158,34 @@ components:
5137
5158
  - name
5138
5159
  - type
5139
5160
  - value
5161
+ FunctionCallPromptBlock:
5162
+ type: object
5163
+ description: A block that represents a function call in a prompt template.
5164
+ properties:
5165
+ block_type:
5166
+ $ref: '#/components/schemas/FunctionCallEnum'
5167
+ state:
5168
+ allOf:
5169
+ - $ref: '#/components/schemas/PromptBlockState'
5170
+ default: ENABLED
5171
+ cache_config:
5172
+ allOf:
5173
+ - $ref: '#/components/schemas/EphemeralPromptCacheConfig'
5174
+ nullable: true
5175
+ id:
5176
+ type: string
5177
+ nullable: true
5178
+ minLength: 1
5179
+ name:
5180
+ type: string
5181
+ minLength: 1
5182
+ arguments:
5183
+ type: object
5184
+ additionalProperties: {}
5185
+ required:
5186
+ - arguments
5187
+ - block_type
5188
+ - name
5140
5189
  FunctionCallRequest:
5141
5190
  type: object
5142
5191
  description: The final resolved function call value.
@@ -5509,6 +5558,30 @@ components:
5509
5558
  type: string
5510
5559
  enum:
5511
5560
  - IMAGE
5561
+ ImagePromptBlock:
5562
+ type: object
5563
+ description: A block that represents an image in a prompt template.
5564
+ properties:
5565
+ block_type:
5566
+ $ref: '#/components/schemas/ImageEnum'
5567
+ state:
5568
+ allOf:
5569
+ - $ref: '#/components/schemas/PromptBlockState'
5570
+ default: ENABLED
5571
+ cache_config:
5572
+ allOf:
5573
+ - $ref: '#/components/schemas/EphemeralPromptCacheConfig'
5574
+ nullable: true
5575
+ src:
5576
+ type: string
5577
+ minLength: 1
5578
+ metadata:
5579
+ type: object
5580
+ additionalProperties: {}
5581
+ nullable: true
5582
+ required:
5583
+ - block_type
5584
+ - src
5512
5585
  ImageVariableValue:
5513
5586
  type: object
5514
5587
  description: A base Vellum primitive value representing an image.
@@ -7409,6 +7482,9 @@ components:
7409
7482
  - $ref: '#/components/schemas/ChatMessagePromptBlock'
7410
7483
  - $ref: '#/components/schemas/VariablePromptBlock'
7411
7484
  - $ref: '#/components/schemas/RichTextPromptBlock'
7485
+ - $ref: '#/components/schemas/AudioPromptBlock'
7486
+ - $ref: '#/components/schemas/FunctionCallPromptBlock'
7487
+ - $ref: '#/components/schemas/ImagePromptBlock'
7412
7488
  discriminator:
7413
7489
  propertyName: block_type
7414
7490
  mapping:
@@ -7416,6 +7492,9 @@ components:
7416
7492
  CHAT_MESSAGE: '#/components/schemas/ChatMessagePromptBlock'
7417
7493
  VARIABLE: '#/components/schemas/VariablePromptBlock'
7418
7494
  RICH_TEXT: '#/components/schemas/RichTextPromptBlock'
7495
+ AUDIO: '#/components/schemas/AudioPromptBlock'
7496
+ FUNCTION_CALL: '#/components/schemas/FunctionCallPromptBlock'
7497
+ IMAGE: '#/components/schemas/ImagePromptBlock'
7419
7498
  PromptBlockState:
7420
7499
  enum:
7421
7500
  - ENABLED
@@ -11646,6 +11725,8 @@ components:
11646
11725
  type: string
11647
11726
  format: binary
11648
11727
  description: The contents of the artifact tar.gz file.
11728
+ dry_run:
11729
+ type: boolean
11649
11730
  required:
11650
11731
  - exec_config
11651
11732
  - label
@@ -11659,6 +11740,10 @@ components:
11659
11740
  type: string
11660
11741
  format: uuid
11661
11742
  nullable: true
11743
+ proposed_diffs:
11744
+ type: object
11745
+ additionalProperties: {}
11746
+ nullable: true
11662
11747
  required:
11663
11748
  - workflow_sandbox_id
11664
11749
  WorkflowReleaseTagRead:
package/Client.d.ts CHANGED
@@ -22,7 +22,7 @@ import { WorkspaceSecrets } from "./api/resources/workspaceSecrets/client/Client
22
22
  export declare namespace VellumClient {
23
23
  interface Options {
24
24
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
25
- apiKey?: core.Supplier<string | undefined>;
25
+ apiKey: core.Supplier<string>;
26
26
  }
27
27
  interface RequestOptions {
28
28
  /** The maximum time to wait for a response in seconds. */
@@ -35,10 +35,8 @@ export declare namespace VellumClient {
35
35
  }
36
36
  export declare class VellumClient {
37
37
  protected readonly _options: VellumClient.Options;
38
- constructor(_options?: VellumClient.Options);
38
+ constructor(_options: VellumClient.Options);
39
39
  /**
40
- * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
41
- *
42
40
  * @param {Vellum.CodeExecutor} request
43
41
  * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
44
42
  *
@@ -220,6 +218,6 @@ export declare class VellumClient {
220
218
  protected _workspaceSecrets: WorkspaceSecrets | undefined;
221
219
  get workspaceSecrets(): WorkspaceSecrets;
222
220
  protected _getCustomAuthorizationHeaders(): Promise<{
223
- X_API_KEY: string | undefined;
221
+ X_API_KEY: string;
224
222
  }>;
225
223
  }
package/Client.js CHANGED
@@ -61,12 +61,10 @@ const Client_13 = require("./api/resources/workflowSandboxes/client/Client");
61
61
  const Client_14 = require("./api/resources/workflows/client/Client");
62
62
  const Client_15 = require("./api/resources/workspaceSecrets/client/Client");
63
63
  class VellumClient {
64
- constructor(_options = {}) {
64
+ constructor(_options) {
65
65
  this._options = _options;
66
66
  }
67
67
  /**
68
- * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
69
- *
70
68
  * @param {Vellum.CodeExecutor} request
71
69
  * @param {VellumClient.RequestOptions} requestOptions - Request-specific configuration.
72
70
  *
@@ -93,9 +91,9 @@ class VellumClient {
93
91
  return __awaiter(this, void 0, void 0, function* () {
94
92
  const _response = yield core.fetcher({
95
93
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
96
- .default, "v1/execute-code"),
94
+ .predict, "v1/execute-code"),
97
95
  method: "POST",
98
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
96
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
99
97
  contentType: "application/json",
100
98
  requestType: "json",
101
99
  body: serializers.CodeExecutor.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -164,7 +162,7 @@ class VellumClient {
164
162
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
165
163
  .predict, "v1/execute-prompt"),
166
164
  method: "POST",
167
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
165
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
168
166
  contentType: "application/json",
169
167
  requestType: "json",
170
168
  body: serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -222,7 +220,7 @@ class VellumClient {
222
220
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
223
221
  .predict, "v1/execute-prompt-stream"),
224
222
  method: "POST",
225
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
223
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
226
224
  contentType: "application/json",
227
225
  requestType: "json",
228
226
  body: serializers.ExecutePromptStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -307,7 +305,7 @@ class VellumClient {
307
305
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
308
306
  .predict, "v1/execute-workflow"),
309
307
  method: "POST",
310
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
308
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
311
309
  contentType: "application/json",
312
310
  requestType: "json",
313
311
  body: serializers.ExecuteWorkflowRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -363,7 +361,7 @@ class VellumClient {
363
361
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
364
362
  .predict, "v1/execute-workflow-stream"),
365
363
  method: "POST",
366
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
364
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
367
365
  contentType: "application/json",
368
366
  requestType: "json",
369
367
  body: serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -450,7 +448,7 @@ class VellumClient {
450
448
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
451
449
  .predict, "v1/generate"),
452
450
  method: "POST",
453
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
451
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
454
452
  contentType: "application/json",
455
453
  requestType: "json",
456
454
  body: serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -511,7 +509,7 @@ class VellumClient {
511
509
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
512
510
  .predict, "v1/generate-stream"),
513
511
  method: "POST",
514
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
512
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
515
513
  contentType: "application/json",
516
514
  requestType: "json",
517
515
  body: serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -592,7 +590,7 @@ class VellumClient {
592
590
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
593
591
  .predict, "v1/search"),
594
592
  method: "POST",
595
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
593
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
596
594
  contentType: "application/json",
597
595
  requestType: "json",
598
596
  body: serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -660,7 +658,7 @@ class VellumClient {
660
658
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
661
659
  .predict, "v1/submit-completion-actuals"),
662
660
  method: "POST",
663
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
661
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
664
662
  contentType: "application/json",
665
663
  requestType: "json",
666
664
  body: serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -723,7 +721,7 @@ class VellumClient {
723
721
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
724
722
  .predict, "v1/submit-workflow-execution-actuals"),
725
723
  method: "POST",
726
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
724
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
727
725
  contentType: "application/json",
728
726
  requestType: "json",
729
727
  body: serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
@@ -7,7 +7,7 @@ import * as Vellum from "../../../index";
7
7
  export declare namespace AdHoc {
8
8
  interface Options {
9
9
  environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
10
- apiKey?: core.Supplier<string | undefined>;
10
+ apiKey: core.Supplier<string>;
11
11
  }
12
12
  interface RequestOptions {
13
13
  /** The maximum time to wait for a response in seconds. */
@@ -20,12 +20,9 @@ export declare namespace AdHoc {
20
20
  }
21
21
  export declare class AdHoc {
22
22
  protected readonly _options: AdHoc.Options;
23
- constructor(_options?: AdHoc.Options);
24
- /**
25
- * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
26
- */
23
+ constructor(_options: AdHoc.Options);
27
24
  adhocExecutePromptStream(request: Vellum.AdHocExecutePromptStream, requestOptions?: AdHoc.RequestOptions): Promise<core.Stream<Vellum.AdHocExecutePromptEvent>>;
28
25
  protected _getCustomAuthorizationHeaders(): Promise<{
29
- X_API_KEY: string | undefined;
26
+ X_API_KEY: string;
30
27
  }>;
31
28
  }
@@ -46,20 +46,17 @@ const serializers = __importStar(require("../../../../serialization/index"));
46
46
  const url_join_1 = __importDefault(require("url-join"));
47
47
  const errors = __importStar(require("../../../../errors/index"));
48
48
  class AdHoc {
49
- constructor(_options = {}) {
49
+ constructor(_options) {
50
50
  this._options = _options;
51
51
  }
52
- /**
53
- * An internal-only endpoint that's subject to breaking changes without notice. Not intended for public use.
54
- */
55
52
  adhocExecutePromptStream(request, requestOptions) {
56
53
  var _a;
57
54
  return __awaiter(this, void 0, void 0, function* () {
58
55
  const _response = yield core.fetcher({
59
56
  url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
60
- .default, "v1/ad-hoc/execute-prompt-stream"),
57
+ .predict, "v1/ad-hoc/execute-prompt-stream"),
61
58
  method: "POST",
62
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.14", "User-Agent": "vellum-ai/0.12.14", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
59
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.12.15", "User-Agent": "vellum-ai/0.12.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
63
60
  contentType: "application/json",
64
61
  requestType: "json",
65
62
  body: serializers.AdHocExecutePromptStream.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),