vellum-ai 0.3.9 → 0.3.11

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 (201) hide show
  1. package/Client.js +9 -9
  2. package/api/client/requests/ExecuteWorkflowRequest.d.ts +3 -3
  3. package/api/client/requests/ExecuteWorkflowStreamRequest.d.ts +2 -2
  4. package/api/resources/deployments/client/Client.d.ts +11 -0
  5. package/api/resources/deployments/client/Client.js +30 -7
  6. package/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +2 -0
  7. package/api/resources/documentIndexes/client/Client.d.ts +7 -0
  8. package/api/resources/documentIndexes/client/Client.js +72 -3
  9. package/api/resources/documentIndexes/client/requests/DocumentIndexesListRequest.d.ts +29 -0
  10. package/api/resources/documentIndexes/client/requests/DocumentIndexesListRequest.js +5 -0
  11. package/api/resources/documentIndexes/client/requests/index.d.ts +1 -0
  12. package/api/resources/documentIndexes/index.d.ts +1 -0
  13. package/api/resources/documentIndexes/index.js +1 -0
  14. package/api/resources/documentIndexes/types/DocumentIndexesListRequestStatus.d.ts +8 -0
  15. package/api/resources/documentIndexes/types/DocumentIndexesListRequestStatus.js +10 -0
  16. package/api/resources/documentIndexes/types/index.d.ts +1 -0
  17. package/api/resources/documentIndexes/types/index.js +17 -0
  18. package/api/resources/documents/client/Client.js +4 -4
  19. package/api/resources/folderEntities/client/Client.js +1 -1
  20. package/api/resources/index.d.ts +2 -1
  21. package/api/resources/index.js +3 -2
  22. package/api/resources/modelVersions/client/Client.js +1 -1
  23. package/api/resources/registeredPrompts/client/Client.js +1 -1
  24. package/api/resources/sandboxes/client/Client.js +2 -2
  25. package/api/resources/testSuites/client/Client.js +2 -2
  26. package/api/resources/workflowDeployments/client/Client.js +2 -2
  27. package/api/types/ChatMessage.d.ts +2 -0
  28. package/api/types/ChatMessageRequest.d.ts +2 -0
  29. package/api/types/ExecutionArrayVellumValue.d.ts +10 -0
  30. package/api/types/ExecutionArrayVellumValue.js +5 -0
  31. package/api/types/ExecutionChatHistoryVellumValue.d.ts +10 -0
  32. package/api/types/ExecutionChatHistoryVellumValue.js +5 -0
  33. package/api/types/ExecutionErrorVellumValue.d.ts +10 -0
  34. package/api/types/ExecutionErrorVellumValue.js +5 -0
  35. package/api/types/ExecutionFunctionCallVellumValue.d.ts +10 -0
  36. package/api/types/ExecutionFunctionCallVellumValue.js +5 -0
  37. package/api/types/ExecutionJsonVellumValue.d.ts +9 -0
  38. package/api/types/ExecutionJsonVellumValue.js +5 -0
  39. package/api/types/ExecutionNumberVellumValue.d.ts +9 -0
  40. package/api/types/ExecutionNumberVellumValue.js +5 -0
  41. package/api/types/ExecutionSearchResultsVellumValue.d.ts +10 -0
  42. package/api/types/ExecutionSearchResultsVellumValue.js +5 -0
  43. package/api/types/ExecutionStringVellumValue.d.ts +9 -0
  44. package/api/types/ExecutionStringVellumValue.js +5 -0
  45. package/api/types/ExecutionVellumValue.d.ts +31 -0
  46. package/api/types/ExecutionVellumValue.js +5 -0
  47. package/api/types/PaginatedDocumentIndexReadList.d.ts +10 -0
  48. package/api/types/PaginatedDocumentIndexReadList.js +5 -0
  49. package/api/types/PromptTemplateBlockProperties.d.ts +1 -0
  50. package/api/types/PromptTemplateBlockPropertiesRequest.d.ts +1 -0
  51. package/api/types/WorkflowExecutionEventType.d.ts +2 -2
  52. package/api/types/WorkflowResultEvent.d.ts +1 -0
  53. package/api/types/index.d.ts +10 -0
  54. package/api/types/index.js +10 -0
  55. package/dist/Client.js +9 -9
  56. package/dist/api/client/requests/ExecuteWorkflowRequest.d.ts +3 -3
  57. package/dist/api/client/requests/ExecuteWorkflowStreamRequest.d.ts +2 -2
  58. package/dist/api/resources/deployments/client/Client.d.ts +11 -0
  59. package/dist/api/resources/deployments/client/Client.js +30 -7
  60. package/dist/api/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +2 -0
  61. package/dist/api/resources/documentIndexes/client/Client.d.ts +7 -0
  62. package/dist/api/resources/documentIndexes/client/Client.js +72 -3
  63. package/dist/api/resources/documentIndexes/client/requests/DocumentIndexesListRequest.d.ts +29 -0
  64. package/dist/api/resources/documentIndexes/client/requests/DocumentIndexesListRequest.js +5 -0
  65. package/dist/api/resources/documentIndexes/client/requests/index.d.ts +1 -0
  66. package/dist/api/resources/documentIndexes/index.d.ts +1 -0
  67. package/dist/api/resources/documentIndexes/index.js +1 -0
  68. package/dist/api/resources/documentIndexes/types/DocumentIndexesListRequestStatus.d.ts +8 -0
  69. package/dist/api/resources/documentIndexes/types/DocumentIndexesListRequestStatus.js +10 -0
  70. package/dist/api/resources/documentIndexes/types/index.d.ts +1 -0
  71. package/dist/api/resources/documentIndexes/types/index.js +17 -0
  72. package/dist/api/resources/documents/client/Client.js +4 -4
  73. package/dist/api/resources/folderEntities/client/Client.js +1 -1
  74. package/dist/api/resources/index.d.ts +2 -1
  75. package/dist/api/resources/index.js +3 -2
  76. package/dist/api/resources/modelVersions/client/Client.js +1 -1
  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/resources/workflowDeployments/client/Client.js +2 -2
  81. package/dist/api/types/ChatMessage.d.ts +2 -0
  82. package/dist/api/types/ChatMessageRequest.d.ts +2 -0
  83. package/dist/api/types/ExecutionArrayVellumValue.d.ts +10 -0
  84. package/dist/api/types/ExecutionArrayVellumValue.js +5 -0
  85. package/dist/api/types/ExecutionChatHistoryVellumValue.d.ts +10 -0
  86. package/dist/api/types/ExecutionChatHistoryVellumValue.js +5 -0
  87. package/dist/api/types/ExecutionErrorVellumValue.d.ts +10 -0
  88. package/dist/api/types/ExecutionErrorVellumValue.js +5 -0
  89. package/dist/api/types/ExecutionFunctionCallVellumValue.d.ts +10 -0
  90. package/dist/api/types/ExecutionFunctionCallVellumValue.js +5 -0
  91. package/dist/api/types/ExecutionJsonVellumValue.d.ts +9 -0
  92. package/dist/api/types/ExecutionJsonVellumValue.js +5 -0
  93. package/dist/api/types/ExecutionNumberVellumValue.d.ts +9 -0
  94. package/dist/api/types/ExecutionNumberVellumValue.js +5 -0
  95. package/dist/api/types/ExecutionSearchResultsVellumValue.d.ts +10 -0
  96. package/dist/api/types/ExecutionSearchResultsVellumValue.js +5 -0
  97. package/dist/api/types/ExecutionStringVellumValue.d.ts +9 -0
  98. package/dist/api/types/ExecutionStringVellumValue.js +5 -0
  99. package/dist/api/types/ExecutionVellumValue.d.ts +31 -0
  100. package/dist/api/types/ExecutionVellumValue.js +5 -0
  101. package/dist/api/types/PaginatedDocumentIndexReadList.d.ts +10 -0
  102. package/dist/api/types/PaginatedDocumentIndexReadList.js +5 -0
  103. package/dist/api/types/PromptTemplateBlockProperties.d.ts +1 -0
  104. package/dist/api/types/PromptTemplateBlockPropertiesRequest.d.ts +1 -0
  105. package/dist/api/types/WorkflowExecutionEventType.d.ts +2 -2
  106. package/dist/api/types/WorkflowResultEvent.d.ts +1 -0
  107. package/dist/api/types/index.d.ts +10 -0
  108. package/dist/api/types/index.js +10 -0
  109. package/dist/serialization/client/requests/ExecuteWorkflowRequest.d.ts +1 -1
  110. package/dist/serialization/client/requests/ExecuteWorkflowRequest.js +1 -1
  111. package/dist/serialization/client/requests/ExecuteWorkflowStreamRequest.d.ts +1 -1
  112. package/dist/serialization/client/requests/ExecuteWorkflowStreamRequest.js +1 -1
  113. package/dist/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +1 -0
  114. package/dist/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.js +1 -0
  115. package/dist/serialization/resources/documentIndexes/index.d.ts +1 -0
  116. package/dist/serialization/resources/documentIndexes/index.js +1 -0
  117. package/dist/serialization/resources/documentIndexes/types/DocumentIndexesListRequestStatus.d.ts +10 -0
  118. package/dist/serialization/resources/documentIndexes/types/DocumentIndexesListRequestStatus.js +31 -0
  119. package/dist/serialization/resources/documentIndexes/types/index.d.ts +1 -0
  120. package/dist/serialization/resources/documentIndexes/types/index.js +17 -0
  121. package/dist/serialization/resources/index.d.ts +2 -1
  122. package/dist/serialization/resources/index.js +3 -2
  123. package/dist/serialization/types/ChatMessage.d.ts +1 -0
  124. package/dist/serialization/types/ChatMessage.js +1 -0
  125. package/dist/serialization/types/ChatMessageRequest.d.ts +1 -0
  126. package/dist/serialization/types/ChatMessageRequest.js +1 -0
  127. package/dist/serialization/types/ExecutionArrayVellumValue.d.ts +14 -0
  128. package/dist/serialization/types/ExecutionArrayVellumValue.js +46 -0
  129. package/dist/serialization/types/ExecutionChatHistoryVellumValue.d.ts +14 -0
  130. package/dist/serialization/types/ExecutionChatHistoryVellumValue.js +46 -0
  131. package/dist/serialization/types/ExecutionErrorVellumValue.d.ts +14 -0
  132. package/dist/serialization/types/ExecutionErrorVellumValue.js +44 -0
  133. package/dist/serialization/types/ExecutionFunctionCallVellumValue.d.ts +14 -0
  134. package/dist/serialization/types/ExecutionFunctionCallVellumValue.js +44 -0
  135. package/dist/serialization/types/ExecutionJsonVellumValue.d.ts +14 -0
  136. package/dist/serialization/types/ExecutionJsonVellumValue.js +35 -0
  137. package/dist/serialization/types/ExecutionNumberVellumValue.d.ts +14 -0
  138. package/dist/serialization/types/ExecutionNumberVellumValue.js +35 -0
  139. package/dist/serialization/types/ExecutionSearchResultsVellumValue.d.ts +14 -0
  140. package/dist/serialization/types/ExecutionSearchResultsVellumValue.js +46 -0
  141. package/dist/serialization/types/ExecutionStringVellumValue.d.ts +14 -0
  142. package/dist/serialization/types/ExecutionStringVellumValue.js +35 -0
  143. package/dist/serialization/types/ExecutionVellumValue.d.ts +34 -0
  144. package/dist/serialization/types/ExecutionVellumValue.js +54 -0
  145. package/dist/serialization/types/PaginatedDocumentIndexReadList.d.ts +15 -0
  146. package/dist/serialization/types/PaginatedDocumentIndexReadList.js +47 -0
  147. package/dist/serialization/types/PromptTemplateBlockProperties.d.ts +1 -0
  148. package/dist/serialization/types/PromptTemplateBlockProperties.js +1 -0
  149. package/dist/serialization/types/PromptTemplateBlockPropertiesRequest.d.ts +1 -0
  150. package/dist/serialization/types/PromptTemplateBlockPropertiesRequest.js +1 -0
  151. package/dist/serialization/types/WorkflowResultEvent.d.ts +1 -0
  152. package/dist/serialization/types/WorkflowResultEvent.js +3 -0
  153. package/dist/serialization/types/index.d.ts +10 -0
  154. package/dist/serialization/types/index.js +10 -0
  155. package/package.json +1 -1
  156. package/serialization/client/requests/ExecuteWorkflowRequest.d.ts +1 -1
  157. package/serialization/client/requests/ExecuteWorkflowRequest.js +1 -1
  158. package/serialization/client/requests/ExecuteWorkflowStreamRequest.d.ts +1 -1
  159. package/serialization/client/requests/ExecuteWorkflowStreamRequest.js +1 -1
  160. package/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.d.ts +1 -0
  161. package/serialization/resources/deployments/client/requests/DeploymentProviderPayloadRequest.js +1 -0
  162. package/serialization/resources/documentIndexes/index.d.ts +1 -0
  163. package/serialization/resources/documentIndexes/index.js +1 -0
  164. package/serialization/resources/documentIndexes/types/DocumentIndexesListRequestStatus.d.ts +10 -0
  165. package/serialization/resources/documentIndexes/types/DocumentIndexesListRequestStatus.js +31 -0
  166. package/serialization/resources/documentIndexes/types/index.d.ts +1 -0
  167. package/serialization/resources/documentIndexes/types/index.js +17 -0
  168. package/serialization/resources/index.d.ts +2 -1
  169. package/serialization/resources/index.js +3 -2
  170. package/serialization/types/ChatMessage.d.ts +1 -0
  171. package/serialization/types/ChatMessage.js +1 -0
  172. package/serialization/types/ChatMessageRequest.d.ts +1 -0
  173. package/serialization/types/ChatMessageRequest.js +1 -0
  174. package/serialization/types/ExecutionArrayVellumValue.d.ts +14 -0
  175. package/serialization/types/ExecutionArrayVellumValue.js +46 -0
  176. package/serialization/types/ExecutionChatHistoryVellumValue.d.ts +14 -0
  177. package/serialization/types/ExecutionChatHistoryVellumValue.js +46 -0
  178. package/serialization/types/ExecutionErrorVellumValue.d.ts +14 -0
  179. package/serialization/types/ExecutionErrorVellumValue.js +44 -0
  180. package/serialization/types/ExecutionFunctionCallVellumValue.d.ts +14 -0
  181. package/serialization/types/ExecutionFunctionCallVellumValue.js +44 -0
  182. package/serialization/types/ExecutionJsonVellumValue.d.ts +14 -0
  183. package/serialization/types/ExecutionJsonVellumValue.js +35 -0
  184. package/serialization/types/ExecutionNumberVellumValue.d.ts +14 -0
  185. package/serialization/types/ExecutionNumberVellumValue.js +35 -0
  186. package/serialization/types/ExecutionSearchResultsVellumValue.d.ts +14 -0
  187. package/serialization/types/ExecutionSearchResultsVellumValue.js +46 -0
  188. package/serialization/types/ExecutionStringVellumValue.d.ts +14 -0
  189. package/serialization/types/ExecutionStringVellumValue.js +35 -0
  190. package/serialization/types/ExecutionVellumValue.d.ts +34 -0
  191. package/serialization/types/ExecutionVellumValue.js +54 -0
  192. package/serialization/types/PaginatedDocumentIndexReadList.d.ts +15 -0
  193. package/serialization/types/PaginatedDocumentIndexReadList.js +47 -0
  194. package/serialization/types/PromptTemplateBlockProperties.d.ts +1 -0
  195. package/serialization/types/PromptTemplateBlockProperties.js +1 -0
  196. package/serialization/types/PromptTemplateBlockPropertiesRequest.d.ts +1 -0
  197. package/serialization/types/PromptTemplateBlockPropertiesRequest.js +1 -0
  198. package/serialization/types/WorkflowResultEvent.d.ts +1 -0
  199. package/serialization/types/WorkflowResultEvent.js +3 -0
  200. package/serialization/types/index.d.ts +10 -0
  201. package/serialization/types/index.js +10 -0
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface ExecutionErrorVellumValue {
6
+ /** The variable's uniquely identifying internal id. */
7
+ id: string;
8
+ name: string;
9
+ value?: Vellum.VellumError;
10
+ }
@@ -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,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface ExecutionFunctionCallVellumValue {
6
+ /** The variable's uniquely identifying internal id. */
7
+ id: string;
8
+ name: string;
9
+ value?: Vellum.FunctionCall;
10
+ }
@@ -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,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface ExecutionJsonVellumValue {
5
+ /** The variable's uniquely identifying internal id. */
6
+ id: string;
7
+ name: string;
8
+ value?: Record<string, unknown>;
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,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface ExecutionNumberVellumValue {
5
+ /** The variable's uniquely identifying internal id. */
6
+ id: string;
7
+ name: string;
8
+ value?: number;
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,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface ExecutionSearchResultsVellumValue {
6
+ /** The variable's uniquely identifying internal id. */
7
+ id: string;
8
+ name: string;
9
+ value?: Vellum.SearchResult[];
10
+ }
@@ -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,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface ExecutionStringVellumValue {
5
+ /** The variable's uniquely identifying internal id. */
6
+ id: string;
7
+ name: string;
8
+ value?: string;
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,31 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export declare type ExecutionVellumValue = Vellum.ExecutionVellumValue.String | Vellum.ExecutionVellumValue.Number | Vellum.ExecutionVellumValue.Json | Vellum.ExecutionVellumValue.ChatHistory | Vellum.ExecutionVellumValue.SearchResults | Vellum.ExecutionVellumValue.Error_ | Vellum.ExecutionVellumValue.Array | Vellum.ExecutionVellumValue.FunctionCall;
6
+ export declare namespace ExecutionVellumValue {
7
+ interface String extends Vellum.ExecutionStringVellumValue {
8
+ type: "STRING";
9
+ }
10
+ interface Number extends Vellum.ExecutionNumberVellumValue {
11
+ type: "NUMBER";
12
+ }
13
+ interface Json extends Vellum.ExecutionJsonVellumValue {
14
+ type: "JSON";
15
+ }
16
+ interface ChatHistory extends Vellum.ExecutionChatHistoryVellumValue {
17
+ type: "CHAT_HISTORY";
18
+ }
19
+ interface SearchResults extends Vellum.ExecutionSearchResultsVellumValue {
20
+ type: "SEARCH_RESULTS";
21
+ }
22
+ interface Error_ extends Vellum.ExecutionErrorVellumValue {
23
+ type: "ERROR";
24
+ }
25
+ interface Array extends Vellum.ExecutionArrayVellumValue {
26
+ type: "ARRAY";
27
+ }
28
+ interface FunctionCall extends Vellum.ExecutionFunctionCallVellumValue {
29
+ type: "FUNCTION_CALL";
30
+ }
31
+ }
@@ -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,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "..";
5
+ export interface PaginatedDocumentIndexReadList {
6
+ count?: number;
7
+ next?: string;
8
+ previous?: string;
9
+ results?: Vellum.DocumentIndexRead[];
10
+ }
@@ -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 });
@@ -5,6 +5,7 @@ import * as Vellum from "..";
5
5
  export interface PromptTemplateBlockProperties {
6
6
  chatRole?: Vellum.ChatMessageRole;
7
7
  chatMessageUnterminated?: boolean;
8
+ chatSource?: string;
8
9
  template?: string;
9
10
  templateType?: Vellum.VellumVariableType;
10
11
  functionName?: string;
@@ -5,6 +5,7 @@ import * as Vellum from "..";
5
5
  export interface PromptTemplateBlockPropertiesRequest {
6
6
  chatRole?: Vellum.ChatMessageRole;
7
7
  chatMessageUnterminated?: boolean;
8
+ chatSource?: string;
8
9
  template?: string;
9
10
  templateType?: Vellum.VellumVariableType;
10
11
  functionName?: string;
@@ -2,8 +2,8 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * - `NODE` - Node
6
- * - `WORKFLOW` - Workflow
5
+ * - `NODE` - NODE
6
+ * - `WORKFLOW` - WORKFLOW
7
7
  */
8
8
  export declare type WorkflowExecutionEventType = "NODE" | "WORKFLOW";
9
9
  export declare const WorkflowExecutionEventType: {
@@ -9,4 +9,5 @@ export interface WorkflowResultEvent {
9
9
  output?: Vellum.WorkflowResultEventOutputData;
10
10
  error?: Vellum.WorkflowEventError;
11
11
  outputs?: Vellum.WorkflowOutput[];
12
+ inputs?: Vellum.ExecutionVellumValue[];
12
13
  }
@@ -44,6 +44,15 @@ export * from "./ExecuteWorkflowErrorResponse";
44
44
  export * from "./ExecuteWorkflowResponse";
45
45
  export * from "./ExecuteWorkflowStreamErrorResponse";
46
46
  export * from "./ExecuteWorkflowWorkflowResultEvent";
47
+ export * from "./ExecutionArrayVellumValue";
48
+ export * from "./ExecutionChatHistoryVellumValue";
49
+ export * from "./ExecutionErrorVellumValue";
50
+ export * from "./ExecutionFunctionCallVellumValue";
51
+ export * from "./ExecutionJsonVellumValue";
52
+ export * from "./ExecutionNumberVellumValue";
53
+ export * from "./ExecutionSearchResultsVellumValue";
54
+ export * from "./ExecutionStringVellumValue";
55
+ export * from "./ExecutionVellumValue";
47
56
  export * from "./FinishReasonEnum";
48
57
  export * from "./FulfilledEnum";
49
58
  export * from "./FulfilledExecutePromptEvent";
@@ -119,6 +128,7 @@ export * from "./NormalizedLogProbs";
119
128
  export * from "./NormalizedTokenLogProbs";
120
129
  export * from "./NumberEnum";
121
130
  export * from "./NumberVariableValue";
131
+ export * from "./PaginatedDocumentIndexReadList";
122
132
  export * from "./PaginatedSlimDeploymentReadList";
123
133
  export * from "./PaginatedSlimDocumentList";
124
134
  export * from "./PaginatedSlimWorkflowDeploymentList";
@@ -60,6 +60,15 @@ __exportStar(require("./ExecuteWorkflowErrorResponse"), exports);
60
60
  __exportStar(require("./ExecuteWorkflowResponse"), exports);
61
61
  __exportStar(require("./ExecuteWorkflowStreamErrorResponse"), exports);
62
62
  __exportStar(require("./ExecuteWorkflowWorkflowResultEvent"), exports);
63
+ __exportStar(require("./ExecutionArrayVellumValue"), exports);
64
+ __exportStar(require("./ExecutionChatHistoryVellumValue"), exports);
65
+ __exportStar(require("./ExecutionErrorVellumValue"), exports);
66
+ __exportStar(require("./ExecutionFunctionCallVellumValue"), exports);
67
+ __exportStar(require("./ExecutionJsonVellumValue"), exports);
68
+ __exportStar(require("./ExecutionNumberVellumValue"), exports);
69
+ __exportStar(require("./ExecutionSearchResultsVellumValue"), exports);
70
+ __exportStar(require("./ExecutionStringVellumValue"), exports);
71
+ __exportStar(require("./ExecutionVellumValue"), exports);
63
72
  __exportStar(require("./FinishReasonEnum"), exports);
64
73
  __exportStar(require("./FulfilledEnum"), exports);
65
74
  __exportStar(require("./FulfilledExecutePromptEvent"), exports);
@@ -135,6 +144,7 @@ __exportStar(require("./NormalizedLogProbs"), exports);
135
144
  __exportStar(require("./NormalizedTokenLogProbs"), exports);
136
145
  __exportStar(require("./NumberEnum"), exports);
137
146
  __exportStar(require("./NumberVariableValue"), exports);
147
+ __exportStar(require("./PaginatedDocumentIndexReadList"), exports);
138
148
  __exportStar(require("./PaginatedSlimDeploymentReadList"), exports);
139
149
  __exportStar(require("./PaginatedSlimDocumentList"), exports);
140
150
  __exportStar(require("./PaginatedSlimWorkflowDeploymentList"), exports);
package/dist/Client.js CHANGED
@@ -76,7 +76,7 @@ class VellumClient {
76
76
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
77
77
  "X-Fern-Language": "JavaScript",
78
78
  "X-Fern-SDK-Name": "vellum-ai",
79
- "X-Fern-SDK-Version": "0.3.9",
79
+ "X-Fern-SDK-Version": "0.3.11",
80
80
  "X-Fern-Runtime": core.RUNTIME.type,
81
81
  "X-Fern-Runtime-Version": core.RUNTIME.version,
82
82
  },
@@ -139,7 +139,7 @@ class VellumClient {
139
139
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
140
140
  "X-Fern-Language": "JavaScript",
141
141
  "X-Fern-SDK-Name": "vellum-ai",
142
- "X-Fern-SDK-Version": "0.3.9",
142
+ "X-Fern-SDK-Version": "0.3.11",
143
143
  "X-Fern-Runtime": core.RUNTIME.type,
144
144
  "X-Fern-Runtime-Version": core.RUNTIME.version,
145
145
  },
@@ -214,7 +214,7 @@ class VellumClient {
214
214
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
215
215
  "X-Fern-Language": "JavaScript",
216
216
  "X-Fern-SDK-Name": "vellum-ai",
217
- "X-Fern-SDK-Version": "0.3.9",
217
+ "X-Fern-SDK-Version": "0.3.11",
218
218
  "X-Fern-Runtime": core.RUNTIME.type,
219
219
  "X-Fern-Runtime-Version": core.RUNTIME.version,
220
220
  },
@@ -275,7 +275,7 @@ class VellumClient {
275
275
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
276
276
  "X-Fern-Language": "JavaScript",
277
277
  "X-Fern-SDK-Name": "vellum-ai",
278
- "X-Fern-SDK-Version": "0.3.9",
278
+ "X-Fern-SDK-Version": "0.3.11",
279
279
  "X-Fern-Runtime": core.RUNTIME.type,
280
280
  "X-Fern-Runtime-Version": core.RUNTIME.version,
281
281
  },
@@ -358,7 +358,7 @@ class VellumClient {
358
358
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
359
359
  "X-Fern-Language": "JavaScript",
360
360
  "X-Fern-SDK-Name": "vellum-ai",
361
- "X-Fern-SDK-Version": "0.3.9",
361
+ "X-Fern-SDK-Version": "0.3.11",
362
362
  "X-Fern-Runtime": core.RUNTIME.type,
363
363
  "X-Fern-Runtime-Version": core.RUNTIME.version,
364
364
  },
@@ -423,7 +423,7 @@ class VellumClient {
423
423
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
424
424
  "X-Fern-Language": "JavaScript",
425
425
  "X-Fern-SDK-Name": "vellum-ai",
426
- "X-Fern-SDK-Version": "0.3.9",
426
+ "X-Fern-SDK-Version": "0.3.11",
427
427
  "X-Fern-Runtime": core.RUNTIME.type,
428
428
  "X-Fern-Runtime-Version": core.RUNTIME.version,
429
429
  },
@@ -503,7 +503,7 @@ class VellumClient {
503
503
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
504
504
  "X-Fern-Language": "JavaScript",
505
505
  "X-Fern-SDK-Name": "vellum-ai",
506
- "X-Fern-SDK-Version": "0.3.9",
506
+ "X-Fern-SDK-Version": "0.3.11",
507
507
  "X-Fern-Runtime": core.RUNTIME.type,
508
508
  "X-Fern-Runtime-Version": core.RUNTIME.version,
509
509
  },
@@ -574,7 +574,7 @@ class VellumClient {
574
574
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
575
575
  "X-Fern-Language": "JavaScript",
576
576
  "X-Fern-SDK-Name": "vellum-ai",
577
- "X-Fern-SDK-Version": "0.3.9",
577
+ "X-Fern-SDK-Version": "0.3.11",
578
578
  "X-Fern-Runtime": core.RUNTIME.type,
579
579
  "X-Fern-Runtime-Version": core.RUNTIME.version,
580
580
  },
@@ -639,7 +639,7 @@ class VellumClient {
639
639
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
640
640
  "X-Fern-Language": "JavaScript",
641
641
  "X-Fern-SDK-Name": "vellum-ai",
642
- "X-Fern-SDK-Version": "0.3.9",
642
+ "X-Fern-SDK-Version": "0.3.11",
643
643
  "X-Fern-Runtime": core.RUNTIME.type,
644
644
  "X-Fern-Runtime-Version": core.RUNTIME.version,
645
645
  },
@@ -3,14 +3,14 @@
3
3
  */
4
4
  import * as Vellum from "../..";
5
5
  export interface ExecuteWorkflowRequest {
6
+ /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
7
+ inputs: Vellum.WorkflowRequestInputRequest[];
6
8
  /** The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name. */
7
9
  workflowDeploymentId?: string;
8
10
  /** The name of the Workflow Deployment. Must provide either this or workflow_deployment_id. */
9
11
  workflowDeploymentName?: string;
10
12
  /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
11
13
  releaseTag?: string;
12
- /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
13
- inputs: Vellum.WorkflowRequestInputRequest[];
14
- /** Optionally include a unique identifier for monitoring purposes. Must be unique for a given workflow deployment. */
14
+ /** Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment. */
15
15
  externalId?: string;
16
16
  }
@@ -3,14 +3,14 @@
3
3
  */
4
4
  import * as Vellum from "../..";
5
5
  export interface ExecuteWorkflowStreamRequest {
6
+ /** The list of inputs defined in the Workflow's Deployment with their corresponding values. */
7
+ inputs: Vellum.WorkflowRequestInputRequest[];
6
8
  /** The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name. */
7
9
  workflowDeploymentId?: string;
8
10
  /** The name of the Workflow Deployment. Must provide either this or workflow_deployment_id. */
9
11
  workflowDeploymentName?: string;
10
12
  /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
11
13
  releaseTag?: string;
12
- /** The list of inputs defined in the Workflow's deployment with their corresponding values. */
13
- inputs: Vellum.WorkflowRequestInputRequest[];
14
14
  /** Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment. */
15
15
  externalId?: string;
16
16
  /** Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution. */
@@ -25,5 +25,16 @@ export declare class Deployments {
25
25
  * await vellum.deployments.retrieve("id")
26
26
  */
27
27
  retrieve(id: string, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentRead>;
28
+ /**
29
+ * @throws {@link Vellum.BadRequestError}
30
+ * @throws {@link Vellum.ForbiddenError}
31
+ * @throws {@link Vellum.NotFoundError}
32
+ * @throws {@link Vellum.InternalServerError}
33
+ *
34
+ * @example
35
+ * await vellum.deployments.retrieveProviderPayload({
36
+ * inputs: []
37
+ * })
38
+ */
28
39
  retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): Promise<Vellum.DeploymentProviderPayloadResponse>;
29
40
  }
@@ -41,6 +41,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
41
41
  exports.Deployments = void 0;
42
42
  const environments = __importStar(require("../../../../environments"));
43
43
  const core = __importStar(require("../../../../core"));
44
+ const Vellum = __importStar(require("../../.."));
44
45
  const url_join_1 = __importDefault(require("url-join"));
45
46
  const serializers = __importStar(require("../../../../serialization"));
46
47
  const errors = __importStar(require("../../../../errors"));
@@ -73,7 +74,7 @@ class Deployments {
73
74
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
74
75
  "X-Fern-Language": "JavaScript",
75
76
  "X-Fern-SDK-Name": "vellum-ai",
76
- "X-Fern-SDK-Version": "0.3.9",
77
+ "X-Fern-SDK-Version": "0.3.11",
77
78
  "X-Fern-Runtime": core.RUNTIME.type,
78
79
  "X-Fern-Runtime-Version": core.RUNTIME.version,
79
80
  },
@@ -128,7 +129,7 @@ class Deployments {
128
129
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
129
130
  "X-Fern-Language": "JavaScript",
130
131
  "X-Fern-SDK-Name": "vellum-ai",
131
- "X-Fern-SDK-Version": "0.3.9",
132
+ "X-Fern-SDK-Version": "0.3.11",
132
133
  "X-Fern-Runtime": core.RUNTIME.type,
133
134
  "X-Fern-Runtime-Version": core.RUNTIME.version,
134
135
  },
@@ -165,6 +166,17 @@ class Deployments {
165
166
  }
166
167
  });
167
168
  }
169
+ /**
170
+ * @throws {@link Vellum.BadRequestError}
171
+ * @throws {@link Vellum.ForbiddenError}
172
+ * @throws {@link Vellum.NotFoundError}
173
+ * @throws {@link Vellum.InternalServerError}
174
+ *
175
+ * @example
176
+ * await vellum.deployments.retrieveProviderPayload({
177
+ * inputs: []
178
+ * })
179
+ */
168
180
  retrieveProviderPayload(request, requestOptions) {
169
181
  var _a;
170
182
  return __awaiter(this, void 0, void 0, function* () {
@@ -176,7 +188,7 @@ class Deployments {
176
188
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
177
189
  "X-Fern-Language": "JavaScript",
178
190
  "X-Fern-SDK-Name": "vellum-ai",
179
- "X-Fern-SDK-Version": "0.3.9",
191
+ "X-Fern-SDK-Version": "0.3.11",
180
192
  "X-Fern-Runtime": core.RUNTIME.type,
181
193
  "X-Fern-Runtime-Version": core.RUNTIME.version,
182
194
  },
@@ -196,10 +208,21 @@ class Deployments {
196
208
  });
197
209
  }
198
210
  if (_response.error.reason === "status-code") {
199
- throw new errors.VellumError({
200
- statusCode: _response.error.statusCode,
201
- body: _response.error.body,
202
- });
211
+ switch (_response.error.statusCode) {
212
+ case 400:
213
+ throw new Vellum.BadRequestError(_response.error.body);
214
+ case 403:
215
+ throw new Vellum.ForbiddenError(_response.error.body);
216
+ case 404:
217
+ throw new Vellum.NotFoundError(_response.error.body);
218
+ case 500:
219
+ throw new Vellum.InternalServerError(_response.error.body);
220
+ default:
221
+ throw new errors.VellumError({
222
+ statusCode: _response.error.statusCode,
223
+ body: _response.error.body,
224
+ });
225
+ }
203
226
  }
204
227
  switch (_response.error.reason) {
205
228
  case "non-json":
@@ -15,4 +15,6 @@ export interface DeploymentProviderPayloadRequest {
15
15
  deploymentName?: string;
16
16
  /** The list of inputs defined in the Prompt's deployment with their corresponding values. */
17
17
  inputs: Vellum.PromptDeploymentInputRequest[];
18
+ /** Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment */
19
+ releaseTag?: string;
18
20
  }
@@ -17,6 +17,13 @@ export declare namespace DocumentIndexes {
17
17
  export declare class DocumentIndexes {
18
18
  protected readonly _options: DocumentIndexes.Options;
19
19
  constructor(_options: DocumentIndexes.Options);
20
+ /**
21
+ * Used to retrieve a list of Document Indexes.
22
+ *
23
+ * @example
24
+ * await vellum.documentIndexes.list({})
25
+ */
26
+ list(request?: Vellum.DocumentIndexesListRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.PaginatedDocumentIndexReadList>;
20
27
  /**
21
28
  * Creates a new document index.
22
29
  *
@@ -41,13 +41,82 @@ Object.defineProperty(exports, "__esModule", { value: true });
41
41
  exports.DocumentIndexes = void 0;
42
42
  const environments = __importStar(require("../../../../environments"));
43
43
  const core = __importStar(require("../../../../core"));
44
- const serializers = __importStar(require("../../../../serialization"));
45
44
  const url_join_1 = __importDefault(require("url-join"));
45
+ const serializers = __importStar(require("../../../../serialization"));
46
46
  const errors = __importStar(require("../../../../errors"));
47
47
  class DocumentIndexes {
48
48
  constructor(_options) {
49
49
  this._options = _options;
50
50
  }
51
+ /**
52
+ * Used to retrieve a list of Document Indexes.
53
+ *
54
+ * @example
55
+ * await vellum.documentIndexes.list({})
56
+ */
57
+ list(request = {}, requestOptions) {
58
+ var _a;
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ const { limit, offset, ordering, status } = request;
61
+ const _queryParams = {};
62
+ if (limit != null) {
63
+ _queryParams["limit"] = limit.toString();
64
+ }
65
+ if (offset != null) {
66
+ _queryParams["offset"] = offset.toString();
67
+ }
68
+ if (ordering != null) {
69
+ _queryParams["ordering"] = ordering;
70
+ }
71
+ if (status != null) {
72
+ _queryParams["status"] = status;
73
+ }
74
+ const _response = yield core.fetcher({
75
+ url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
76
+ .default, "v1/document-indexes"),
77
+ method: "GET",
78
+ headers: {
79
+ X_API_KEY: yield core.Supplier.get(this._options.apiKey),
80
+ "X-Fern-Language": "JavaScript",
81
+ "X-Fern-SDK-Name": "vellum-ai",
82
+ "X-Fern-SDK-Version": "0.3.11",
83
+ "X-Fern-Runtime": core.RUNTIME.type,
84
+ "X-Fern-Runtime-Version": core.RUNTIME.version,
85
+ },
86
+ contentType: "application/json",
87
+ queryParameters: _queryParams,
88
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
89
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
90
+ });
91
+ if (_response.ok) {
92
+ return yield serializers.PaginatedDocumentIndexReadList.parseOrThrow(_response.body, {
93
+ unrecognizedObjectKeys: "passthrough",
94
+ allowUnrecognizedUnionMembers: true,
95
+ allowUnrecognizedEnumValues: true,
96
+ breadcrumbsPrefix: ["response"],
97
+ });
98
+ }
99
+ if (_response.error.reason === "status-code") {
100
+ throw new errors.VellumError({
101
+ statusCode: _response.error.statusCode,
102
+ body: _response.error.body,
103
+ });
104
+ }
105
+ switch (_response.error.reason) {
106
+ case "non-json":
107
+ throw new errors.VellumError({
108
+ statusCode: _response.error.statusCode,
109
+ body: _response.error.rawBody,
110
+ });
111
+ case "timeout":
112
+ throw new errors.VellumTimeoutError();
113
+ case "unknown":
114
+ throw new errors.VellumError({
115
+ message: _response.error.errorMessage,
116
+ });
117
+ }
118
+ });
119
+ }
51
120
  /**
52
121
  * Creates a new document index.
53
122
  *
@@ -85,7 +154,7 @@ class DocumentIndexes {
85
154
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
86
155
  "X-Fern-Language": "JavaScript",
87
156
  "X-Fern-SDK-Name": "vellum-ai",
88
- "X-Fern-SDK-Version": "0.3.9",
157
+ "X-Fern-SDK-Version": "0.3.11",
89
158
  "X-Fern-Runtime": core.RUNTIME.type,
90
159
  "X-Fern-Runtime-Version": core.RUNTIME.version,
91
160
  },
@@ -142,7 +211,7 @@ class DocumentIndexes {
142
211
  X_API_KEY: yield core.Supplier.get(this._options.apiKey),
143
212
  "X-Fern-Language": "JavaScript",
144
213
  "X-Fern-SDK-Name": "vellum-ai",
145
- "X-Fern-SDK-Version": "0.3.9",
214
+ "X-Fern-SDK-Version": "0.3.11",
146
215
  "X-Fern-Runtime": core.RUNTIME.type,
147
216
  "X-Fern-Runtime-Version": core.RUNTIME.version,
148
217
  },
@@ -0,0 +1,29 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Vellum from "../../../..";
5
+ /**
6
+ * @example
7
+ * {}
8
+ */
9
+ export interface DocumentIndexesListRequest {
10
+ /**
11
+ * Number of results to return per page.
12
+ */
13
+ limit?: number;
14
+ /**
15
+ * The initial index from which to return the results.
16
+ */
17
+ offset?: number;
18
+ /**
19
+ * Which field to use when ordering the results.
20
+ */
21
+ ordering?: string;
22
+ /**
23
+ * The current status of the document index
24
+ *
25
+ * - `ACTIVE` - Active
26
+ * - `ARCHIVED` - Archived
27
+ */
28
+ status?: Vellum.DocumentIndexesListRequestStatus;
29
+ }
@@ -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 });
@@ -1 +1,2 @@
1
+ export { DocumentIndexesListRequest } from "./DocumentIndexesListRequest";
1
2
  export { DocumentIndexCreateRequest } from "./DocumentIndexCreateRequest";
@@ -1 +1,2 @@
1
+ export * from "./types";
1
2
  export * from "./client";
@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./types"), exports);
17
18
  __exportStar(require("./client"), exports);