vellum-ai 0.9.3 → 0.9.5

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 (219) hide show
  1. package/.mock/definition/__package__.yml +77 -1
  2. package/.mock/definition/deployments.yml +50 -1
  3. package/.mock/definition/workflowDeployments.yml +49 -0
  4. package/.mock/definition/workflows.yml +17 -2
  5. package/.mock/openapi/openapi.yml +232 -1
  6. package/Client.js +10 -10
  7. package/api/resources/adHoc/client/Client.js +1 -1
  8. package/api/resources/containerImages/client/Client.js +4 -4
  9. package/api/resources/deployments/client/Client.d.ts +12 -1
  10. package/api/resources/deployments/client/Client.js +74 -6
  11. package/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.d.ts +23 -0
  12. package/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.js +5 -0
  13. package/api/resources/deployments/client/requests/index.d.ts +1 -0
  14. package/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +8 -0
  15. package/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +10 -0
  16. package/api/resources/deployments/types/index.d.ts +1 -0
  17. package/api/resources/deployments/types/index.js +1 -0
  18. package/api/resources/documentIndexes/client/Client.js +8 -8
  19. package/api/resources/documents/client/Client.js +5 -5
  20. package/api/resources/folderEntities/client/Client.js +2 -2
  21. package/api/resources/index.d.ts +2 -1
  22. package/api/resources/index.js +3 -2
  23. package/api/resources/metricDefinitions/client/Client.js +1 -1
  24. package/api/resources/sandboxes/client/Client.js +3 -3
  25. package/api/resources/testSuiteRuns/client/Client.js +3 -3
  26. package/api/resources/testSuites/client/Client.js +4 -4
  27. package/api/resources/workflowDeployments/client/Client.d.ts +11 -0
  28. package/api/resources/workflowDeployments/client/Client.js +72 -4
  29. package/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.d.ts +23 -0
  30. package/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.js +5 -0
  31. package/api/resources/workflowDeployments/client/requests/index.d.ts +1 -0
  32. package/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +8 -0
  33. package/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +10 -0
  34. package/api/resources/workflowDeployments/types/index.d.ts +1 -0
  35. package/api/resources/workflowDeployments/types/index.js +1 -0
  36. package/api/resources/workflowSandboxes/client/Client.js +1 -1
  37. package/api/resources/workflows/client/Client.d.ts +3 -2
  38. package/api/resources/workflows/client/Client.js +20 -7
  39. package/api/resources/workflows/client/requests/WorkflowPushRequest.d.ts +1 -0
  40. package/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +13 -0
  41. package/api/resources/workflows/client/requests/WorkflowsPullRequest.js +5 -0
  42. package/api/resources/workflows/client/requests/index.d.ts +1 -0
  43. package/api/resources/workflows/index.d.ts +1 -0
  44. package/api/resources/workflows/index.js +1 -0
  45. package/api/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +8 -0
  46. package/api/resources/workflows/types/WorkflowsPullRequestFormat.js +10 -0
  47. package/api/resources/workflows/types/index.d.ts +1 -0
  48. package/api/resources/workflows/types/index.js +17 -0
  49. package/api/resources/workspaceSecrets/client/Client.js +2 -2
  50. package/api/types/ArrayVariableValueItem.d.ts +1 -1
  51. package/api/types/AudioVariableValue.d.ts +11 -0
  52. package/api/types/AudioVariableValue.js +5 -0
  53. package/api/types/AudioVellumValue.d.ts +11 -0
  54. package/api/types/AudioVellumValue.js +5 -0
  55. package/api/types/AudioVellumValueRequest.d.ts +11 -0
  56. package/api/types/AudioVellumValueRequest.js +5 -0
  57. package/api/types/PaginatedDeploymentReleaseTagReadList.d.ts +10 -0
  58. package/api/types/PaginatedDeploymentReleaseTagReadList.js +5 -0
  59. package/api/types/PaginatedWorkflowReleaseTagReadList.d.ts +10 -0
  60. package/api/types/PaginatedWorkflowReleaseTagReadList.js +5 -0
  61. package/api/types/VellumAudio.d.ts +1 -0
  62. package/api/types/VellumAudioRequest.d.ts +1 -0
  63. package/api/types/VellumValue.d.ts +1 -1
  64. package/api/types/VellumValueRequest.d.ts +1 -1
  65. package/api/types/WorkflowPushDeploymentConfigRequest.d.ts +9 -0
  66. package/api/types/WorkflowPushDeploymentConfigRequest.js +5 -0
  67. package/api/types/WorkflowPushResponse.d.ts +1 -0
  68. package/api/types/index.d.ts +6 -0
  69. package/api/types/index.js +6 -0
  70. package/dist/Client.js +10 -10
  71. package/dist/api/resources/adHoc/client/Client.js +1 -1
  72. package/dist/api/resources/containerImages/client/Client.js +4 -4
  73. package/dist/api/resources/deployments/client/Client.d.ts +12 -1
  74. package/dist/api/resources/deployments/client/Client.js +74 -6
  75. package/dist/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.d.ts +23 -0
  76. package/dist/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.js +5 -0
  77. package/dist/api/resources/deployments/client/requests/index.d.ts +1 -0
  78. package/dist/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +8 -0
  79. package/dist/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +10 -0
  80. package/dist/api/resources/deployments/types/index.d.ts +1 -0
  81. package/dist/api/resources/deployments/types/index.js +1 -0
  82. package/dist/api/resources/documentIndexes/client/Client.js +8 -8
  83. package/dist/api/resources/documents/client/Client.js +5 -5
  84. package/dist/api/resources/folderEntities/client/Client.js +2 -2
  85. package/dist/api/resources/index.d.ts +2 -1
  86. package/dist/api/resources/index.js +3 -2
  87. package/dist/api/resources/metricDefinitions/client/Client.js +1 -1
  88. package/dist/api/resources/sandboxes/client/Client.js +3 -3
  89. package/dist/api/resources/testSuiteRuns/client/Client.js +3 -3
  90. package/dist/api/resources/testSuites/client/Client.js +4 -4
  91. package/dist/api/resources/workflowDeployments/client/Client.d.ts +11 -0
  92. package/dist/api/resources/workflowDeployments/client/Client.js +72 -4
  93. package/dist/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.d.ts +23 -0
  94. package/dist/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.js +5 -0
  95. package/dist/api/resources/workflowDeployments/client/requests/index.d.ts +1 -0
  96. package/dist/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +8 -0
  97. package/dist/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +10 -0
  98. package/dist/api/resources/workflowDeployments/types/index.d.ts +1 -0
  99. package/dist/api/resources/workflowDeployments/types/index.js +1 -0
  100. package/dist/api/resources/workflowSandboxes/client/Client.js +1 -1
  101. package/dist/api/resources/workflows/client/Client.d.ts +3 -2
  102. package/dist/api/resources/workflows/client/Client.js +20 -7
  103. package/dist/api/resources/workflows/client/requests/WorkflowPushRequest.d.ts +1 -0
  104. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +13 -0
  105. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.js +5 -0
  106. package/dist/api/resources/workflows/client/requests/index.d.ts +1 -0
  107. package/dist/api/resources/workflows/index.d.ts +1 -0
  108. package/dist/api/resources/workflows/index.js +1 -0
  109. package/dist/api/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +8 -0
  110. package/dist/api/resources/workflows/types/WorkflowsPullRequestFormat.js +10 -0
  111. package/dist/api/resources/workflows/types/index.d.ts +1 -0
  112. package/dist/api/resources/workflows/types/index.js +17 -0
  113. package/dist/api/resources/workspaceSecrets/client/Client.js +2 -2
  114. package/dist/api/types/ArrayVariableValueItem.d.ts +1 -1
  115. package/dist/api/types/AudioVariableValue.d.ts +11 -0
  116. package/dist/api/types/AudioVariableValue.js +5 -0
  117. package/dist/api/types/AudioVellumValue.d.ts +11 -0
  118. package/dist/api/types/AudioVellumValue.js +5 -0
  119. package/dist/api/types/AudioVellumValueRequest.d.ts +11 -0
  120. package/dist/api/types/AudioVellumValueRequest.js +5 -0
  121. package/dist/api/types/PaginatedDeploymentReleaseTagReadList.d.ts +10 -0
  122. package/dist/api/types/PaginatedDeploymentReleaseTagReadList.js +5 -0
  123. package/dist/api/types/PaginatedWorkflowReleaseTagReadList.d.ts +10 -0
  124. package/dist/api/types/PaginatedWorkflowReleaseTagReadList.js +5 -0
  125. package/dist/api/types/VellumAudio.d.ts +1 -0
  126. package/dist/api/types/VellumAudioRequest.d.ts +1 -0
  127. package/dist/api/types/VellumValue.d.ts +1 -1
  128. package/dist/api/types/VellumValueRequest.d.ts +1 -1
  129. package/dist/api/types/WorkflowPushDeploymentConfigRequest.d.ts +9 -0
  130. package/dist/api/types/WorkflowPushDeploymentConfigRequest.js +5 -0
  131. package/dist/api/types/WorkflowPushResponse.d.ts +1 -0
  132. package/dist/api/types/index.d.ts +6 -0
  133. package/dist/api/types/index.js +6 -0
  134. package/dist/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +10 -0
  135. package/dist/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +31 -0
  136. package/dist/serialization/resources/deployments/types/index.d.ts +1 -0
  137. package/dist/serialization/resources/deployments/types/index.js +1 -0
  138. package/dist/serialization/resources/index.d.ts +2 -1
  139. package/dist/serialization/resources/index.js +3 -2
  140. package/dist/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +10 -0
  141. package/dist/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +31 -0
  142. package/dist/serialization/resources/workflowDeployments/types/index.d.ts +1 -0
  143. package/dist/serialization/resources/workflowDeployments/types/index.js +1 -0
  144. package/dist/serialization/resources/workflows/client/requests/WorkflowPushRequest.d.ts +2 -0
  145. package/dist/serialization/resources/workflows/client/requests/WorkflowPushRequest.js +2 -0
  146. package/dist/serialization/resources/workflows/index.d.ts +1 -0
  147. package/dist/serialization/resources/workflows/index.js +1 -0
  148. package/dist/serialization/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +10 -0
  149. package/dist/serialization/resources/workflows/types/WorkflowsPullRequestFormat.js +31 -0
  150. package/dist/serialization/resources/workflows/types/index.d.ts +1 -0
  151. package/dist/serialization/resources/workflows/types/index.js +17 -0
  152. package/dist/serialization/types/ArrayVariableValueItem.d.ts +2 -1
  153. package/dist/serialization/types/ArrayVariableValueItem.js +2 -0
  154. package/dist/serialization/types/AudioVariableValue.d.ts +14 -0
  155. package/dist/serialization/types/AudioVariableValue.js +35 -0
  156. package/dist/serialization/types/AudioVellumValue.d.ts +14 -0
  157. package/dist/serialization/types/AudioVellumValue.js +35 -0
  158. package/dist/serialization/types/AudioVellumValueRequest.d.ts +14 -0
  159. package/dist/serialization/types/AudioVellumValueRequest.js +35 -0
  160. package/dist/serialization/types/PaginatedDeploymentReleaseTagReadList.d.ts +16 -0
  161. package/dist/serialization/types/PaginatedDeploymentReleaseTagReadList.js +37 -0
  162. package/dist/serialization/types/PaginatedWorkflowReleaseTagReadList.d.ts +16 -0
  163. package/dist/serialization/types/PaginatedWorkflowReleaseTagReadList.js +37 -0
  164. package/dist/serialization/types/VellumValue.d.ts +2 -1
  165. package/dist/serialization/types/VellumValue.js +2 -0
  166. package/dist/serialization/types/VellumValueRequest.d.ts +2 -1
  167. package/dist/serialization/types/VellumValueRequest.js +2 -0
  168. package/dist/serialization/types/WorkflowPushDeploymentConfigRequest.d.ts +15 -0
  169. package/dist/serialization/types/WorkflowPushDeploymentConfigRequest.js +36 -0
  170. package/dist/serialization/types/WorkflowPushResponse.d.ts +1 -0
  171. package/dist/serialization/types/WorkflowPushResponse.js +1 -0
  172. package/dist/serialization/types/index.d.ts +6 -0
  173. package/dist/serialization/types/index.js +6 -0
  174. package/dist/version.d.ts +1 -1
  175. package/dist/version.js +1 -1
  176. package/package.json +1 -1
  177. package/reference.md +155 -3
  178. package/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +10 -0
  179. package/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +31 -0
  180. package/serialization/resources/deployments/types/index.d.ts +1 -0
  181. package/serialization/resources/deployments/types/index.js +1 -0
  182. package/serialization/resources/index.d.ts +2 -1
  183. package/serialization/resources/index.js +3 -2
  184. package/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +10 -0
  185. package/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +31 -0
  186. package/serialization/resources/workflowDeployments/types/index.d.ts +1 -0
  187. package/serialization/resources/workflowDeployments/types/index.js +1 -0
  188. package/serialization/resources/workflows/client/requests/WorkflowPushRequest.d.ts +2 -0
  189. package/serialization/resources/workflows/client/requests/WorkflowPushRequest.js +2 -0
  190. package/serialization/resources/workflows/index.d.ts +1 -0
  191. package/serialization/resources/workflows/index.js +1 -0
  192. package/serialization/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +10 -0
  193. package/serialization/resources/workflows/types/WorkflowsPullRequestFormat.js +31 -0
  194. package/serialization/resources/workflows/types/index.d.ts +1 -0
  195. package/serialization/resources/workflows/types/index.js +17 -0
  196. package/serialization/types/ArrayVariableValueItem.d.ts +2 -1
  197. package/serialization/types/ArrayVariableValueItem.js +2 -0
  198. package/serialization/types/AudioVariableValue.d.ts +14 -0
  199. package/serialization/types/AudioVariableValue.js +35 -0
  200. package/serialization/types/AudioVellumValue.d.ts +14 -0
  201. package/serialization/types/AudioVellumValue.js +35 -0
  202. package/serialization/types/AudioVellumValueRequest.d.ts +14 -0
  203. package/serialization/types/AudioVellumValueRequest.js +35 -0
  204. package/serialization/types/PaginatedDeploymentReleaseTagReadList.d.ts +16 -0
  205. package/serialization/types/PaginatedDeploymentReleaseTagReadList.js +37 -0
  206. package/serialization/types/PaginatedWorkflowReleaseTagReadList.d.ts +16 -0
  207. package/serialization/types/PaginatedWorkflowReleaseTagReadList.js +37 -0
  208. package/serialization/types/VellumValue.d.ts +2 -1
  209. package/serialization/types/VellumValue.js +2 -0
  210. package/serialization/types/VellumValueRequest.d.ts +2 -1
  211. package/serialization/types/VellumValueRequest.js +2 -0
  212. package/serialization/types/WorkflowPushDeploymentConfigRequest.d.ts +15 -0
  213. package/serialization/types/WorkflowPushDeploymentConfigRequest.js +36 -0
  214. package/serialization/types/WorkflowPushResponse.d.ts +1 -0
  215. package/serialization/types/WorkflowPushResponse.js +1 -0
  216. package/serialization/types/index.d.ts +6 -0
  217. package/serialization/types/index.js +6 -0
  218. package/version.d.ts +1 -1
  219. package/version.js +1 -1
@@ -822,6 +822,7 @@ types:
822
822
  - ErrorVariableValue
823
823
  - FunctionCallVariableValue
824
824
  - ImageVariableValue
825
+ - AudioVariableValue
825
826
  - ChatHistoryVariableValue
826
827
  - SearchResultsVariableValue
827
828
  - ArrayVariableValue
@@ -856,6 +857,27 @@ types:
856
857
  source:
857
858
  openapi: openapi/openapi.yml
858
859
  AudioEnum: literal<"AUDIO">
860
+ AudioVariableValue:
861
+ docs: A base Vellum primitive value representing audio.
862
+ properties:
863
+ type: literal<"AUDIO">
864
+ value: optional<VellumAudio>
865
+ source:
866
+ openapi: openapi/openapi.yml
867
+ AudioVellumValue:
868
+ docs: A base Vellum primitive value representing audio.
869
+ properties:
870
+ type: literal<"AUDIO">
871
+ value: optional<VellumAudio>
872
+ source:
873
+ openapi: openapi/openapi.yml
874
+ AudioVellumValueRequest:
875
+ docs: A base Vellum primitive value representing audio.
876
+ properties:
877
+ type: literal<"AUDIO">
878
+ value: optional<VellumAudioRequest>
879
+ source:
880
+ openapi: openapi/openapi.yml
859
881
  BasicVectorizerIntfloatMultilingualE5Large:
860
882
  docs: Basic vectorizer for intfloat/multilingual-e5-large.
861
883
  properties:
@@ -3193,6 +3215,20 @@ types:
3193
3215
  results: optional<list<ContainerImageRead>>
3194
3216
  source:
3195
3217
  openapi: openapi/openapi.yml
3218
+ PaginatedDeploymentReleaseTagReadList:
3219
+ properties:
3220
+ count: optional<integer>
3221
+ next:
3222
+ type: optional<string>
3223
+ validation:
3224
+ format: uri
3225
+ previous:
3226
+ type: optional<string>
3227
+ validation:
3228
+ format: uri
3229
+ results: optional<list<DeploymentReleaseTagRead>>
3230
+ source:
3231
+ openapi: openapi/openapi.yml
3196
3232
  PaginatedDocumentIndexReadList:
3197
3233
  properties:
3198
3234
  count: optional<integer>
@@ -3291,6 +3327,20 @@ types:
3291
3327
  results: list<TestSuiteTestCase>
3292
3328
  source:
3293
3329
  openapi: openapi/openapi.yml
3330
+ PaginatedWorkflowReleaseTagReadList:
3331
+ properties:
3332
+ count: optional<integer>
3333
+ next:
3334
+ type: optional<string>
3335
+ validation:
3336
+ format: uri
3337
+ previous:
3338
+ type: optional<string>
3339
+ validation:
3340
+ format: uri
3341
+ results: optional<list<WorkflowReleaseTagRead>>
3342
+ source:
3343
+ openapi: openapi/openapi.yml
3294
3344
  PdfEnum: literal<"PDF">
3295
3345
  PdfSearchResultMetaSource:
3296
3346
  docs: The source of a search result from a PDF document.
@@ -5397,7 +5447,9 @@ types:
5397
5447
  openapi: openapi/openapi.yml
5398
5448
  VellumAudio:
5399
5449
  properties:
5400
- src: string
5450
+ src:
5451
+ type: string
5452
+ docs: A valid data URL containing the audio data.
5401
5453
  metadata: optional<map<string, unknown>>
5402
5454
  source:
5403
5455
  openapi: openapi/openapi.yml
@@ -5405,6 +5457,7 @@ types:
5405
5457
  properties:
5406
5458
  src:
5407
5459
  type: string
5460
+ docs: A valid data URL containing the audio data.
5408
5461
  validation:
5409
5462
  minLength: 1
5410
5463
  metadata: optional<map<string, unknown>>
@@ -5462,6 +5515,7 @@ types:
5462
5515
  - NumberVellumValue
5463
5516
  - JsonVellumValue
5464
5517
  - ImageVellumValue
5518
+ - AudioVellumValue
5465
5519
  - FunctionCallVellumValue
5466
5520
  - ErrorVellumValue
5467
5521
  - ArrayVellumValue
@@ -5503,6 +5557,7 @@ types:
5503
5557
  - NumberVellumValueRequest
5504
5558
  - JsonVellumValueRequest
5505
5559
  - ImageVellumValueRequest
5560
+ - AudioVellumValueRequest
5506
5561
  - FunctionCallVellumValueRequest
5507
5562
  - ErrorVellumValueRequest
5508
5563
  - ArrayVellumValueRequest
@@ -5993,6 +6048,23 @@ types:
5993
6048
  value: optional<string>
5994
6049
  source:
5995
6050
  openapi: openapi/openapi.yml
6051
+ WorkflowPushDeploymentConfigRequest:
6052
+ properties:
6053
+ label:
6054
+ type: optional<string>
6055
+ validation:
6056
+ minLength: 1
6057
+ name:
6058
+ type: optional<string>
6059
+ validation:
6060
+ minLength: 1
6061
+ description:
6062
+ type: optional<string>
6063
+ validation:
6064
+ minLength: 1
6065
+ release_tags: optional<list<string>>
6066
+ source:
6067
+ openapi: openapi/openapi.yml
5996
6068
  WorkflowPushExecConfig: map<string, unknown>
5997
6069
  WorkflowPushResponse:
5998
6070
  properties:
@@ -6000,6 +6072,10 @@ types:
6000
6072
  type: string
6001
6073
  validation:
6002
6074
  format: uuid
6075
+ workflow_deployment_id:
6076
+ type: optional<string>
6077
+ validation:
6078
+ format: uuid
6003
6079
  source:
6004
6080
  openapi: openapi/openapi.yml
6005
6081
  WorkflowReleaseTagRead:
@@ -5,6 +5,12 @@ types:
5
5
  - ARCHIVED
6
6
  source:
7
7
  openapi: openapi/openapi.yml
8
+ ListDeploymentReleaseTagsRequestSource:
9
+ enum:
10
+ - SYSTEM
11
+ - USER
12
+ source:
13
+ openapi: openapi/openapi.yml
8
14
  imports:
9
15
  root: __package__.yml
10
16
  service:
@@ -96,6 +102,49 @@ service:
96
102
  last_deployed_history_item_id: last_deployed_history_item_id
97
103
  audiences:
98
104
  - customers
105
+ list_deployment_release_tags:
106
+ path: /v1/deployments/{id}/release-tags
107
+ method: GET
108
+ auth: true
109
+ docs: List Release Tags associated with the specified Prompt Deployment
110
+ path-parameters:
111
+ id:
112
+ type: string
113
+ docs: Either the Prompt Deployment's ID or its unique name
114
+ request:
115
+ name: ListDeploymentReleaseTagsRequest
116
+ query-parameters:
117
+ limit:
118
+ type: optional<integer>
119
+ docs: Number of results to return per page.
120
+ offset:
121
+ type: optional<integer>
122
+ docs: The initial index from which to return the results.
123
+ ordering:
124
+ type: optional<string>
125
+ docs: Which field to use when ordering the results.
126
+ source: optional<ListDeploymentReleaseTagsRequestSource>
127
+ response:
128
+ docs: ''
129
+ type: root.PaginatedDeploymentReleaseTagReadList
130
+ url: Default
131
+ availability: pre-release
132
+ examples:
133
+ - path-parameters:
134
+ id: id
135
+ response:
136
+ body:
137
+ count: 123
138
+ next: http://api.example.org/accounts/?offset=400&limit=100
139
+ previous: http://api.example.org/accounts/?offset=200&limit=100
140
+ results:
141
+ - name: name
142
+ source: SYSTEM
143
+ history_item:
144
+ id: id
145
+ timestamp: '2024-01-15T09:30:00Z'
146
+ audiences:
147
+ - customers
99
148
  retrieve_deployment_release_tag:
100
149
  path: /v1/deployments/{id}/release-tags/{name}
101
150
  method: GET
@@ -135,7 +184,7 @@ service:
135
184
  method: PATCH
136
185
  auth: true
137
186
  docs: >-
138
- Updates an existing Release Tag associated with the specified
187
+ Updates an existing Release Tag associated with the specified Prompt
139
188
  Deployment.
140
189
  path-parameters:
141
190
  id:
@@ -5,6 +5,12 @@ types:
5
5
  - ARCHIVED
6
6
  source:
7
7
  openapi: openapi/openapi.yml
8
+ ListWorkflowReleaseTagsRequestSource:
9
+ enum:
10
+ - SYSTEM
11
+ - USER
12
+ source:
13
+ openapi: openapi/openapi.yml
8
14
  imports:
9
15
  root: __package__.yml
10
16
  service:
@@ -105,6 +111,49 @@ service:
105
111
  description: description
106
112
  audiences:
107
113
  - customers
114
+ list_workflow_release_tags:
115
+ path: /v1/workflow-deployments/{id}/release-tags
116
+ method: GET
117
+ auth: true
118
+ docs: List Release Tags associated with the specified Workflow Deployment
119
+ path-parameters:
120
+ id:
121
+ type: string
122
+ docs: Either the Workflow Deployment's ID or its unique name
123
+ request:
124
+ name: ListWorkflowReleaseTagsRequest
125
+ query-parameters:
126
+ limit:
127
+ type: optional<integer>
128
+ docs: Number of results to return per page.
129
+ offset:
130
+ type: optional<integer>
131
+ docs: The initial index from which to return the results.
132
+ ordering:
133
+ type: optional<string>
134
+ docs: Which field to use when ordering the results.
135
+ source: optional<ListWorkflowReleaseTagsRequestSource>
136
+ response:
137
+ docs: ''
138
+ type: root.PaginatedWorkflowReleaseTagReadList
139
+ url: Default
140
+ availability: pre-release
141
+ examples:
142
+ - path-parameters:
143
+ id: id
144
+ response:
145
+ body:
146
+ count: 123
147
+ next: http://api.example.org/accounts/?offset=400&limit=100
148
+ previous: http://api.example.org/accounts/?offset=200&limit=100
149
+ results:
150
+ - name: name
151
+ source: SYSTEM
152
+ history_item:
153
+ id: id
154
+ timestamp: '2024-01-15T09:30:00Z'
155
+ audiences:
156
+ - customers
108
157
  retrieve_workflow_release_tag:
109
158
  path: /v1/workflow-deployments/{id}/release-tags/{name}
110
159
  method: GET
@@ -1,3 +1,12 @@
1
+ types:
2
+ WorkflowsPullRequestFormat:
3
+ enum:
4
+ - json
5
+ - zip
6
+ source:
7
+ openapi: openapi/openapi.yml
8
+ imports:
9
+ root: __package__.yml
1
10
  service:
2
11
  auth: false
3
12
  base-path: ''
@@ -13,11 +22,17 @@ service:
13
22
  id:
14
23
  type: string
15
24
  docs: The ID of the Workflow to pull from
25
+ request:
26
+ name: WorkflowsPullRequest
27
+ query-parameters:
28
+ format: optional<WorkflowsPullRequestFormat>
16
29
  response:
17
30
  docs: ''
18
31
  type: file
19
32
  url: Default
20
33
  availability: pre-release
34
+ errors:
35
+ - root.BadRequestError
21
36
  audiences:
22
37
  - internal
23
38
  push:
@@ -40,6 +55,7 @@ service:
40
55
  type: optional<string>
41
56
  validation:
42
57
  format: uuid
58
+ deployment_config: optional<root.WorkflowPushDeploymentConfigRequest>
43
59
  response:
44
60
  docs: ''
45
61
  type: root.WorkflowPushResponse
@@ -53,9 +69,8 @@ service:
53
69
  response:
54
70
  body:
55
71
  workflow_sandbox_id: workflow_sandbox_id
72
+ workflow_deployment_id: workflow_deployment_id
56
73
  audiences:
57
74
  - internal
58
75
  source:
59
76
  openapi: openapi/openapi.yml
60
- imports:
61
- root: __package__.yml
@@ -260,6 +260,56 @@ paths:
260
260
  x-fern-availability: beta
261
261
  x-fern-audiences:
262
262
  - customers
263
+ /v1/deployments/{id}/release-tags:
264
+ get:
265
+ operationId: list_deployment_release_tags
266
+ description: List Release Tags associated with the specified Prompt Deployment
267
+ parameters:
268
+ - in: path
269
+ name: id
270
+ schema:
271
+ type: string
272
+ description: Either the Prompt Deployment's ID or its unique name
273
+ required: true
274
+ - name: limit
275
+ required: false
276
+ in: query
277
+ description: Number of results to return per page.
278
+ schema:
279
+ type: integer
280
+ - name: offset
281
+ required: false
282
+ in: query
283
+ description: The initial index from which to return the results.
284
+ schema:
285
+ type: integer
286
+ - name: ordering
287
+ required: false
288
+ in: query
289
+ description: Which field to use when ordering the results.
290
+ schema:
291
+ type: string
292
+ - in: query
293
+ name: source
294
+ schema:
295
+ type: string
296
+ enum:
297
+ - SYSTEM
298
+ - USER
299
+ tags:
300
+ - deployments
301
+ security:
302
+ - apiKeyAuth: []
303
+ responses:
304
+ '200':
305
+ content:
306
+ application/json:
307
+ schema:
308
+ $ref: '#/components/schemas/PaginatedDeploymentReleaseTagReadList'
309
+ description: ''
310
+ x-fern-availability: beta
311
+ x-fern-audiences:
312
+ - customers
263
313
  /v1/deployments/{id}/release-tags/{name}:
264
314
  get:
265
315
  operationId: retrieve_deployment_release_tag
@@ -296,7 +346,8 @@ paths:
296
346
  - customers
297
347
  patch:
298
348
  operationId: update_deployment_release_tag
299
- description: Updates an existing Release Tag associated with the specified Deployment.
349
+ description: Updates an existing Release Tag associated with the specified Prompt
350
+ Deployment.
300
351
  parameters:
301
352
  - in: path
302
353
  name: id
@@ -1924,6 +1975,56 @@ paths:
1924
1975
  x-fern-availability: beta
1925
1976
  x-fern-audiences:
1926
1977
  - customers
1978
+ /v1/workflow-deployments/{id}/release-tags:
1979
+ get:
1980
+ operationId: list_workflow_release_tags
1981
+ description: List Release Tags associated with the specified Workflow Deployment
1982
+ parameters:
1983
+ - in: path
1984
+ name: id
1985
+ schema:
1986
+ type: string
1987
+ description: Either the Workflow Deployment's ID or its unique name
1988
+ required: true
1989
+ - name: limit
1990
+ required: false
1991
+ in: query
1992
+ description: Number of results to return per page.
1993
+ schema:
1994
+ type: integer
1995
+ - name: offset
1996
+ required: false
1997
+ in: query
1998
+ description: The initial index from which to return the results.
1999
+ schema:
2000
+ type: integer
2001
+ - name: ordering
2002
+ required: false
2003
+ in: query
2004
+ description: Which field to use when ordering the results.
2005
+ schema:
2006
+ type: string
2007
+ - in: query
2008
+ name: source
2009
+ schema:
2010
+ type: string
2011
+ enum:
2012
+ - SYSTEM
2013
+ - USER
2014
+ tags:
2015
+ - workflow-deployments
2016
+ security:
2017
+ - apiKeyAuth: []
2018
+ responses:
2019
+ '200':
2020
+ content:
2021
+ application/json:
2022
+ schema:
2023
+ $ref: '#/components/schemas/PaginatedWorkflowReleaseTagReadList'
2024
+ description: ''
2025
+ x-fern-availability: beta
2026
+ x-fern-audiences:
2027
+ - customers
1927
2028
  /v1/workflow-deployments/{id}/release-tags/{name}:
1928
2029
  get:
1929
2030
  operationId: retrieve_workflow_release_tag
@@ -2041,6 +2142,13 @@ paths:
2041
2142
  description: An internal-only endpoint that's subject to breaking changes without
2042
2143
  notice. Not intended for public use.
2043
2144
  parameters:
2145
+ - in: query
2146
+ name: format
2147
+ schema:
2148
+ type: string
2149
+ enum:
2150
+ - json
2151
+ - zip
2044
2152
  - in: path
2045
2153
  name: id
2046
2154
  schema:
@@ -2059,6 +2167,13 @@ paths:
2059
2167
  type: string
2060
2168
  format: binary
2061
2169
  description: ''
2170
+ '400':
2171
+ content:
2172
+ application/json:
2173
+ schema:
2174
+ type: object
2175
+ additionalProperties: {}
2176
+ description: ''
2062
2177
  x-fern-availability: beta
2063
2178
  x-fern-audiences:
2064
2179
  - internal
@@ -2403,6 +2518,7 @@ components:
2403
2518
  - $ref: '#/components/schemas/ErrorVariableValue'
2404
2519
  - $ref: '#/components/schemas/FunctionCallVariableValue'
2405
2520
  - $ref: '#/components/schemas/ImageVariableValue'
2521
+ - $ref: '#/components/schemas/AudioVariableValue'
2406
2522
  - $ref: '#/components/schemas/ChatHistoryVariableValue'
2407
2523
  - $ref: '#/components/schemas/SearchResultsVariableValue'
2408
2524
  - $ref: '#/components/schemas/ArrayVariableValue'
@@ -2415,6 +2531,7 @@ components:
2415
2531
  ERROR: '#/components/schemas/ErrorVariableValue'
2416
2532
  FUNCTION_CALL: '#/components/schemas/FunctionCallVariableValue'
2417
2533
  IMAGE: '#/components/schemas/ImageVariableValue'
2534
+ AUDIO: '#/components/schemas/AudioVariableValue'
2418
2535
  CHAT_HISTORY: '#/components/schemas/ChatHistoryVariableValue'
2419
2536
  SEARCH_RESULTS: '#/components/schemas/SearchResultsVariableValue'
2420
2537
  ARRAY: '#/components/schemas/ArrayVariableValue'
@@ -2472,6 +2589,45 @@ components:
2472
2589
  type: string
2473
2590
  enum:
2474
2591
  - AUDIO
2592
+ AudioVariableValue:
2593
+ type: object
2594
+ description: A base Vellum primitive value representing audio.
2595
+ properties:
2596
+ type:
2597
+ $ref: '#/components/schemas/AudioEnum'
2598
+ value:
2599
+ allOf:
2600
+ - $ref: '#/components/schemas/VellumAudio'
2601
+ nullable: true
2602
+ required:
2603
+ - type
2604
+ - value
2605
+ AudioVellumValue:
2606
+ type: object
2607
+ description: A base Vellum primitive value representing audio.
2608
+ properties:
2609
+ type:
2610
+ $ref: '#/components/schemas/AudioEnum'
2611
+ value:
2612
+ allOf:
2613
+ - $ref: '#/components/schemas/VellumAudio'
2614
+ nullable: true
2615
+ required:
2616
+ - type
2617
+ - value
2618
+ AudioVellumValueRequest:
2619
+ type: object
2620
+ description: A base Vellum primitive value representing audio.
2621
+ properties:
2622
+ type:
2623
+ $ref: '#/components/schemas/AudioEnum'
2624
+ value:
2625
+ allOf:
2626
+ - $ref: '#/components/schemas/VellumAudioRequest'
2627
+ nullable: true
2628
+ required:
2629
+ - type
2630
+ - value
2475
2631
  BasicVectorizerIntfloatMultilingualE5Large:
2476
2632
  type: object
2477
2633
  description: Basic vectorizer for intfloat/multilingual-e5-large.
@@ -6643,6 +6799,26 @@ components:
6643
6799
  type: array
6644
6800
  items:
6645
6801
  $ref: '#/components/schemas/ContainerImageRead'
6802
+ PaginatedDeploymentReleaseTagReadList:
6803
+ type: object
6804
+ properties:
6805
+ count:
6806
+ type: integer
6807
+ example: 123
6808
+ next:
6809
+ type: string
6810
+ nullable: true
6811
+ format: uri
6812
+ example: http://api.example.org/accounts/?offset=400&limit=100
6813
+ previous:
6814
+ type: string
6815
+ nullable: true
6816
+ format: uri
6817
+ example: http://api.example.org/accounts/?offset=200&limit=100
6818
+ results:
6819
+ type: array
6820
+ items:
6821
+ $ref: '#/components/schemas/DeploymentReleaseTagRead'
6646
6822
  PaginatedDocumentIndexReadList:
6647
6823
  type: object
6648
6824
  properties:
@@ -6793,6 +6969,26 @@ components:
6793
6969
  - next
6794
6970
  - previous
6795
6971
  - results
6972
+ PaginatedWorkflowReleaseTagReadList:
6973
+ type: object
6974
+ properties:
6975
+ count:
6976
+ type: integer
6977
+ example: 123
6978
+ next:
6979
+ type: string
6980
+ nullable: true
6981
+ format: uri
6982
+ example: http://api.example.org/accounts/?offset=400&limit=100
6983
+ previous:
6984
+ type: string
6985
+ nullable: true
6986
+ format: uri
6987
+ example: http://api.example.org/accounts/?offset=200&limit=100
6988
+ results:
6989
+ type: array
6990
+ items:
6991
+ $ref: '#/components/schemas/WorkflowReleaseTagRead'
6796
6992
  PatchedDeploymentReleaseTagUpdateRequest:
6797
6993
  type: object
6798
6994
  properties:
@@ -10107,6 +10303,7 @@ components:
10107
10303
  properties:
10108
10304
  src:
10109
10305
  type: string
10306
+ description: A valid data URL containing the audio data.
10110
10307
  metadata:
10111
10308
  type: object
10112
10309
  additionalProperties: {}
@@ -10119,6 +10316,7 @@ components:
10119
10316
  src:
10120
10317
  type: string
10121
10318
  minLength: 1
10319
+ description: A valid data URL containing the audio data.
10122
10320
  metadata:
10123
10321
  type: object
10124
10322
  additionalProperties: {}
@@ -10189,6 +10387,7 @@ components:
10189
10387
  - $ref: '#/components/schemas/NumberVellumValue'
10190
10388
  - $ref: '#/components/schemas/JsonVellumValue'
10191
10389
  - $ref: '#/components/schemas/ImageVellumValue'
10390
+ - $ref: '#/components/schemas/AudioVellumValue'
10192
10391
  - $ref: '#/components/schemas/FunctionCallVellumValue'
10193
10392
  - $ref: '#/components/schemas/ErrorVellumValue'
10194
10393
  - $ref: '#/components/schemas/ArrayVellumValue'
@@ -10201,6 +10400,7 @@ components:
10201
10400
  NUMBER: '#/components/schemas/NumberVellumValue'
10202
10401
  JSON: '#/components/schemas/JsonVellumValue'
10203
10402
  IMAGE: '#/components/schemas/ImageVellumValue'
10403
+ AUDIO: '#/components/schemas/AudioVellumValue'
10204
10404
  FUNCTION_CALL: '#/components/schemas/FunctionCallVellumValue'
10205
10405
  ERROR: '#/components/schemas/ErrorVellumValue'
10206
10406
  ARRAY: '#/components/schemas/ArrayVellumValue'
@@ -10258,6 +10458,7 @@ components:
10258
10458
  - $ref: '#/components/schemas/NumberVellumValueRequest'
10259
10459
  - $ref: '#/components/schemas/JsonVellumValueRequest'
10260
10460
  - $ref: '#/components/schemas/ImageVellumValueRequest'
10461
+ - $ref: '#/components/schemas/AudioVellumValueRequest'
10261
10462
  - $ref: '#/components/schemas/FunctionCallVellumValueRequest'
10262
10463
  - $ref: '#/components/schemas/ErrorVellumValueRequest'
10263
10464
  - $ref: '#/components/schemas/ArrayVellumValueRequest'
@@ -10270,6 +10471,7 @@ components:
10270
10471
  NUMBER: '#/components/schemas/NumberVellumValueRequest'
10271
10472
  JSON: '#/components/schemas/JsonVellumValueRequest'
10272
10473
  IMAGE: '#/components/schemas/ImageVellumValueRequest'
10474
+ AUDIO: '#/components/schemas/AudioVellumValueRequest'
10273
10475
  FUNCTION_CALL: '#/components/schemas/FunctionCallVellumValueRequest'
10274
10476
  ERROR: '#/components/schemas/ErrorVellumValueRequest'
10275
10477
  ARRAY: '#/components/schemas/ArrayVellumValueRequest'
@@ -10921,6 +11123,27 @@ components:
10921
11123
  - name
10922
11124
  - type
10923
11125
  - value
11126
+ WorkflowPushDeploymentConfigRequest:
11127
+ type: object
11128
+ properties:
11129
+ label:
11130
+ type: string
11131
+ nullable: true
11132
+ minLength: 1
11133
+ name:
11134
+ type: string
11135
+ nullable: true
11136
+ minLength: 1
11137
+ description:
11138
+ type: string
11139
+ nullable: true
11140
+ minLength: 1
11141
+ release_tags:
11142
+ type: array
11143
+ items:
11144
+ type: string
11145
+ minLength: 1
11146
+ nullable: true
10924
11147
  WorkflowPushExecConfig:
10925
11148
  type: object
10926
11149
  additionalProperties: {}
@@ -10936,6 +11159,10 @@ components:
10936
11159
  type: string
10937
11160
  format: uuid
10938
11161
  nullable: true
11162
+ deployment_config:
11163
+ allOf:
11164
+ - $ref: '#/components/schemas/WorkflowPushDeploymentConfigRequest'
11165
+ nullable: true
10939
11166
  required:
10940
11167
  - exec_config
10941
11168
  - label
@@ -10945,6 +11172,10 @@ components:
10945
11172
  workflow_sandbox_id:
10946
11173
  type: string
10947
11174
  format: uuid
11175
+ workflow_deployment_id:
11176
+ type: string
11177
+ format: uuid
11178
+ nullable: true
10948
11179
  required:
10949
11180
  - workflow_sandbox_id
10950
11181
  WorkflowReleaseTagRead: