vellum-ai 0.9.4 → 0.9.6

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 (185) hide show
  1. package/.mock/definition/__package__.yml +37 -29
  2. package/.mock/definition/deployments.yml +50 -1
  3. package/.mock/definition/workflowDeployments.yml +49 -0
  4. package/.mock/definition/workflows.yml +15 -2
  5. package/.mock/openapi/openapi.yml +174 -39
  6. package/Client.js +10 -10
  7. package/api/resources/adHoc/client/Client.js +1 -1
  8. package/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +5 -6
  9. package/api/resources/containerImages/client/Client.js +4 -4
  10. package/api/resources/deployments/client/Client.d.ts +12 -1
  11. package/api/resources/deployments/client/Client.js +74 -6
  12. package/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.d.ts +23 -0
  13. package/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.js +5 -0
  14. package/api/resources/deployments/client/requests/index.d.ts +1 -0
  15. package/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +8 -0
  16. package/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +10 -0
  17. package/api/resources/deployments/types/index.d.ts +1 -0
  18. package/api/resources/deployments/types/index.js +1 -0
  19. package/api/resources/documentIndexes/client/Client.js +8 -8
  20. package/api/resources/documents/client/Client.js +5 -5
  21. package/api/resources/folderEntities/client/Client.js +2 -2
  22. package/api/resources/index.d.ts +2 -1
  23. package/api/resources/index.js +3 -2
  24. package/api/resources/metricDefinitions/client/Client.js +1 -1
  25. package/api/resources/sandboxes/client/Client.js +3 -3
  26. package/api/resources/testSuiteRuns/client/Client.js +3 -3
  27. package/api/resources/testSuites/client/Client.js +4 -4
  28. package/api/resources/workflowDeployments/client/Client.d.ts +11 -0
  29. package/api/resources/workflowDeployments/client/Client.js +72 -4
  30. package/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.d.ts +23 -0
  31. package/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.js +5 -0
  32. package/api/resources/workflowDeployments/client/requests/index.d.ts +1 -0
  33. package/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +8 -0
  34. package/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +10 -0
  35. package/api/resources/workflowDeployments/types/index.d.ts +1 -0
  36. package/api/resources/workflowDeployments/types/index.js +1 -0
  37. package/api/resources/workflowSandboxes/client/Client.js +1 -1
  38. package/api/resources/workflows/client/Client.d.ts +3 -2
  39. package/api/resources/workflows/client/Client.js +20 -7
  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/ChatMessagePromptBlockRequest.d.ts +2 -3
  51. package/api/types/FunctionDefinitionPromptBlockRequest.d.ts +2 -3
  52. package/api/types/JinjaPromptBlockRequest.d.ts +2 -3
  53. package/api/types/PaginatedDeploymentReleaseTagReadList.d.ts +10 -0
  54. package/api/types/PaginatedDeploymentReleaseTagReadList.js +5 -0
  55. package/api/types/PaginatedWorkflowReleaseTagReadList.d.ts +10 -0
  56. package/api/types/PaginatedWorkflowReleaseTagReadList.js +5 -0
  57. package/api/types/PlainTextPromptBlockRequest.d.ts +2 -3
  58. package/api/types/VariablePromptBlockRequest.d.ts +1 -2
  59. package/api/types/index.d.ts +2 -0
  60. package/api/types/index.js +2 -0
  61. package/dist/Client.js +10 -10
  62. package/dist/api/resources/adHoc/client/Client.js +1 -1
  63. package/dist/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +5 -6
  64. package/dist/api/resources/containerImages/client/Client.js +4 -4
  65. package/dist/api/resources/deployments/client/Client.d.ts +12 -1
  66. package/dist/api/resources/deployments/client/Client.js +74 -6
  67. package/dist/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.d.ts +23 -0
  68. package/dist/api/resources/deployments/client/requests/ListDeploymentReleaseTagsRequest.js +5 -0
  69. package/dist/api/resources/deployments/client/requests/index.d.ts +1 -0
  70. package/dist/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +8 -0
  71. package/dist/api/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +10 -0
  72. package/dist/api/resources/deployments/types/index.d.ts +1 -0
  73. package/dist/api/resources/deployments/types/index.js +1 -0
  74. package/dist/api/resources/documentIndexes/client/Client.js +8 -8
  75. package/dist/api/resources/documents/client/Client.js +5 -5
  76. package/dist/api/resources/folderEntities/client/Client.js +2 -2
  77. package/dist/api/resources/index.d.ts +2 -1
  78. package/dist/api/resources/index.js +3 -2
  79. package/dist/api/resources/metricDefinitions/client/Client.js +1 -1
  80. package/dist/api/resources/sandboxes/client/Client.js +3 -3
  81. package/dist/api/resources/testSuiteRuns/client/Client.js +3 -3
  82. package/dist/api/resources/testSuites/client/Client.js +4 -4
  83. package/dist/api/resources/workflowDeployments/client/Client.d.ts +11 -0
  84. package/dist/api/resources/workflowDeployments/client/Client.js +72 -4
  85. package/dist/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.d.ts +23 -0
  86. package/dist/api/resources/workflowDeployments/client/requests/ListWorkflowReleaseTagsRequest.js +5 -0
  87. package/dist/api/resources/workflowDeployments/client/requests/index.d.ts +1 -0
  88. package/dist/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +8 -0
  89. package/dist/api/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +10 -0
  90. package/dist/api/resources/workflowDeployments/types/index.d.ts +1 -0
  91. package/dist/api/resources/workflowDeployments/types/index.js +1 -0
  92. package/dist/api/resources/workflowSandboxes/client/Client.js +1 -1
  93. package/dist/api/resources/workflows/client/Client.d.ts +3 -2
  94. package/dist/api/resources/workflows/client/Client.js +20 -7
  95. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.d.ts +13 -0
  96. package/dist/api/resources/workflows/client/requests/WorkflowsPullRequest.js +5 -0
  97. package/dist/api/resources/workflows/client/requests/index.d.ts +1 -0
  98. package/dist/api/resources/workflows/index.d.ts +1 -0
  99. package/dist/api/resources/workflows/index.js +1 -0
  100. package/dist/api/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +8 -0
  101. package/dist/api/resources/workflows/types/WorkflowsPullRequestFormat.js +10 -0
  102. package/dist/api/resources/workflows/types/index.d.ts +1 -0
  103. package/dist/api/resources/workflows/types/index.js +17 -0
  104. package/dist/api/resources/workspaceSecrets/client/Client.js +2 -2
  105. package/dist/api/types/ChatMessagePromptBlockRequest.d.ts +2 -3
  106. package/dist/api/types/FunctionDefinitionPromptBlockRequest.d.ts +2 -3
  107. package/dist/api/types/JinjaPromptBlockRequest.d.ts +2 -3
  108. package/dist/api/types/PaginatedDeploymentReleaseTagReadList.d.ts +10 -0
  109. package/dist/api/types/PaginatedDeploymentReleaseTagReadList.js +5 -0
  110. package/dist/api/types/PaginatedWorkflowReleaseTagReadList.d.ts +10 -0
  111. package/dist/api/types/PaginatedWorkflowReleaseTagReadList.js +5 -0
  112. package/dist/api/types/PlainTextPromptBlockRequest.d.ts +2 -3
  113. package/dist/api/types/VariablePromptBlockRequest.d.ts +1 -2
  114. package/dist/api/types/index.d.ts +2 -0
  115. package/dist/api/types/index.js +2 -0
  116. package/dist/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +10 -0
  117. package/dist/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +31 -0
  118. package/dist/serialization/resources/deployments/types/index.d.ts +1 -0
  119. package/dist/serialization/resources/deployments/types/index.js +1 -0
  120. package/dist/serialization/resources/index.d.ts +2 -1
  121. package/dist/serialization/resources/index.js +3 -2
  122. package/dist/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +10 -0
  123. package/dist/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +31 -0
  124. package/dist/serialization/resources/workflowDeployments/types/index.d.ts +1 -0
  125. package/dist/serialization/resources/workflowDeployments/types/index.js +1 -0
  126. package/dist/serialization/resources/workflows/index.d.ts +1 -0
  127. package/dist/serialization/resources/workflows/index.js +1 -0
  128. package/dist/serialization/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +10 -0
  129. package/dist/serialization/resources/workflows/types/WorkflowsPullRequestFormat.js +31 -0
  130. package/dist/serialization/resources/workflows/types/index.d.ts +1 -0
  131. package/dist/serialization/resources/workflows/types/index.js +17 -0
  132. package/dist/serialization/types/ChatMessagePromptBlockRequest.d.ts +2 -3
  133. package/dist/serialization/types/ChatMessagePromptBlockRequest.js +2 -3
  134. package/dist/serialization/types/FunctionDefinitionPromptBlockRequest.d.ts +3 -4
  135. package/dist/serialization/types/FunctionDefinitionPromptBlockRequest.js +3 -4
  136. package/dist/serialization/types/JinjaPromptBlockRequest.d.ts +3 -4
  137. package/dist/serialization/types/JinjaPromptBlockRequest.js +3 -4
  138. package/dist/serialization/types/PaginatedDeploymentReleaseTagReadList.d.ts +16 -0
  139. package/dist/serialization/types/PaginatedDeploymentReleaseTagReadList.js +37 -0
  140. package/dist/serialization/types/PaginatedWorkflowReleaseTagReadList.d.ts +16 -0
  141. package/dist/serialization/types/PaginatedWorkflowReleaseTagReadList.js +37 -0
  142. package/dist/serialization/types/PlainTextPromptBlockRequest.d.ts +2 -3
  143. package/dist/serialization/types/PlainTextPromptBlockRequest.js +2 -3
  144. package/dist/serialization/types/VariablePromptBlockRequest.d.ts +1 -2
  145. package/dist/serialization/types/VariablePromptBlockRequest.js +1 -2
  146. package/dist/serialization/types/index.d.ts +2 -0
  147. package/dist/serialization/types/index.js +2 -0
  148. package/dist/version.d.ts +1 -1
  149. package/dist/version.js +1 -1
  150. package/package.json +1 -1
  151. package/reference.md +160 -9
  152. package/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.d.ts +10 -0
  153. package/serialization/resources/deployments/types/ListDeploymentReleaseTagsRequestSource.js +31 -0
  154. package/serialization/resources/deployments/types/index.d.ts +1 -0
  155. package/serialization/resources/deployments/types/index.js +1 -0
  156. package/serialization/resources/index.d.ts +2 -1
  157. package/serialization/resources/index.js +3 -2
  158. package/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.d.ts +10 -0
  159. package/serialization/resources/workflowDeployments/types/ListWorkflowReleaseTagsRequestSource.js +31 -0
  160. package/serialization/resources/workflowDeployments/types/index.d.ts +1 -0
  161. package/serialization/resources/workflowDeployments/types/index.js +1 -0
  162. package/serialization/resources/workflows/index.d.ts +1 -0
  163. package/serialization/resources/workflows/index.js +1 -0
  164. package/serialization/resources/workflows/types/WorkflowsPullRequestFormat.d.ts +10 -0
  165. package/serialization/resources/workflows/types/WorkflowsPullRequestFormat.js +31 -0
  166. package/serialization/resources/workflows/types/index.d.ts +1 -0
  167. package/serialization/resources/workflows/types/index.js +17 -0
  168. package/serialization/types/ChatMessagePromptBlockRequest.d.ts +2 -3
  169. package/serialization/types/ChatMessagePromptBlockRequest.js +2 -3
  170. package/serialization/types/FunctionDefinitionPromptBlockRequest.d.ts +3 -4
  171. package/serialization/types/FunctionDefinitionPromptBlockRequest.js +3 -4
  172. package/serialization/types/JinjaPromptBlockRequest.d.ts +3 -4
  173. package/serialization/types/JinjaPromptBlockRequest.js +3 -4
  174. package/serialization/types/PaginatedDeploymentReleaseTagReadList.d.ts +16 -0
  175. package/serialization/types/PaginatedDeploymentReleaseTagReadList.js +37 -0
  176. package/serialization/types/PaginatedWorkflowReleaseTagReadList.d.ts +16 -0
  177. package/serialization/types/PaginatedWorkflowReleaseTagReadList.js +37 -0
  178. package/serialization/types/PlainTextPromptBlockRequest.d.ts +2 -3
  179. package/serialization/types/PlainTextPromptBlockRequest.js +2 -3
  180. package/serialization/types/VariablePromptBlockRequest.d.ts +1 -2
  181. package/serialization/types/VariablePromptBlockRequest.js +1 -2
  182. package/serialization/types/index.d.ts +2 -0
  183. package/serialization/types/index.js +2 -0
  184. package/version.d.ts +1 -1
  185. package/version.js +1 -1
@@ -1003,14 +1003,10 @@ types:
1003
1003
  ChatMessagePromptBlockRequest:
1004
1004
  docs: A block that represents a chat message in a prompt template.
1005
1005
  properties:
1006
- block_type: literal<"CHAT_MESSAGE">
1007
- properties: ChatMessagePromptBlockPropertiesRequest
1008
- id:
1009
- type: string
1010
- validation:
1011
- minLength: 1
1012
1006
  state: optional<PromptBlockState>
1013
1007
  cache_config: optional<EphemeralPromptCacheConfigRequest>
1008
+ block_type: literal<"CHAT_MESSAGE">
1009
+ properties: ChatMessagePromptBlockPropertiesRequest
1014
1010
  source:
1015
1011
  openapi: openapi/openapi.yml
1016
1012
  ChatMessageRequest:
@@ -2148,14 +2144,10 @@ types:
2148
2144
  FunctionDefinitionPromptBlockRequest:
2149
2145
  docs: A block that represents a function definition in a prompt template.
2150
2146
  properties:
2151
- block_type: literal<"FUNCTION_DEFINITION">
2152
- properties: FunctionDefinitionPromptBlockPropertiesRequest
2153
- id:
2154
- type: string
2155
- validation:
2156
- minLength: 1
2157
2147
  state: optional<PromptBlockState>
2158
2148
  cache_config: optional<EphemeralPromptCacheConfigRequest>
2149
+ block_type: literal<"FUNCTION_DEFINITION">
2150
+ properties: FunctionDefinitionPromptBlockPropertiesRequest
2159
2151
  source:
2160
2152
  openapi: openapi/openapi.yml
2161
2153
  GenerateErrorResponse:
@@ -2486,14 +2478,10 @@ types:
2486
2478
  JinjaPromptBlockRequest:
2487
2479
  docs: A block of Jinja template code that is used to generate a prompt
2488
2480
  properties:
2489
- block_type: literal<"JINJA">
2490
- properties: JinjaPromptBlockPropertiesRequest
2491
- id:
2492
- type: string
2493
- validation:
2494
- minLength: 1
2495
2481
  state: optional<PromptBlockState>
2496
2482
  cache_config: optional<EphemeralPromptCacheConfigRequest>
2483
+ block_type: literal<"JINJA">
2484
+ properties: JinjaPromptBlockPropertiesRequest
2497
2485
  source:
2498
2486
  openapi: openapi/openapi.yml
2499
2487
  JsonEnum: literal<"JSON">
@@ -3215,6 +3203,20 @@ types:
3215
3203
  results: optional<list<ContainerImageRead>>
3216
3204
  source:
3217
3205
  openapi: openapi/openapi.yml
3206
+ PaginatedDeploymentReleaseTagReadList:
3207
+ properties:
3208
+ count: optional<integer>
3209
+ next:
3210
+ type: optional<string>
3211
+ validation:
3212
+ format: uri
3213
+ previous:
3214
+ type: optional<string>
3215
+ validation:
3216
+ format: uri
3217
+ results: optional<list<DeploymentReleaseTagRead>>
3218
+ source:
3219
+ openapi: openapi/openapi.yml
3218
3220
  PaginatedDocumentIndexReadList:
3219
3221
  properties:
3220
3222
  count: optional<integer>
@@ -3313,6 +3315,20 @@ types:
3313
3315
  results: list<TestSuiteTestCase>
3314
3316
  source:
3315
3317
  openapi: openapi/openapi.yml
3318
+ PaginatedWorkflowReleaseTagReadList:
3319
+ properties:
3320
+ count: optional<integer>
3321
+ next:
3322
+ type: optional<string>
3323
+ validation:
3324
+ format: uri
3325
+ previous:
3326
+ type: optional<string>
3327
+ validation:
3328
+ format: uri
3329
+ results: optional<list<WorkflowReleaseTagRead>>
3330
+ source:
3331
+ openapi: openapi/openapi.yml
3316
3332
  PdfEnum: literal<"PDF">
3317
3333
  PdfSearchResultMetaSource:
3318
3334
  docs: The source of a search result from a PDF document.
@@ -3350,14 +3366,10 @@ types:
3350
3366
  PlainTextPromptBlockRequest:
3351
3367
  docs: A block that holds a plain text string value.
3352
3368
  properties:
3353
- block_type: literal<"PLAIN_TEXT">
3354
- text: string
3355
- id:
3356
- type: string
3357
- validation:
3358
- minLength: 1
3359
3369
  state: optional<PromptBlockState>
3360
3370
  cache_config: optional<EphemeralPromptCacheConfigRequest>
3371
+ block_type: literal<"PLAIN_TEXT">
3372
+ text: string
3361
3373
  source:
3362
3374
  openapi: openapi/openapi.yml
3363
3375
  Price:
@@ -5404,13 +5416,9 @@ types:
5404
5416
  VariablePromptBlockRequest:
5405
5417
  docs: A block that represents a variable in a prompt template.
5406
5418
  properties:
5407
- block_type: literal<"VARIABLE">
5408
- id:
5409
- type: string
5410
- validation:
5411
- minLength: 1
5412
5419
  state: optional<PromptBlockState>
5413
5420
  cache_config: optional<EphemeralPromptCacheConfigRequest>
5421
+ block_type: literal<"VARIABLE">
5414
5422
  input_variable_id:
5415
5423
  type: string
5416
5424
  validation:
@@ -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:
@@ -59,5 +74,3 @@ service:
59
74
  - internal
60
75
  source:
61
76
  openapi: openapi/openapi.yml
62
- imports:
63
- 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
@@ -2725,22 +2840,18 @@ components:
2725
2840
  type: object
2726
2841
  description: A block that represents a chat message in a prompt template.
2727
2842
  properties:
2728
- block_type:
2729
- $ref: '#/components/schemas/ChatMessageEnum'
2730
- properties:
2731
- $ref: '#/components/schemas/ChatMessagePromptBlockPropertiesRequest'
2732
- id:
2733
- type: string
2734
- minLength: 1
2735
2843
  state:
2736
2844
  $ref: '#/components/schemas/PromptBlockState'
2737
2845
  cache_config:
2738
2846
  allOf:
2739
2847
  - $ref: '#/components/schemas/EphemeralPromptCacheConfigRequest'
2740
2848
  nullable: true
2849
+ block_type:
2850
+ $ref: '#/components/schemas/ChatMessageEnum'
2851
+ properties:
2852
+ $ref: '#/components/schemas/ChatMessagePromptBlockPropertiesRequest'
2741
2853
  required:
2742
2854
  - block_type
2743
- - id
2744
2855
  - properties
2745
2856
  ChatMessageRequest:
2746
2857
  type: object
@@ -4897,22 +5008,18 @@ components:
4897
5008
  type: object
4898
5009
  description: A block that represents a function definition in a prompt template.
4899
5010
  properties:
4900
- block_type:
4901
- $ref: '#/components/schemas/FunctionDefinitionEnum'
4902
- properties:
4903
- $ref: '#/components/schemas/FunctionDefinitionPromptBlockPropertiesRequest'
4904
- id:
4905
- type: string
4906
- minLength: 1
4907
5011
  state:
4908
5012
  $ref: '#/components/schemas/PromptBlockState'
4909
5013
  cache_config:
4910
5014
  allOf:
4911
5015
  - $ref: '#/components/schemas/EphemeralPromptCacheConfigRequest'
4912
5016
  nullable: true
5017
+ block_type:
5018
+ $ref: '#/components/schemas/FunctionDefinitionEnum'
5019
+ properties:
5020
+ $ref: '#/components/schemas/FunctionDefinitionPromptBlockPropertiesRequest'
4913
5021
  required:
4914
5022
  - block_type
4915
- - id
4916
5023
  - properties
4917
5024
  GenerateBodyRequest:
4918
5025
  type: object
@@ -5447,22 +5554,18 @@ components:
5447
5554
  type: object
5448
5555
  description: A block of Jinja template code that is used to generate a prompt
5449
5556
  properties:
5450
- block_type:
5451
- $ref: '#/components/schemas/JinjaEnum'
5452
- properties:
5453
- $ref: '#/components/schemas/JinjaPromptBlockPropertiesRequest'
5454
- id:
5455
- type: string
5456
- minLength: 1
5457
5557
  state:
5458
5558
  $ref: '#/components/schemas/PromptBlockState'
5459
5559
  cache_config:
5460
5560
  allOf:
5461
5561
  - $ref: '#/components/schemas/EphemeralPromptCacheConfigRequest'
5462
5562
  nullable: true
5563
+ block_type:
5564
+ $ref: '#/components/schemas/JinjaEnum'
5565
+ properties:
5566
+ $ref: '#/components/schemas/JinjaPromptBlockPropertiesRequest'
5463
5567
  required:
5464
5568
  - block_type
5465
- - id
5466
5569
  - properties
5467
5570
  JsonEnum:
5468
5571
  type: string
@@ -6684,6 +6787,26 @@ components:
6684
6787
  type: array
6685
6788
  items:
6686
6789
  $ref: '#/components/schemas/ContainerImageRead'
6790
+ PaginatedDeploymentReleaseTagReadList:
6791
+ type: object
6792
+ properties:
6793
+ count:
6794
+ type: integer
6795
+ example: 123
6796
+ next:
6797
+ type: string
6798
+ nullable: true
6799
+ format: uri
6800
+ example: http://api.example.org/accounts/?offset=400&limit=100
6801
+ previous:
6802
+ type: string
6803
+ nullable: true
6804
+ format: uri
6805
+ example: http://api.example.org/accounts/?offset=200&limit=100
6806
+ results:
6807
+ type: array
6808
+ items:
6809
+ $ref: '#/components/schemas/DeploymentReleaseTagRead'
6687
6810
  PaginatedDocumentIndexReadList:
6688
6811
  type: object
6689
6812
  properties:
@@ -6834,6 +6957,26 @@ components:
6834
6957
  - next
6835
6958
  - previous
6836
6959
  - results
6960
+ PaginatedWorkflowReleaseTagReadList:
6961
+ type: object
6962
+ properties:
6963
+ count:
6964
+ type: integer
6965
+ example: 123
6966
+ next:
6967
+ type: string
6968
+ nullable: true
6969
+ format: uri
6970
+ example: http://api.example.org/accounts/?offset=400&limit=100
6971
+ previous:
6972
+ type: string
6973
+ nullable: true
6974
+ format: uri
6975
+ example: http://api.example.org/accounts/?offset=200&limit=100
6976
+ results:
6977
+ type: array
6978
+ items:
6979
+ $ref: '#/components/schemas/WorkflowReleaseTagRead'
6837
6980
  PatchedDeploymentReleaseTagUpdateRequest:
6838
6981
  type: object
6839
6982
  properties:
@@ -6957,22 +7100,18 @@ components:
6957
7100
  type: object
6958
7101
  description: A block that holds a plain text string value.
6959
7102
  properties:
6960
- block_type:
6961
- $ref: '#/components/schemas/PlainTextEnum'
6962
- text:
6963
- type: string
6964
- id:
6965
- type: string
6966
- minLength: 1
6967
7103
  state:
6968
7104
  $ref: '#/components/schemas/PromptBlockState'
6969
7105
  cache_config:
6970
7106
  allOf:
6971
7107
  - $ref: '#/components/schemas/EphemeralPromptCacheConfigRequest'
6972
7108
  nullable: true
7109
+ block_type:
7110
+ $ref: '#/components/schemas/PlainTextEnum'
7111
+ text:
7112
+ type: string
6973
7113
  required:
6974
7114
  - block_type
6975
- - id
6976
7115
  - text
6977
7116
  Price:
6978
7117
  type: object
@@ -10125,23 +10264,19 @@ components:
10125
10264
  type: object
10126
10265
  description: A block that represents a variable in a prompt template.
10127
10266
  properties:
10128
- block_type:
10129
- $ref: '#/components/schemas/VariableEnum'
10130
- id:
10131
- type: string
10132
- minLength: 1
10133
10267
  state:
10134
10268
  $ref: '#/components/schemas/PromptBlockState'
10135
10269
  cache_config:
10136
10270
  allOf:
10137
10271
  - $ref: '#/components/schemas/EphemeralPromptCacheConfigRequest'
10138
10272
  nullable: true
10273
+ block_type:
10274
+ $ref: '#/components/schemas/VariableEnum'
10139
10275
  input_variable_id:
10140
10276
  type: string
10141
10277
  format: uuid
10142
10278
  required:
10143
10279
  - block_type
10144
- - id
10145
10280
  - input_variable_id
10146
10281
  VellumAudio:
10147
10282
  type: object