vellum-ai 0.1.4 → 0.1.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 (215) hide show
  1. package/Client.d.ts +16 -0
  2. package/Client.js +137 -12
  3. package/api/errors/ForbiddenError.d.ts +1 -2
  4. package/api/resources/deployments/client/Client.d.ts +1 -0
  5. package/api/resources/deployments/client/Client.js +50 -1
  6. package/api/resources/deployments/client/index.d.ts +1 -1
  7. package/api/resources/deployments/client/index.js +15 -0
  8. package/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +11 -0
  9. package/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.js +5 -0
  10. package/api/resources/deployments/client/requests/index.d.ts +1 -0
  11. package/api/resources/deployments/client/requests/index.js +2 -0
  12. package/api/resources/documentIndexes/client/Client.js +2 -2
  13. package/api/resources/documents/client/Client.js +4 -4
  14. package/api/resources/index.d.ts +1 -0
  15. package/api/resources/index.js +1 -0
  16. package/api/resources/modelVersions/client/Client.d.ts +1 -1
  17. package/api/resources/modelVersions/client/Client.js +2 -2
  18. package/api/resources/registeredPrompts/client/Client.js +1 -1
  19. package/api/resources/sandboxes/client/Client.js +2 -2
  20. package/api/resources/testSuites/client/Client.js +2 -2
  21. package/api/types/ChatHistoryInputRequest.d.ts +9 -0
  22. package/api/types/ChatHistoryInputRequest.js +5 -0
  23. package/api/types/DeploymentProviderPayloadResponse.d.ts +6 -0
  24. package/api/types/DeploymentProviderPayloadResponse.js +5 -0
  25. package/api/types/DeploymentRead.d.ts +1 -0
  26. package/api/types/ErrorExecutePromptResponse.d.ts +8 -0
  27. package/api/types/ErrorExecutePromptResponse.js +5 -0
  28. package/api/types/ExecutePromptApiErrorResponse.d.ts +7 -0
  29. package/api/types/ExecutePromptApiErrorResponse.js +5 -0
  30. package/api/types/ExecutePromptRequest.d.ts +14 -0
  31. package/api/types/ExecutePromptRequest.js +5 -0
  32. package/api/types/ExecutePromptResponse.d.ts +16 -0
  33. package/api/types/ExecutePromptResponse.js +5 -0
  34. package/api/types/ExecutePromptStreamingResponse.d.ts +19 -0
  35. package/api/types/ExecutePromptStreamingResponse.js +5 -0
  36. package/api/types/FulfilledExecutePromptStreamingResponse.d.ts +7 -0
  37. package/api/types/FulfilledExecutePromptStreamingResponse.js +5 -0
  38. package/api/types/InitiatedExecutePromptResponse.d.ts +8 -0
  39. package/api/types/InitiatedExecutePromptResponse.js +5 -0
  40. package/api/types/InitiatedExecutePromptStreamingResponse.d.ts +7 -0
  41. package/api/types/InitiatedExecutePromptStreamingResponse.js +5 -0
  42. package/api/types/JsonExecutePromptResponse.d.ts +7 -0
  43. package/api/types/JsonExecutePromptResponse.js +5 -0
  44. package/api/types/JsonInputRequest.d.ts +8 -0
  45. package/api/types/JsonInputRequest.js +5 -0
  46. package/api/types/PromptDeploymentInputRequest.d.ts +16 -0
  47. package/api/types/PromptDeploymentInputRequest.js +5 -0
  48. package/api/types/RejectedExecutePromptResponse.d.ts +9 -0
  49. package/api/types/RejectedExecutePromptResponse.js +5 -0
  50. package/api/types/RejectedExecutePromptStreamingResponse.d.ts +7 -0
  51. package/api/types/RejectedExecutePromptStreamingResponse.js +5 -0
  52. package/api/types/StreamingExecutePromptStreamingResponse.d.ts +7 -0
  53. package/api/types/StreamingExecutePromptStreamingResponse.js +5 -0
  54. package/api/types/StringExecutePromptResponse.d.ts +7 -0
  55. package/api/types/StringExecutePromptResponse.js +5 -0
  56. package/api/types/StringInputRequest.d.ts +8 -0
  57. package/api/types/StringInputRequest.js +5 -0
  58. package/api/types/index.d.ts +18 -0
  59. package/api/types/index.js +18 -0
  60. package/dist/Client.d.ts +16 -0
  61. package/dist/Client.js +137 -12
  62. package/dist/api/errors/ForbiddenError.d.ts +1 -2
  63. package/dist/api/resources/deployments/client/Client.d.ts +1 -0
  64. package/dist/api/resources/deployments/client/Client.js +50 -1
  65. package/dist/api/resources/deployments/client/index.d.ts +1 -1
  66. package/dist/api/resources/deployments/client/index.js +15 -0
  67. package/dist/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +11 -0
  68. package/dist/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.js +5 -0
  69. package/dist/api/resources/deployments/client/requests/index.d.ts +1 -0
  70. package/dist/api/resources/deployments/client/requests/index.js +2 -0
  71. package/dist/api/resources/documentIndexes/client/Client.js +2 -2
  72. package/dist/api/resources/documents/client/Client.js +4 -4
  73. package/dist/api/resources/index.d.ts +1 -0
  74. package/dist/api/resources/index.js +1 -0
  75. package/dist/api/resources/modelVersions/client/Client.d.ts +1 -1
  76. package/dist/api/resources/modelVersions/client/Client.js +2 -2
  77. package/dist/api/resources/registeredPrompts/client/Client.js +1 -1
  78. package/dist/api/resources/sandboxes/client/Client.js +2 -2
  79. package/dist/api/resources/testSuites/client/Client.js +2 -2
  80. package/dist/api/types/ChatHistoryInputRequest.d.ts +9 -0
  81. package/dist/api/types/ChatHistoryInputRequest.js +5 -0
  82. package/dist/api/types/DeploymentProviderPayloadResponse.d.ts +6 -0
  83. package/dist/api/types/DeploymentProviderPayloadResponse.js +5 -0
  84. package/dist/api/types/DeploymentRead.d.ts +1 -0
  85. package/dist/api/types/ErrorExecutePromptResponse.d.ts +8 -0
  86. package/dist/api/types/ErrorExecutePromptResponse.js +5 -0
  87. package/dist/api/types/ExecutePromptApiErrorResponse.d.ts +7 -0
  88. package/dist/api/types/ExecutePromptApiErrorResponse.js +5 -0
  89. package/dist/api/types/ExecutePromptRequest.d.ts +14 -0
  90. package/dist/api/types/ExecutePromptRequest.js +5 -0
  91. package/dist/api/types/ExecutePromptResponse.d.ts +16 -0
  92. package/dist/api/types/ExecutePromptResponse.js +5 -0
  93. package/dist/api/types/ExecutePromptStreamingResponse.d.ts +19 -0
  94. package/dist/api/types/ExecutePromptStreamingResponse.js +5 -0
  95. package/dist/api/types/FulfilledExecutePromptStreamingResponse.d.ts +7 -0
  96. package/dist/api/types/FulfilledExecutePromptStreamingResponse.js +5 -0
  97. package/dist/api/types/InitiatedExecutePromptResponse.d.ts +8 -0
  98. package/dist/api/types/InitiatedExecutePromptResponse.js +5 -0
  99. package/dist/api/types/InitiatedExecutePromptStreamingResponse.d.ts +7 -0
  100. package/dist/api/types/InitiatedExecutePromptStreamingResponse.js +5 -0
  101. package/dist/api/types/JsonExecutePromptResponse.d.ts +7 -0
  102. package/dist/api/types/JsonExecutePromptResponse.js +5 -0
  103. package/dist/api/types/JsonInputRequest.d.ts +8 -0
  104. package/dist/api/types/JsonInputRequest.js +5 -0
  105. package/dist/api/types/PromptDeploymentInputRequest.d.ts +16 -0
  106. package/dist/api/types/PromptDeploymentInputRequest.js +5 -0
  107. package/dist/api/types/RejectedExecutePromptResponse.d.ts +9 -0
  108. package/dist/api/types/RejectedExecutePromptResponse.js +5 -0
  109. package/dist/api/types/RejectedExecutePromptStreamingResponse.d.ts +7 -0
  110. package/dist/api/types/RejectedExecutePromptStreamingResponse.js +5 -0
  111. package/dist/api/types/StreamingExecutePromptStreamingResponse.d.ts +7 -0
  112. package/dist/api/types/StreamingExecutePromptStreamingResponse.js +5 -0
  113. package/dist/api/types/StringExecutePromptResponse.d.ts +7 -0
  114. package/dist/api/types/StringExecutePromptResponse.js +5 -0
  115. package/dist/api/types/StringInputRequest.d.ts +8 -0
  116. package/dist/api/types/StringInputRequest.js +5 -0
  117. package/dist/api/types/index.d.ts +18 -0
  118. package/dist/api/types/index.js +18 -0
  119. package/dist/serialization/resources/deployments/client/index.d.ts +1 -0
  120. package/dist/serialization/resources/deployments/client/index.js +17 -0
  121. package/dist/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +14 -0
  122. package/dist/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.js +44 -0
  123. package/dist/serialization/resources/deployments/client/requests/index.d.ts +1 -0
  124. package/dist/serialization/resources/deployments/client/requests/index.js +5 -0
  125. package/dist/serialization/resources/deployments/index.d.ts +1 -0
  126. package/dist/serialization/resources/deployments/index.js +17 -0
  127. package/dist/serialization/resources/index.d.ts +2 -0
  128. package/dist/serialization/resources/index.js +3 -1
  129. package/dist/serialization/types/ChatHistoryInputRequest.d.ts +13 -0
  130. package/dist/serialization/types/ChatHistoryInputRequest.js +43 -0
  131. package/dist/serialization/types/DeploymentProviderPayloadResponse.d.ts +12 -0
  132. package/dist/serialization/types/DeploymentProviderPayloadResponse.js +33 -0
  133. package/dist/serialization/types/ErrorExecutePromptResponse.d.ts +13 -0
  134. package/dist/serialization/types/ErrorExecutePromptResponse.js +43 -0
  135. package/dist/serialization/types/ExecutePromptApiErrorResponse.d.ts +12 -0
  136. package/dist/serialization/types/ExecutePromptApiErrorResponse.js +33 -0
  137. package/dist/serialization/types/ExecutePromptRequest.d.ts +16 -0
  138. package/dist/serialization/types/ExecutePromptRequest.js +46 -0
  139. package/dist/serialization/types/ExecutePromptResponse.d.ts +19 -0
  140. package/dist/serialization/types/ExecutePromptResponse.js +49 -0
  141. package/dist/serialization/types/ExecutePromptStreamingResponse.d.ts +22 -0
  142. package/dist/serialization/types/ExecutePromptStreamingResponse.js +50 -0
  143. package/dist/serialization/types/FulfilledExecutePromptStreamingResponse.d.ts +12 -0
  144. package/dist/serialization/types/FulfilledExecutePromptStreamingResponse.js +42 -0
  145. package/dist/serialization/types/InitiatedExecutePromptResponse.d.ts +13 -0
  146. package/dist/serialization/types/InitiatedExecutePromptResponse.js +43 -0
  147. package/dist/serialization/types/InitiatedExecutePromptStreamingResponse.d.ts +12 -0
  148. package/dist/serialization/types/InitiatedExecutePromptStreamingResponse.js +42 -0
  149. package/dist/serialization/types/JsonExecutePromptResponse.d.ts +13 -0
  150. package/dist/serialization/types/JsonExecutePromptResponse.js +34 -0
  151. package/dist/serialization/types/JsonInputRequest.d.ts +13 -0
  152. package/dist/serialization/types/JsonInputRequest.js +34 -0
  153. package/dist/serialization/types/PromptDeploymentInputRequest.d.ts +19 -0
  154. package/dist/serialization/types/PromptDeploymentInputRequest.js +49 -0
  155. package/dist/serialization/types/RejectedExecutePromptResponse.d.ts +14 -0
  156. package/dist/serialization/types/RejectedExecutePromptResponse.js +44 -0
  157. package/dist/serialization/types/RejectedExecutePromptStreamingResponse.d.ts +12 -0
  158. package/dist/serialization/types/RejectedExecutePromptStreamingResponse.js +42 -0
  159. package/dist/serialization/types/StreamingExecutePromptStreamingResponse.d.ts +12 -0
  160. package/dist/serialization/types/StreamingExecutePromptStreamingResponse.js +42 -0
  161. package/dist/serialization/types/StringExecutePromptResponse.d.ts +13 -0
  162. package/dist/serialization/types/StringExecutePromptResponse.js +34 -0
  163. package/dist/serialization/types/StringInputRequest.d.ts +13 -0
  164. package/dist/serialization/types/StringInputRequest.js +34 -0
  165. package/dist/serialization/types/index.d.ts +18 -0
  166. package/dist/serialization/types/index.js +18 -0
  167. package/package.json +1 -1
  168. package/serialization/resources/deployments/client/index.d.ts +1 -0
  169. package/serialization/resources/deployments/client/index.js +17 -0
  170. package/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +14 -0
  171. package/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.js +44 -0
  172. package/serialization/resources/deployments/client/requests/index.d.ts +1 -0
  173. package/serialization/resources/deployments/client/requests/index.js +5 -0
  174. package/serialization/resources/deployments/index.d.ts +1 -0
  175. package/serialization/resources/deployments/index.js +17 -0
  176. package/serialization/resources/index.d.ts +2 -0
  177. package/serialization/resources/index.js +3 -1
  178. package/serialization/types/ChatHistoryInputRequest.d.ts +13 -0
  179. package/serialization/types/ChatHistoryInputRequest.js +43 -0
  180. package/serialization/types/DeploymentProviderPayloadResponse.d.ts +12 -0
  181. package/serialization/types/DeploymentProviderPayloadResponse.js +33 -0
  182. package/serialization/types/ErrorExecutePromptResponse.d.ts +13 -0
  183. package/serialization/types/ErrorExecutePromptResponse.js +43 -0
  184. package/serialization/types/ExecutePromptApiErrorResponse.d.ts +12 -0
  185. package/serialization/types/ExecutePromptApiErrorResponse.js +33 -0
  186. package/serialization/types/ExecutePromptRequest.d.ts +16 -0
  187. package/serialization/types/ExecutePromptRequest.js +46 -0
  188. package/serialization/types/ExecutePromptResponse.d.ts +19 -0
  189. package/serialization/types/ExecutePromptResponse.js +49 -0
  190. package/serialization/types/ExecutePromptStreamingResponse.d.ts +22 -0
  191. package/serialization/types/ExecutePromptStreamingResponse.js +50 -0
  192. package/serialization/types/FulfilledExecutePromptStreamingResponse.d.ts +12 -0
  193. package/serialization/types/FulfilledExecutePromptStreamingResponse.js +42 -0
  194. package/serialization/types/InitiatedExecutePromptResponse.d.ts +13 -0
  195. package/serialization/types/InitiatedExecutePromptResponse.js +43 -0
  196. package/serialization/types/InitiatedExecutePromptStreamingResponse.d.ts +12 -0
  197. package/serialization/types/InitiatedExecutePromptStreamingResponse.js +42 -0
  198. package/serialization/types/JsonExecutePromptResponse.d.ts +13 -0
  199. package/serialization/types/JsonExecutePromptResponse.js +34 -0
  200. package/serialization/types/JsonInputRequest.d.ts +13 -0
  201. package/serialization/types/JsonInputRequest.js +34 -0
  202. package/serialization/types/PromptDeploymentInputRequest.d.ts +19 -0
  203. package/serialization/types/PromptDeploymentInputRequest.js +49 -0
  204. package/serialization/types/RejectedExecutePromptResponse.d.ts +14 -0
  205. package/serialization/types/RejectedExecutePromptResponse.js +44 -0
  206. package/serialization/types/RejectedExecutePromptStreamingResponse.d.ts +12 -0
  207. package/serialization/types/RejectedExecutePromptStreamingResponse.js +42 -0
  208. package/serialization/types/StreamingExecutePromptStreamingResponse.d.ts +12 -0
  209. package/serialization/types/StreamingExecutePromptStreamingResponse.js +42 -0
  210. package/serialization/types/StringExecutePromptResponse.d.ts +13 -0
  211. package/serialization/types/StringExecutePromptResponse.js +34 -0
  212. package/serialization/types/StringInputRequest.d.ts +13 -0
  213. package/serialization/types/StringInputRequest.js +34 -0
  214. package/serialization/types/index.d.ts +18 -0
  215. package/serialization/types/index.js +18 -0
package/Client.d.ts CHANGED
@@ -24,6 +24,22 @@ export declare namespace VellumClient {
24
24
  export declare class VellumClient {
25
25
  protected readonly _options: VellumClient.Options;
26
26
  constructor(_options: VellumClient.Options);
27
+ /**
28
+ * Executes a deployed Prompt and returns the result.
29
+ * @throws {@link Vellum.BadRequestError}
30
+ * @throws {@link Vellum.ForbiddenError}
31
+ * @throws {@link Vellum.NotFoundError}
32
+ * @throws {@link Vellum.InternalServerError}
33
+ */
34
+ executePrompt(request: Vellum.ExecutePromptRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.ExecutePromptResponse>;
35
+ /**
36
+ * Executes a deployed Prompt and streams back the results.
37
+ * @throws {@link Vellum.BadRequestError}
38
+ * @throws {@link Vellum.ForbiddenError}
39
+ * @throws {@link Vellum.NotFoundError}
40
+ * @throws {@link Vellum.InternalServerError}
41
+ */
42
+ executePromptStream(request: Vellum.ExecutePromptRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.ExecutePromptStreamingResponse>;
27
43
  /**
28
44
  * Executes a deployed Workflow and streams back its results.
29
45
  */
package/Client.js CHANGED
@@ -56,6 +56,136 @@ class VellumClient {
56
56
  constructor(_options) {
57
57
  this._options = _options;
58
58
  }
59
+ /**
60
+ * Executes a deployed Prompt and returns the result.
61
+ * @throws {@link Vellum.BadRequestError}
62
+ * @throws {@link Vellum.ForbiddenError}
63
+ * @throws {@link Vellum.NotFoundError}
64
+ * @throws {@link Vellum.InternalServerError}
65
+ */
66
+ executePrompt(request, requestOptions) {
67
+ var _a;
68
+ return __awaiter(this, void 0, void 0, function* () {
69
+ const _response = yield core.fetcher({
70
+ url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
71
+ .default, "v1/execute-prompt"),
72
+ method: "POST",
73
+ headers: {
74
+ X_API_KEY: yield core.Supplier.get(this._options.apiKey),
75
+ "X-Fern-Language": "JavaScript",
76
+ "X-Fern-SDK-Name": "vellum-ai",
77
+ "X-Fern-SDK-Version": "0.1.6",
78
+ },
79
+ contentType: "application/json",
80
+ body: yield serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
81
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
82
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
83
+ });
84
+ if (_response.ok) {
85
+ return yield serializers.ExecutePromptResponse.parseOrThrow(_response.body, {
86
+ unrecognizedObjectKeys: "passthrough",
87
+ allowUnrecognizedUnionMembers: true,
88
+ allowUnrecognizedEnumValues: true,
89
+ breadcrumbsPrefix: ["response"],
90
+ });
91
+ }
92
+ if (_response.error.reason === "status-code") {
93
+ switch (_response.error.statusCode) {
94
+ case 400:
95
+ throw new Vellum.BadRequestError(_response.error.body);
96
+ case 403:
97
+ throw new Vellum.ForbiddenError(_response.error.body);
98
+ case 404:
99
+ throw new Vellum.NotFoundError(_response.error.body);
100
+ case 500:
101
+ throw new Vellum.InternalServerError(_response.error.body);
102
+ default:
103
+ throw new errors.VellumError({
104
+ statusCode: _response.error.statusCode,
105
+ body: _response.error.body,
106
+ });
107
+ }
108
+ }
109
+ switch (_response.error.reason) {
110
+ case "non-json":
111
+ throw new errors.VellumError({
112
+ statusCode: _response.error.statusCode,
113
+ body: _response.error.rawBody,
114
+ });
115
+ case "timeout":
116
+ throw new errors.VellumTimeoutError();
117
+ case "unknown":
118
+ throw new errors.VellumError({
119
+ message: _response.error.errorMessage,
120
+ });
121
+ }
122
+ });
123
+ }
124
+ /**
125
+ * Executes a deployed Prompt and streams back the results.
126
+ * @throws {@link Vellum.BadRequestError}
127
+ * @throws {@link Vellum.ForbiddenError}
128
+ * @throws {@link Vellum.NotFoundError}
129
+ * @throws {@link Vellum.InternalServerError}
130
+ */
131
+ executePromptStream(request, requestOptions) {
132
+ var _a;
133
+ return __awaiter(this, void 0, void 0, function* () {
134
+ const _response = yield core.fetcher({
135
+ url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
136
+ .default, "v1/execute-prompt-stream"),
137
+ method: "POST",
138
+ headers: {
139
+ X_API_KEY: yield core.Supplier.get(this._options.apiKey),
140
+ "X-Fern-Language": "JavaScript",
141
+ "X-Fern-SDK-Name": "vellum-ai",
142
+ "X-Fern-SDK-Version": "0.1.6",
143
+ },
144
+ contentType: "application/json",
145
+ body: yield serializers.ExecutePromptRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
146
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
147
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
148
+ });
149
+ if (_response.ok) {
150
+ return yield serializers.ExecutePromptStreamingResponse.parseOrThrow(_response.body, {
151
+ unrecognizedObjectKeys: "passthrough",
152
+ allowUnrecognizedUnionMembers: true,
153
+ allowUnrecognizedEnumValues: true,
154
+ breadcrumbsPrefix: ["response"],
155
+ });
156
+ }
157
+ if (_response.error.reason === "status-code") {
158
+ switch (_response.error.statusCode) {
159
+ case 400:
160
+ throw new Vellum.BadRequestError(_response.error.body);
161
+ case 403:
162
+ throw new Vellum.ForbiddenError(_response.error.body);
163
+ case 404:
164
+ throw new Vellum.NotFoundError(_response.error.body);
165
+ case 500:
166
+ throw new Vellum.InternalServerError(_response.error.body);
167
+ default:
168
+ throw new errors.VellumError({
169
+ statusCode: _response.error.statusCode,
170
+ body: _response.error.body,
171
+ });
172
+ }
173
+ }
174
+ switch (_response.error.reason) {
175
+ case "non-json":
176
+ throw new errors.VellumError({
177
+ statusCode: _response.error.statusCode,
178
+ body: _response.error.rawBody,
179
+ });
180
+ case "timeout":
181
+ throw new errors.VellumTimeoutError();
182
+ case "unknown":
183
+ throw new errors.VellumError({
184
+ message: _response.error.errorMessage,
185
+ });
186
+ }
187
+ });
188
+ }
59
189
  /**
60
190
  * Executes a deployed Workflow and streams back its results.
61
191
  */
@@ -70,7 +200,7 @@ class VellumClient {
70
200
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
71
201
  "X-Fern-Language": "JavaScript",
72
202
  "X-Fern-SDK-Name": "vellum-ai",
73
- "X-Fern-SDK-Version": "v0.1.4",
203
+ "X-Fern-SDK-Version": "0.1.6",
74
204
  },
75
205
  body: yield serializers.ExecuteWorkflowStreamRequest.jsonOrThrow(request, {
76
206
  unrecognizedObjectKeys: "strip",
@@ -111,7 +241,7 @@ class VellumClient {
111
241
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
112
242
  "X-Fern-Language": "JavaScript",
113
243
  "X-Fern-SDK-Name": "vellum-ai",
114
- "X-Fern-SDK-Version": "v0.1.4",
244
+ "X-Fern-SDK-Version": "0.1.6",
115
245
  },
116
246
  contentType: "application/json",
117
247
  body: yield serializers.GenerateBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -131,12 +261,7 @@ class VellumClient {
131
261
  case 400:
132
262
  throw new Vellum.BadRequestError(_response.error.body);
133
263
  case 403:
134
- throw new Vellum.ForbiddenError(yield serializers.GenerateErrorResponse.parseOrThrow(_response.error.body, {
135
- unrecognizedObjectKeys: "passthrough",
136
- allowUnrecognizedUnionMembers: true,
137
- allowUnrecognizedEnumValues: true,
138
- breadcrumbsPrefix: ["response"],
139
- }));
264
+ throw new Vellum.ForbiddenError(_response.error.body);
140
265
  case 404:
141
266
  throw new Vellum.NotFoundError(_response.error.body);
142
267
  case 500:
@@ -179,7 +304,7 @@ class VellumClient {
179
304
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
180
305
  "X-Fern-Language": "JavaScript",
181
306
  "X-Fern-SDK-Name": "vellum-ai",
182
- "X-Fern-SDK-Version": "v0.1.4",
307
+ "X-Fern-SDK-Version": "0.1.6",
183
308
  },
184
309
  body: yield serializers.GenerateStreamBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
185
310
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -217,7 +342,7 @@ class VellumClient {
217
342
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
218
343
  "X-Fern-Language": "JavaScript",
219
344
  "X-Fern-SDK-Name": "vellum-ai",
220
- "X-Fern-SDK-Version": "v0.1.4",
345
+ "X-Fern-SDK-Version": "0.1.6",
221
346
  },
222
347
  contentType: "application/json",
223
348
  body: yield serializers.SearchRequestBodyRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -281,7 +406,7 @@ class VellumClient {
281
406
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
282
407
  "X-Fern-Language": "JavaScript",
283
408
  "X-Fern-SDK-Name": "vellum-ai",
284
- "X-Fern-SDK-Version": "v0.1.4",
409
+ "X-Fern-SDK-Version": "0.1.6",
285
410
  },
286
411
  contentType: "application/json",
287
412
  body: yield serializers.SubmitCompletionActualsRequest.jsonOrThrow(request, {
@@ -339,7 +464,7 @@ class VellumClient {
339
464
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
340
465
  "X-Fern-Language": "JavaScript",
341
466
  "X-Fern-SDK-Name": "vellum-ai",
342
- "X-Fern-SDK-Version": "v0.1.4",
467
+ "X-Fern-SDK-Version": "0.1.6",
343
468
  },
344
469
  contentType: "application/json",
345
470
  body: yield serializers.SubmitWorkflowExecutionActualsRequest.jsonOrThrow(request, {
@@ -2,7 +2,6 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors";
5
- import * as Vellum from "..";
6
5
  export declare class ForbiddenError extends errors.VellumError {
7
- constructor(body: Vellum.GenerateErrorResponse);
6
+ constructor(body?: unknown);
8
7
  }
@@ -21,4 +21,5 @@ export declare class Deployments {
21
21
  * Used to retrieve a deployment given its ID or name.
22
22
  */
23
23
  retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
24
+ retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentProviderPayloadResponse>;
24
25
  }
@@ -62,7 +62,7 @@ class Deployments {
62
62
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
63
63
  "X-Fern-Language": "JavaScript",
64
64
  "X-Fern-SDK-Name": "vellum-ai",
65
- "X-Fern-SDK-Version": "v0.1.4",
65
+ "X-Fern-SDK-Version": "0.1.6",
66
66
  },
67
67
  contentType: "application/json",
68
68
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -97,5 +97,54 @@ class Deployments {
97
97
  }
98
98
  });
99
99
  }
100
+ retrieveProviderPayload(request, requestOptions) {
101
+ var _a;
102
+ return __awaiter(this, void 0, void 0, function* () {
103
+ const _response = yield core.fetcher({
104
+ url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
105
+ .default, "v1/deployments/provider-payload"),
106
+ method: "POST",
107
+ headers: {
108
+ X_API_KEY: yield core.Supplier.get(this._options.apiKey),
109
+ "X-Fern-Language": "JavaScript",
110
+ "X-Fern-SDK-Name": "vellum-ai",
111
+ "X-Fern-SDK-Version": "0.1.6",
112
+ },
113
+ contentType: "application/json",
114
+ body: yield serializers.DeploymentProviderPayloadRequest.jsonOrThrow(request, {
115
+ unrecognizedObjectKeys: "strip",
116
+ }),
117
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
118
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
119
+ });
120
+ if (_response.ok) {
121
+ return yield serializers.DeploymentProviderPayloadResponse.parseOrThrow(_response.body, {
122
+ unrecognizedObjectKeys: "passthrough",
123
+ allowUnrecognizedUnionMembers: true,
124
+ allowUnrecognizedEnumValues: true,
125
+ breadcrumbsPrefix: ["response"],
126
+ });
127
+ }
128
+ if (_response.error.reason === "status-code") {
129
+ throw new errors.VellumError({
130
+ statusCode: _response.error.statusCode,
131
+ body: _response.error.body,
132
+ });
133
+ }
134
+ switch (_response.error.reason) {
135
+ case "non-json":
136
+ throw new errors.VellumError({
137
+ statusCode: _response.error.statusCode,
138
+ body: _response.error.rawBody,
139
+ });
140
+ case "timeout":
141
+ throw new errors.VellumTimeoutError();
142
+ case "unknown":
143
+ throw new errors.VellumError({
144
+ message: _response.error.errorMessage,
145
+ });
146
+ }
147
+ });
148
+ }
100
149
  }
101
150
  exports.Deployments = Deployments;
@@ -1 +1 @@
1
- export {};
1
+ export * from "./requests";
@@ -1,2 +1,17 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./requests"), exports);
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../../../..";
5
+ export interface DeploymentProviderPayloadRequest {
6
+ /** The ID of the deployment. Must provide either this or deployment_name. */
7
+ deploymentId?: string;
8
+ /** The name of the deployment. Must provide either this or deployment_id. */
9
+ deploymentName?: string;
10
+ inputs: Vellum.PromptDeploymentInputRequest[];
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1 @@
1
+ export { DeploymentProviderPayloadRequest } from "./DeploymentProviderPayloadRequest";
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -62,7 +62,7 @@ class DocumentIndexes {
62
62
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
63
63
  "X-Fern-Language": "JavaScript",
64
64
  "X-Fern-SDK-Name": "vellum-ai",
65
- "X-Fern-SDK-Version": "v0.1.4",
65
+ "X-Fern-SDK-Version": "0.1.6",
66
66
  },
67
67
  contentType: "application/json",
68
68
  body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
@@ -114,7 +114,7 @@ class DocumentIndexes {
114
114
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
115
115
  "X-Fern-Language": "JavaScript",
116
116
  "X-Fern-SDK-Name": "vellum-ai",
117
- "X-Fern-SDK-Version": "v0.1.4",
117
+ "X-Fern-SDK-Version": "0.1.6",
118
118
  },
119
119
  contentType: "application/json",
120
120
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -78,7 +78,7 @@ class Documents {
78
78
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
79
79
  "X-Fern-Language": "JavaScript",
80
80
  "X-Fern-SDK-Name": "vellum-ai",
81
- "X-Fern-SDK-Version": "v0.1.4",
81
+ "X-Fern-SDK-Version": "0.1.6",
82
82
  },
83
83
  contentType: "application/json",
84
84
  queryParameters: _queryParams,
@@ -125,7 +125,7 @@ class Documents {
125
125
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
126
126
  "X-Fern-Language": "JavaScript",
127
127
  "X-Fern-SDK-Name": "vellum-ai",
128
- "X-Fern-SDK-Version": "v0.1.4",
128
+ "X-Fern-SDK-Version": "0.1.6",
129
129
  },
130
130
  contentType: "application/json",
131
131
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -169,7 +169,7 @@ class Documents {
169
169
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
170
170
  "X-Fern-Language": "JavaScript",
171
171
  "X-Fern-SDK-Name": "vellum-ai",
172
- "X-Fern-SDK-Version": "v0.1.4",
172
+ "X-Fern-SDK-Version": "0.1.6",
173
173
  },
174
174
  contentType: "application/json",
175
175
  body: yield serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, {
@@ -245,7 +245,7 @@ class Documents {
245
245
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
246
246
  "X-Fern-Language": "JavaScript",
247
247
  "X-Fern-SDK-Name": "vellum-ai",
248
- "X-Fern-SDK-Version": "v0.1.4",
248
+ "X-Fern-SDK-Version": "0.1.6",
249
249
  "Content-Length": (yield core.getFormDataContentLength(_request)).toString(),
250
250
  },
251
251
  contentType: "multipart/form-data; boundary=" + _request.getBoundary(),
@@ -5,6 +5,7 @@ export * as modelVersions from "./modelVersions";
5
5
  export * as registeredPrompts from "./registeredPrompts";
6
6
  export * as sandboxes from "./sandboxes";
7
7
  export * as testSuites from "./testSuites";
8
+ export * from "./deployments/client/requests";
8
9
  export * from "./documentIndexes/client/requests";
9
10
  export * from "./documents/client/requests";
10
11
  export * from "./registeredPrompts/client/requests";
@@ -34,6 +34,7 @@ exports.modelVersions = __importStar(require("./modelVersions"));
34
34
  exports.registeredPrompts = __importStar(require("./registeredPrompts"));
35
35
  exports.sandboxes = __importStar(require("./sandboxes"));
36
36
  exports.testSuites = __importStar(require("./testSuites"));
37
+ __exportStar(require("./deployments/client/requests"), exports);
37
38
  __exportStar(require("./documentIndexes/client/requests"), exports);
38
39
  __exportStar(require("./documents/client/requests"), exports);
39
40
  __exportStar(require("./registeredPrompts/client/requests"), exports);
@@ -18,7 +18,7 @@ export declare class ModelVersions {
18
18
  protected readonly _options: ModelVersions.Options;
19
19
  constructor(_options: ModelVersions.Options);
20
20
  /**
21
- * Used to retrieve a model version given its ID.
21
+ * Deprecated. Use the `deployments/provider-payload` endpoint to fetch information that we send to Model providers.
22
22
  */
23
23
  retrieve(id: string, requestOptions?: ModelVersions.RequestOptions): Promise<Vellum.ModelVersionRead>;
24
24
  }
@@ -49,7 +49,7 @@ class ModelVersions {
49
49
  this._options = _options;
50
50
  }
51
51
  /**
52
- * Used to retrieve a model version given its ID.
52
+ * Deprecated. Use the `deployments/provider-payload` endpoint to fetch information that we send to Model providers.
53
53
  */
54
54
  retrieve(id, requestOptions) {
55
55
  var _a;
@@ -62,7 +62,7 @@ class ModelVersions {
62
62
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
63
63
  "X-Fern-Language": "JavaScript",
64
64
  "X-Fern-SDK-Name": "vellum-ai",
65
- "X-Fern-SDK-Version": "v0.1.4",
65
+ "X-Fern-SDK-Version": "0.1.6",
66
66
  },
67
67
  contentType: "application/json",
68
68
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -69,7 +69,7 @@ class RegisteredPrompts {
69
69
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
70
70
  "X-Fern-Language": "JavaScript",
71
71
  "X-Fern-SDK-Name": "vellum-ai",
72
- "X-Fern-SDK-Version": "v0.1.4",
72
+ "X-Fern-SDK-Version": "0.1.6",
73
73
  },
74
74
  contentType: "application/json",
75
75
  body: yield serializers.RegisterPromptRequestRequest.jsonOrThrow(request, {
@@ -68,7 +68,7 @@ class Sandboxes {
68
68
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
69
69
  "X-Fern-Language": "JavaScript",
70
70
  "X-Fern-SDK-Name": "vellum-ai",
71
- "X-Fern-SDK-Version": "v0.1.4",
71
+ "X-Fern-SDK-Version": "0.1.6",
72
72
  },
73
73
  contentType: "application/json",
74
74
  body: yield serializers.UpsertSandboxScenarioRequestRequest.jsonOrThrow(request, {
@@ -120,7 +120,7 @@ class Sandboxes {
120
120
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
121
121
  "X-Fern-Language": "JavaScript",
122
122
  "X-Fern-SDK-Name": "vellum-ai",
123
- "X-Fern-SDK-Version": "v0.1.4",
123
+ "X-Fern-SDK-Version": "0.1.6",
124
124
  },
125
125
  contentType: "application/json",
126
126
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -68,7 +68,7 @@ class TestSuites {
68
68
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
69
69
  "X-Fern-Language": "JavaScript",
70
70
  "X-Fern-SDK-Name": "vellum-ai",
71
- "X-Fern-SDK-Version": "v0.1.4",
71
+ "X-Fern-SDK-Version": "0.1.6",
72
72
  },
73
73
  contentType: "application/json",
74
74
  body: yield serializers.TestSuiteTestCaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -119,7 +119,7 @@ class TestSuites {
119
119
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
120
120
  "X-Fern-Language": "JavaScript",
121
121
  "X-Fern-SDK-Name": "vellum-ai",
122
- "X-Fern-SDK-Version": "v0.1.4",
122
+ "X-Fern-SDK-Version": "0.1.6",
123
123
  },
124
124
  contentType: "application/json",
125
125
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface ChatHistoryInputRequest {
6
+ /** The variable's name, as defined in the deployment. */
7
+ name: string;
8
+ value: Vellum.ChatMessageRequest[];
9
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface DeploymentProviderPayloadResponse {
5
+ payload: Record<string, unknown>;
6
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -25,6 +25,7 @@ export interface DeploymentRead {
25
25
  * * `PRODUCTION` - Production
26
26
  */
27
27
  environment?: Vellum.EnvironmentEnum;
28
+ /** Deprecated. The Prompt execution endpoints return a `prompt_version_id` that could be used instead. */
28
29
  activeModelVersionIds: string[];
29
30
  lastDeployedOn: Date;
30
31
  inputVariables: Vellum.VellumVariable[];
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface ErrorExecutePromptResponse {
6
+ executionId: string;
7
+ value: Vellum.VellumError;
8
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface ExecutePromptApiErrorResponse {
5
+ /** Details about why the request failed. */
6
+ detail: string;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface ExecutePromptRequest {
6
+ inputs: Vellum.PromptDeploymentInputRequest[];
7
+ /** The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name. */
8
+ promptDeploymentId?: string;
9
+ /** The name of the Prompt Deployment. Must provide either this or prompt_deployment_id. */
10
+ promptDeploymentName?: string;
11
+ /** Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment */
12
+ releaseTag?: string;
13
+ externalId?: string;
14
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,16 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export declare type ExecutePromptResponse = Vellum.ExecutePromptResponse.Error_ | Vellum.ExecutePromptResponse.Json | Vellum.ExecutePromptResponse.String;
6
+ export declare namespace ExecutePromptResponse {
7
+ interface Error_ extends Vellum.ErrorExecutePromptResponse {
8
+ type: "ERROR";
9
+ }
10
+ interface Json extends Vellum.JsonExecutePromptResponse {
11
+ type: "JSON";
12
+ }
13
+ interface String extends Vellum.StringExecutePromptResponse {
14
+ type: "STRING";
15
+ }
16
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });