vellum-ai 0.8.24 → 0.8.26

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 (257) hide show
  1. package/.mock/definition/__package__.yml +175 -1
  2. package/.mock/definition/adHoc.yml +1 -0
  3. package/.mock/definition/folderEntities.yml +91 -2
  4. package/.mock/definition/workspaceSecrets.yml +34 -0
  5. package/.mock/openapi/openapi.yml +374 -6
  6. package/Client.d.ts +6 -3
  7. package/Client.js +16 -11
  8. package/api/resources/adHoc/client/Client.d.ts +3 -3
  9. package/api/resources/adHoc/client/Client.js +2 -2
  10. package/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +4 -0
  11. package/api/resources/deployments/client/Client.d.ts +3 -3
  12. package/api/resources/deployments/client/Client.js +6 -6
  13. package/api/resources/documentIndexes/client/Client.d.ts +3 -3
  14. package/api/resources/documentIndexes/client/Client.js +9 -9
  15. package/api/resources/documents/client/Client.d.ts +3 -3
  16. package/api/resources/documents/client/Client.js +6 -6
  17. package/api/resources/folderEntities/client/Client.d.ts +22 -4
  18. package/api/resources/folderEntities/client/Client.js +80 -4
  19. package/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.d.ts +43 -0
  20. package/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.js +5 -0
  21. package/api/resources/folderEntities/client/requests/index.d.ts +1 -0
  22. package/api/resources/folderEntities/index.d.ts +1 -0
  23. package/api/resources/folderEntities/index.js +1 -0
  24. package/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +8 -0
  25. package/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +10 -0
  26. package/api/resources/folderEntities/types/index.d.ts +1 -0
  27. package/api/resources/folderEntities/types/index.js +17 -0
  28. package/api/resources/index.d.ts +3 -1
  29. package/api/resources/index.js +4 -2
  30. package/api/resources/metricDefinitions/client/Client.d.ts +3 -3
  31. package/api/resources/metricDefinitions/client/Client.js +2 -2
  32. package/api/resources/sandboxes/client/Client.d.ts +3 -3
  33. package/api/resources/sandboxes/client/Client.js +4 -4
  34. package/api/resources/testSuiteRuns/client/Client.d.ts +3 -3
  35. package/api/resources/testSuiteRuns/client/Client.js +4 -4
  36. package/api/resources/testSuites/client/Client.d.ts +3 -3
  37. package/api/resources/testSuites/client/Client.js +5 -5
  38. package/api/resources/workflowDeployments/client/Client.d.ts +3 -3
  39. package/api/resources/workflowDeployments/client/Client.js +5 -5
  40. package/api/resources/workflowSandboxes/client/Client.d.ts +3 -3
  41. package/api/resources/workflowSandboxes/client/Client.js +2 -2
  42. package/api/resources/workspaceSecrets/client/Client.d.ts +37 -0
  43. package/api/resources/workspaceSecrets/client/Client.js +110 -0
  44. package/api/resources/workspaceSecrets/client/index.d.ts +1 -0
  45. package/api/resources/workspaceSecrets/client/index.js +2 -0
  46. package/api/resources/workspaceSecrets/index.d.ts +1 -0
  47. package/api/resources/workspaceSecrets/index.js +17 -0
  48. package/api/types/ApiNodeResultData.d.ts +1 -1
  49. package/api/types/FolderEntity.d.ts +5 -0
  50. package/api/types/FolderEntity.js +5 -0
  51. package/api/types/FolderEntityDocumentIndex.d.ts +12 -0
  52. package/api/types/FolderEntityDocumentIndex.js +5 -0
  53. package/api/types/FolderEntityDocumentIndexData.d.ts +11 -0
  54. package/api/types/FolderEntityDocumentIndexData.js +5 -0
  55. package/api/types/FolderEntityFolder.d.ts +12 -0
  56. package/api/types/FolderEntityFolder.js +5 -0
  57. package/api/types/FolderEntityFolderData.d.ts +10 -0
  58. package/api/types/FolderEntityFolderData.js +5 -0
  59. package/api/types/FolderEntityPromptSandbox.d.ts +12 -0
  60. package/api/types/FolderEntityPromptSandbox.js +5 -0
  61. package/api/types/FolderEntityPromptSandboxData.d.ts +12 -0
  62. package/api/types/FolderEntityPromptSandboxData.js +5 -0
  63. package/api/types/FolderEntityTestSuite.d.ts +12 -0
  64. package/api/types/FolderEntityTestSuite.js +5 -0
  65. package/api/types/FolderEntityTestSuiteData.d.ts +11 -0
  66. package/api/types/FolderEntityTestSuiteData.js +5 -0
  67. package/api/types/FolderEntityWorkflowSandbox.d.ts +12 -0
  68. package/api/types/FolderEntityWorkflowSandbox.js +5 -0
  69. package/api/types/FolderEntityWorkflowSandboxData.d.ts +12 -0
  70. package/api/types/FolderEntityWorkflowSandboxData.js +5 -0
  71. package/api/types/PaginatedFolderEntityList.d.ts +10 -0
  72. package/api/types/PaginatedFolderEntityList.js +5 -0
  73. package/api/types/PromptSettingsRequest.d.ts +6 -0
  74. package/api/types/PromptSettingsRequest.js +5 -0
  75. package/api/types/SecretTypeEnum.d.ts +14 -0
  76. package/api/types/SecretTypeEnum.js +11 -0
  77. package/api/types/VellumErrorCodeEnum.d.ts +3 -1
  78. package/api/types/VellumErrorCodeEnum.js +1 -0
  79. package/api/types/WorkspaceSecretRead.d.ts +11 -0
  80. package/api/types/WorkspaceSecretRead.js +5 -0
  81. package/api/types/index.d.ts +15 -0
  82. package/api/types/index.js +15 -0
  83. package/dist/Client.d.ts +6 -3
  84. package/dist/Client.js +16 -11
  85. package/dist/api/resources/adHoc/client/Client.d.ts +3 -3
  86. package/dist/api/resources/adHoc/client/Client.js +2 -2
  87. package/dist/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +4 -0
  88. package/dist/api/resources/deployments/client/Client.d.ts +3 -3
  89. package/dist/api/resources/deployments/client/Client.js +6 -6
  90. package/dist/api/resources/documentIndexes/client/Client.d.ts +3 -3
  91. package/dist/api/resources/documentIndexes/client/Client.js +9 -9
  92. package/dist/api/resources/documents/client/Client.d.ts +3 -3
  93. package/dist/api/resources/documents/client/Client.js +6 -6
  94. package/dist/api/resources/folderEntities/client/Client.d.ts +22 -4
  95. package/dist/api/resources/folderEntities/client/Client.js +80 -4
  96. package/dist/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.d.ts +43 -0
  97. package/dist/api/resources/folderEntities/client/requests/FolderEntitiesListRequest.js +5 -0
  98. package/dist/api/resources/folderEntities/client/requests/index.d.ts +1 -0
  99. package/dist/api/resources/folderEntities/index.d.ts +1 -0
  100. package/dist/api/resources/folderEntities/index.js +1 -0
  101. package/dist/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +8 -0
  102. package/dist/api/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +10 -0
  103. package/dist/api/resources/folderEntities/types/index.d.ts +1 -0
  104. package/dist/api/resources/folderEntities/types/index.js +17 -0
  105. package/dist/api/resources/index.d.ts +3 -1
  106. package/dist/api/resources/index.js +4 -2
  107. package/dist/api/resources/metricDefinitions/client/Client.d.ts +3 -3
  108. package/dist/api/resources/metricDefinitions/client/Client.js +2 -2
  109. package/dist/api/resources/sandboxes/client/Client.d.ts +3 -3
  110. package/dist/api/resources/sandboxes/client/Client.js +4 -4
  111. package/dist/api/resources/testSuiteRuns/client/Client.d.ts +3 -3
  112. package/dist/api/resources/testSuiteRuns/client/Client.js +4 -4
  113. package/dist/api/resources/testSuites/client/Client.d.ts +3 -3
  114. package/dist/api/resources/testSuites/client/Client.js +5 -5
  115. package/dist/api/resources/workflowDeployments/client/Client.d.ts +3 -3
  116. package/dist/api/resources/workflowDeployments/client/Client.js +5 -5
  117. package/dist/api/resources/workflowSandboxes/client/Client.d.ts +3 -3
  118. package/dist/api/resources/workflowSandboxes/client/Client.js +2 -2
  119. package/dist/api/resources/workspaceSecrets/client/Client.d.ts +37 -0
  120. package/dist/api/resources/workspaceSecrets/client/Client.js +110 -0
  121. package/dist/api/resources/workspaceSecrets/client/index.d.ts +1 -0
  122. package/dist/api/resources/workspaceSecrets/client/index.js +2 -0
  123. package/dist/api/resources/workspaceSecrets/index.d.ts +1 -0
  124. package/dist/api/resources/workspaceSecrets/index.js +17 -0
  125. package/dist/api/types/ApiNodeResultData.d.ts +1 -1
  126. package/dist/api/types/FolderEntity.d.ts +5 -0
  127. package/dist/api/types/FolderEntity.js +5 -0
  128. package/dist/api/types/FolderEntityDocumentIndex.d.ts +12 -0
  129. package/dist/api/types/FolderEntityDocumentIndex.js +5 -0
  130. package/dist/api/types/FolderEntityDocumentIndexData.d.ts +11 -0
  131. package/dist/api/types/FolderEntityDocumentIndexData.js +5 -0
  132. package/dist/api/types/FolderEntityFolder.d.ts +12 -0
  133. package/dist/api/types/FolderEntityFolder.js +5 -0
  134. package/dist/api/types/FolderEntityFolderData.d.ts +10 -0
  135. package/dist/api/types/FolderEntityFolderData.js +5 -0
  136. package/dist/api/types/FolderEntityPromptSandbox.d.ts +12 -0
  137. package/dist/api/types/FolderEntityPromptSandbox.js +5 -0
  138. package/dist/api/types/FolderEntityPromptSandboxData.d.ts +12 -0
  139. package/dist/api/types/FolderEntityPromptSandboxData.js +5 -0
  140. package/dist/api/types/FolderEntityTestSuite.d.ts +12 -0
  141. package/dist/api/types/FolderEntityTestSuite.js +5 -0
  142. package/dist/api/types/FolderEntityTestSuiteData.d.ts +11 -0
  143. package/dist/api/types/FolderEntityTestSuiteData.js +5 -0
  144. package/dist/api/types/FolderEntityWorkflowSandbox.d.ts +12 -0
  145. package/dist/api/types/FolderEntityWorkflowSandbox.js +5 -0
  146. package/dist/api/types/FolderEntityWorkflowSandboxData.d.ts +12 -0
  147. package/dist/api/types/FolderEntityWorkflowSandboxData.js +5 -0
  148. package/dist/api/types/PaginatedFolderEntityList.d.ts +10 -0
  149. package/dist/api/types/PaginatedFolderEntityList.js +5 -0
  150. package/dist/api/types/PromptSettingsRequest.d.ts +6 -0
  151. package/dist/api/types/PromptSettingsRequest.js +5 -0
  152. package/dist/api/types/SecretTypeEnum.d.ts +14 -0
  153. package/dist/api/types/SecretTypeEnum.js +11 -0
  154. package/dist/api/types/VellumErrorCodeEnum.d.ts +3 -1
  155. package/dist/api/types/VellumErrorCodeEnum.js +1 -0
  156. package/dist/api/types/WorkspaceSecretRead.d.ts +11 -0
  157. package/dist/api/types/WorkspaceSecretRead.js +5 -0
  158. package/dist/api/types/index.d.ts +15 -0
  159. package/dist/api/types/index.js +15 -0
  160. package/dist/serialization/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +2 -0
  161. package/dist/serialization/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.js +2 -0
  162. package/dist/serialization/resources/folderEntities/index.d.ts +1 -0
  163. package/dist/serialization/resources/folderEntities/index.js +1 -0
  164. package/dist/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +10 -0
  165. package/dist/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +31 -0
  166. package/dist/serialization/resources/folderEntities/types/index.d.ts +1 -0
  167. package/dist/serialization/resources/folderEntities/types/index.js +17 -0
  168. package/dist/serialization/resources/index.d.ts +2 -1
  169. package/dist/serialization/resources/index.js +3 -2
  170. package/dist/serialization/types/ApiNodeResultData.d.ts +1 -1
  171. package/dist/serialization/types/ApiNodeResultData.js +1 -1
  172. package/dist/serialization/types/FolderEntity.d.ts +15 -0
  173. package/dist/serialization/types/FolderEntity.js +42 -0
  174. package/dist/serialization/types/FolderEntityDocumentIndex.d.ts +15 -0
  175. package/dist/serialization/types/FolderEntityDocumentIndex.js +36 -0
  176. package/dist/serialization/types/FolderEntityDocumentIndexData.d.ts +17 -0
  177. package/dist/serialization/types/FolderEntityDocumentIndexData.js +38 -0
  178. package/dist/serialization/types/FolderEntityFolder.d.ts +15 -0
  179. package/dist/serialization/types/FolderEntityFolder.js +36 -0
  180. package/dist/serialization/types/FolderEntityFolderData.d.ts +16 -0
  181. package/dist/serialization/types/FolderEntityFolderData.js +37 -0
  182. package/dist/serialization/types/FolderEntityPromptSandbox.d.ts +15 -0
  183. package/dist/serialization/types/FolderEntityPromptSandbox.js +36 -0
  184. package/dist/serialization/types/FolderEntityPromptSandboxData.d.ts +18 -0
  185. package/dist/serialization/types/FolderEntityPromptSandboxData.js +39 -0
  186. package/dist/serialization/types/FolderEntityTestSuite.d.ts +15 -0
  187. package/dist/serialization/types/FolderEntityTestSuite.js +36 -0
  188. package/dist/serialization/types/FolderEntityTestSuiteData.d.ts +17 -0
  189. package/dist/serialization/types/FolderEntityTestSuiteData.js +38 -0
  190. package/dist/serialization/types/FolderEntityWorkflowSandbox.d.ts +15 -0
  191. package/dist/serialization/types/FolderEntityWorkflowSandbox.js +36 -0
  192. package/dist/serialization/types/FolderEntityWorkflowSandboxData.d.ts +18 -0
  193. package/dist/serialization/types/FolderEntityWorkflowSandboxData.js +39 -0
  194. package/dist/serialization/types/PaginatedFolderEntityList.d.ts +16 -0
  195. package/dist/serialization/types/PaginatedFolderEntityList.js +37 -0
  196. package/dist/serialization/types/PromptSettingsRequest.d.ts +12 -0
  197. package/dist/serialization/types/PromptSettingsRequest.js +33 -0
  198. package/dist/serialization/types/SecretTypeEnum.d.ts +10 -0
  199. package/dist/serialization/types/SecretTypeEnum.js +31 -0
  200. package/dist/serialization/types/VellumErrorCodeEnum.d.ts +1 -1
  201. package/dist/serialization/types/VellumErrorCodeEnum.js +7 -1
  202. package/dist/serialization/types/WorkspaceSecretRead.d.ts +17 -0
  203. package/dist/serialization/types/WorkspaceSecretRead.js +38 -0
  204. package/dist/serialization/types/index.d.ts +15 -0
  205. package/dist/serialization/types/index.js +15 -0
  206. package/dist/version.d.ts +1 -1
  207. package/dist/version.js +1 -1
  208. package/package.json +1 -1
  209. package/reference.md +142 -1
  210. package/serialization/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +2 -0
  211. package/serialization/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.js +2 -0
  212. package/serialization/resources/folderEntities/index.d.ts +1 -0
  213. package/serialization/resources/folderEntities/index.js +1 -0
  214. package/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.d.ts +10 -0
  215. package/serialization/resources/folderEntities/types/FolderEntitiesListRequestEntityStatus.js +31 -0
  216. package/serialization/resources/folderEntities/types/index.d.ts +1 -0
  217. package/serialization/resources/folderEntities/types/index.js +17 -0
  218. package/serialization/resources/index.d.ts +2 -1
  219. package/serialization/resources/index.js +3 -2
  220. package/serialization/types/ApiNodeResultData.d.ts +1 -1
  221. package/serialization/types/ApiNodeResultData.js +1 -1
  222. package/serialization/types/FolderEntity.d.ts +15 -0
  223. package/serialization/types/FolderEntity.js +42 -0
  224. package/serialization/types/FolderEntityDocumentIndex.d.ts +15 -0
  225. package/serialization/types/FolderEntityDocumentIndex.js +36 -0
  226. package/serialization/types/FolderEntityDocumentIndexData.d.ts +17 -0
  227. package/serialization/types/FolderEntityDocumentIndexData.js +38 -0
  228. package/serialization/types/FolderEntityFolder.d.ts +15 -0
  229. package/serialization/types/FolderEntityFolder.js +36 -0
  230. package/serialization/types/FolderEntityFolderData.d.ts +16 -0
  231. package/serialization/types/FolderEntityFolderData.js +37 -0
  232. package/serialization/types/FolderEntityPromptSandbox.d.ts +15 -0
  233. package/serialization/types/FolderEntityPromptSandbox.js +36 -0
  234. package/serialization/types/FolderEntityPromptSandboxData.d.ts +18 -0
  235. package/serialization/types/FolderEntityPromptSandboxData.js +39 -0
  236. package/serialization/types/FolderEntityTestSuite.d.ts +15 -0
  237. package/serialization/types/FolderEntityTestSuite.js +36 -0
  238. package/serialization/types/FolderEntityTestSuiteData.d.ts +17 -0
  239. package/serialization/types/FolderEntityTestSuiteData.js +38 -0
  240. package/serialization/types/FolderEntityWorkflowSandbox.d.ts +15 -0
  241. package/serialization/types/FolderEntityWorkflowSandbox.js +36 -0
  242. package/serialization/types/FolderEntityWorkflowSandboxData.d.ts +18 -0
  243. package/serialization/types/FolderEntityWorkflowSandboxData.js +39 -0
  244. package/serialization/types/PaginatedFolderEntityList.d.ts +16 -0
  245. package/serialization/types/PaginatedFolderEntityList.js +37 -0
  246. package/serialization/types/PromptSettingsRequest.d.ts +12 -0
  247. package/serialization/types/PromptSettingsRequest.js +33 -0
  248. package/serialization/types/SecretTypeEnum.d.ts +10 -0
  249. package/serialization/types/SecretTypeEnum.js +31 -0
  250. package/serialization/types/VellumErrorCodeEnum.d.ts +1 -1
  251. package/serialization/types/VellumErrorCodeEnum.js +7 -1
  252. package/serialization/types/WorkspaceSecretRead.d.ts +17 -0
  253. package/serialization/types/WorkspaceSecretRead.js +38 -0
  254. package/serialization/types/index.d.ts +15 -0
  255. package/serialization/types/index.js +15 -0
  256. package/version.d.ts +1 -1
  257. package/version.js +1 -1
@@ -755,10 +755,10 @@ types:
755
755
  openapi: openapi/openapi.yml
756
756
  ApiNodeResultData:
757
757
  properties:
758
+ json: optional<map<string, unknown>>
758
759
  text_output_id: string
759
760
  text: optional<string>
760
761
  json_output_id: string
761
- json: optional<map<string, unknown>>
762
762
  status_code_output_id: string
763
763
  status_code: integer
764
764
  source:
@@ -1751,6 +1751,133 @@ types:
1751
1751
  * `UNKNOWN` - UNKNOWN
1752
1752
  source:
1753
1753
  openapi: openapi/openapi.yml
1754
+ FolderEntity:
1755
+ discriminated: false
1756
+ union:
1757
+ - FolderEntityFolder
1758
+ - FolderEntityPromptSandbox
1759
+ - FolderEntityWorkflowSandbox
1760
+ - FolderEntityDocumentIndex
1761
+ - FolderEntityTestSuite
1762
+ source:
1763
+ openapi: openapi/openapi.yml
1764
+ FolderEntityDocumentIndex:
1765
+ docs: A slim representation of a Document Index, as it exists within a Folder.
1766
+ properties:
1767
+ id:
1768
+ type: string
1769
+ validation:
1770
+ format: uuid
1771
+ type: literal<"DOCUMENT_INDEX">
1772
+ data: FolderEntityDocumentIndexData
1773
+ source:
1774
+ openapi: openapi/openapi.yml
1775
+ FolderEntityDocumentIndexData:
1776
+ properties:
1777
+ id:
1778
+ type: string
1779
+ validation:
1780
+ format: uuid
1781
+ label: string
1782
+ created: datetime
1783
+ modified: datetime
1784
+ status: EntityStatus
1785
+ source:
1786
+ openapi: openapi/openapi.yml
1787
+ FolderEntityFolder:
1788
+ docs: A slim representation of a Folder, as it exists within another Folder.
1789
+ properties:
1790
+ id:
1791
+ type: string
1792
+ validation:
1793
+ format: uuid
1794
+ type: literal<"FOLDER">
1795
+ data: FolderEntityFolderData
1796
+ source:
1797
+ openapi: openapi/openapi.yml
1798
+ FolderEntityFolderData:
1799
+ properties:
1800
+ id:
1801
+ type: string
1802
+ validation:
1803
+ format: uuid
1804
+ label: string
1805
+ created: datetime
1806
+ modified: datetime
1807
+ has_contents: boolean
1808
+ source:
1809
+ openapi: openapi/openapi.yml
1810
+ FolderEntityPromptSandbox:
1811
+ docs: A slim representation of a Prompt Sandbox, as it exists within a Folder.
1812
+ properties:
1813
+ id:
1814
+ type: string
1815
+ validation:
1816
+ format: uuid
1817
+ type: literal<"PROMPT_SANDBOX">
1818
+ data: FolderEntityPromptSandboxData
1819
+ source:
1820
+ openapi: openapi/openapi.yml
1821
+ FolderEntityPromptSandboxData:
1822
+ properties:
1823
+ id:
1824
+ type: string
1825
+ validation:
1826
+ format: uuid
1827
+ label: string
1828
+ created: datetime
1829
+ modified: datetime
1830
+ status: EntityStatus
1831
+ last_deployed_on: optional<datetime>
1832
+ source:
1833
+ openapi: openapi/openapi.yml
1834
+ FolderEntityTestSuite:
1835
+ docs: A slim representation of a Test Suite, as it exists within a Folder.
1836
+ properties:
1837
+ id:
1838
+ type: string
1839
+ validation:
1840
+ format: uuid
1841
+ type: literal<"TEST_SUITE">
1842
+ data: FolderEntityTestSuiteData
1843
+ source:
1844
+ openapi: openapi/openapi.yml
1845
+ FolderEntityTestSuiteData:
1846
+ properties:
1847
+ id:
1848
+ type: string
1849
+ validation:
1850
+ format: uuid
1851
+ label: string
1852
+ created: datetime
1853
+ modified: datetime
1854
+ status: EntityStatus
1855
+ source:
1856
+ openapi: openapi/openapi.yml
1857
+ FolderEntityWorkflowSandbox:
1858
+ docs: A slim representation of a Workflow Sandbox, as it exists within a Folder.
1859
+ properties:
1860
+ id:
1861
+ type: string
1862
+ validation:
1863
+ format: uuid
1864
+ type: literal<"WORKFLOW_SANDBOX">
1865
+ data: FolderEntityWorkflowSandboxData
1866
+ source:
1867
+ openapi: openapi/openapi.yml
1868
+ FolderEntityWorkflowSandboxData:
1869
+ properties:
1870
+ id:
1871
+ type: string
1872
+ validation:
1873
+ format: uuid
1874
+ label: string
1875
+ created: datetime
1876
+ modified: datetime
1877
+ status: EntityStatus
1878
+ last_deployed_on: optional<datetime>
1879
+ source:
1880
+ openapi: openapi/openapi.yml
1754
1881
  FulfilledAdHocExecutePromptEvent:
1755
1882
  docs: >-
1756
1883
  The final data event returned indicating that the stream has ended and all
@@ -3016,6 +3143,20 @@ types:
3016
3143
  results: optional<list<DocumentIndexRead>>
3017
3144
  source:
3018
3145
  openapi: openapi/openapi.yml
3146
+ PaginatedFolderEntityList:
3147
+ properties:
3148
+ count: optional<integer>
3149
+ next:
3150
+ type: optional<string>
3151
+ validation:
3152
+ format: uri
3153
+ previous:
3154
+ type: optional<string>
3155
+ validation:
3156
+ format: uri
3157
+ results: optional<list<FolderEntity>>
3158
+ source:
3159
+ openapi: openapi/openapi.yml
3019
3160
  PaginatedSlimDeploymentReadList:
3020
3161
  properties:
3021
3162
  count: optional<integer>
@@ -3329,6 +3470,11 @@ types:
3329
3470
  value: string
3330
3471
  source:
3331
3472
  openapi: openapi/openapi.yml
3473
+ PromptSettingsRequest:
3474
+ properties:
3475
+ timeout: optional<double>
3476
+ source:
3477
+ openapi: openapi/openapi.yml
3332
3478
  RawPromptExecutionOverridesRequest:
3333
3479
  properties:
3334
3480
  body: optional<map<string, unknown>>
@@ -3777,6 +3923,17 @@ types:
3777
3923
  max: 1
3778
3924
  source:
3779
3925
  openapi: openapi/openapi.yml
3926
+ SecretTypeEnum:
3927
+ enum:
3928
+ - USER_DEFINED
3929
+ - HMAC
3930
+ - INTERNAL_API_KEY
3931
+ docs: |-
3932
+ * `USER_DEFINED` - User Defined
3933
+ * `HMAC` - Hmac
3934
+ * `INTERNAL_API_KEY` - Internal Api Key
3935
+ source:
3936
+ openapi: openapi/openapi.yml
3780
3937
  SentenceChunkerConfig:
3781
3938
  docs: Configuration for sentence chunking
3782
3939
  properties:
@@ -5183,11 +5340,13 @@ types:
5183
5340
  enum:
5184
5341
  - INVALID_REQUEST
5185
5342
  - PROVIDER_ERROR
5343
+ - REQUEST_TIMEOUT
5186
5344
  - INTERNAL_SERVER_ERROR
5187
5345
  - USER_DEFINED_ERROR
5188
5346
  docs: |-
5189
5347
  * `INVALID_REQUEST` - INVALID_REQUEST
5190
5348
  * `PROVIDER_ERROR` - PROVIDER_ERROR
5349
+ * `REQUEST_TIMEOUT` - REQUEST_TIMEOUT
5191
5350
  * `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR
5192
5351
  * `USER_DEFINED_ERROR` - USER_DEFINED_ERROR
5193
5352
  source:
@@ -6027,6 +6186,21 @@ types:
6027
6186
  - WorkflowExecutionNodeResultEvent
6028
6187
  source:
6029
6188
  openapi: openapi/openapi.yml
6189
+ WorkspaceSecretRead:
6190
+ properties:
6191
+ id:
6192
+ type: string
6193
+ validation:
6194
+ format: uuid
6195
+ modified: datetime
6196
+ name:
6197
+ type: string
6198
+ validation:
6199
+ maxLength: 250
6200
+ label: string
6201
+ secret_type: SecretTypeEnum
6202
+ source:
6203
+ openapi: openapi/openapi.yml
6030
6204
  HkunlpInstructorXlEnum: literal<"hkunlp/instructor-xl">
6031
6205
  IntfloatMultilingualE5LargeEnum: literal<"intfloat/multilingual-e5-large">
6032
6206
  ReductoChunkerEnum: literal<"reducto-chunker">
@@ -22,6 +22,7 @@ service:
22
22
  input_values: list<root.PromptRequestInputRequest>
23
23
  input_variables: list<root.VellumVariableRequest>
24
24
  parameters: root.PromptParametersRequest
25
+ settings: optional<root.PromptSettingsRequest>
25
26
  blocks: list<root.PromptBlockRequest>
26
27
  expand_meta: optional<root.AdHocExpandMetaRequest>
27
28
  response-stream:
@@ -1,7 +1,87 @@
1
+ types:
2
+ FolderEntitiesListRequestEntityStatus:
3
+ enum:
4
+ - ACTIVE
5
+ - ARCHIVED
6
+ source:
7
+ openapi: openapi/openapi.yml
8
+ imports:
9
+ root: __package__.yml
1
10
  service:
2
11
  auth: false
3
12
  base-path: ''
4
13
  endpoints:
14
+ list:
15
+ path: /v1/folder-entities
16
+ method: GET
17
+ auth: false
18
+ docs: List all folder entities within a specified folder.
19
+ request:
20
+ name: FolderEntitiesListRequest
21
+ query-parameters:
22
+ entity_status:
23
+ type: optional<FolderEntitiesListRequestEntityStatus>
24
+ docs: >-
25
+ Filter down to only those objects whose entities have a status
26
+ matching the status specified.
27
+
28
+
29
+ * `ACTIVE` - Active
30
+
31
+ * `ARCHIVED` - Archived
32
+ limit:
33
+ type: optional<integer>
34
+ docs: Number of results to return per page.
35
+ offset:
36
+ type: optional<integer>
37
+ docs: The initial index from which to return the results.
38
+ ordering:
39
+ type: optional<string>
40
+ docs: Which field to use when ordering the results.
41
+ parent_folder_id:
42
+ type: string
43
+ docs: >-
44
+ Filter down to only those entities whose parent folder has the
45
+ specified ID.
46
+
47
+
48
+ To filter by an entity's parent folder, provide the ID of the
49
+ parent folder. To filter by the root directory, provide
50
+
51
+ a string representing the entity type of the root directory.
52
+ Supported root directories include:
53
+
54
+ - PROMPT_SANDBOX
55
+
56
+ - WORKFLOW_SANDBOX
57
+
58
+ - DOCUMENT_INDEX
59
+
60
+ - TEST_SUITE
61
+ response:
62
+ docs: ''
63
+ type: root.PaginatedFolderEntityList
64
+ url: Default
65
+ availability: pre-release
66
+ examples:
67
+ - query-parameters:
68
+ parent_folder_id: parent_folder_id
69
+ response:
70
+ body:
71
+ count: 123
72
+ next: http://api.example.org/accounts/?offset=400&limit=100
73
+ previous: http://api.example.org/accounts/?offset=200&limit=100
74
+ results:
75
+ - id: id
76
+ type: FOLDER
77
+ data:
78
+ id: id
79
+ label: label
80
+ created: '2024-01-15T09:30:00Z'
81
+ modified: '2024-01-15T09:30:00Z'
82
+ has_contents: true
83
+ audiences:
84
+ - customers
5
85
  add_entity_to_folder:
6
86
  path: /v1/folders/{folder_id}/add-entity
7
87
  method: POST
@@ -17,8 +97,17 @@ service:
17
97
  type: string
18
98
  docs: >-
19
99
  The ID of the folder to which the entity should be added. This can
20
- be a UUID of a folder, or the name of a root directory (e.g.
21
- "PROMPT_SANDBOX").
100
+ be a UUID of a folder, or the name of a root
101
+
102
+ directory. Supported root directories include:
103
+
104
+ - PROMPT_SANDBOX
105
+
106
+ - WORKFLOW_SANDBOX
107
+
108
+ - DOCUMENT_INDEX
109
+
110
+ - TEST_SUITE
22
111
  request:
23
112
  name: AddEntityToFolderRequest
24
113
  body:
@@ -0,0 +1,34 @@
1
+ imports:
2
+ root: __package__.yml
3
+ service:
4
+ auth: false
5
+ base-path: ''
6
+ endpoints:
7
+ retrieve:
8
+ path: /v1/workspace-secrets/{id}
9
+ method: GET
10
+ auth: false
11
+ docs: Used to retrieve a Workspace Secret given its ID or name.
12
+ path-parameters:
13
+ id:
14
+ type: string
15
+ docs: Either the Workspace Secret's ID or its unique name
16
+ response:
17
+ docs: ''
18
+ type: root.WorkspaceSecretRead
19
+ url: Default
20
+ availability: pre-release
21
+ examples:
22
+ - path-parameters:
23
+ id: id
24
+ response:
25
+ body:
26
+ id: id
27
+ modified: '2024-01-15T09:30:00Z'
28
+ name: name
29
+ label: label
30
+ secret_type: USER_DEFINED
31
+ audiences:
32
+ - internal
33
+ source:
34
+ openapi: openapi/openapi.yml