vellum-ai 0.8.9 → 0.8.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 (54) hide show
  1. package/.mock/definition/__package__.yml +5659 -0
  2. package/.mock/definition/adHoc.yml +40 -0
  3. package/.mock/definition/api.yml +17 -0
  4. package/.mock/definition/deployments.yml +261 -0
  5. package/.mock/definition/documentIndexes.yml +429 -0
  6. package/.mock/definition/documents.yml +261 -0
  7. package/.mock/definition/folderEntities.yml +41 -0
  8. package/.mock/definition/sandboxes.yml +194 -0
  9. package/.mock/definition/testSuiteRuns.yml +148 -0
  10. package/.mock/definition/testSuites.yml +153 -0
  11. package/.mock/definition/workflowDeployments.yml +181 -0
  12. package/.mock/definition/workflowSandboxes.yml +85 -0
  13. package/.mock/fern.config.json +4 -0
  14. package/.mock/openapi/openapi.yml +10103 -0
  15. package/Client.js +9 -9
  16. package/api/client/requests/GenerateStreamBodyRequest.d.ts +4 -1
  17. package/api/resources/adHoc/client/Client.js +1 -1
  18. package/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +3 -1
  19. package/api/resources/deployments/client/Client.js +5 -5
  20. package/api/resources/documentIndexes/client/Client.js +10 -10
  21. package/api/resources/documents/client/Client.js +6 -6
  22. package/api/resources/folderEntities/client/Client.js +1 -1
  23. package/api/resources/sandboxes/client/Client.js +3 -3
  24. package/api/resources/testSuiteRuns/client/Client.js +3 -3
  25. package/api/resources/testSuites/client/Client.js +4 -4
  26. package/api/resources/workflowDeployments/client/Client.js +4 -4
  27. package/api/resources/workflowSandboxes/client/Client.js +1 -1
  28. package/api/types/IterationStateEnum.d.ts +3 -1
  29. package/api/types/IterationStateEnum.js +1 -0
  30. package/dist/Client.js +9 -9
  31. package/dist/api/client/requests/GenerateStreamBodyRequest.d.ts +4 -1
  32. package/dist/api/resources/adHoc/client/Client.js +1 -1
  33. package/dist/api/resources/adHoc/client/requests/AdHocExecutePromptStreamRequest.d.ts +3 -1
  34. package/dist/api/resources/deployments/client/Client.js +5 -5
  35. package/dist/api/resources/documentIndexes/client/Client.js +10 -10
  36. package/dist/api/resources/documents/client/Client.js +6 -6
  37. package/dist/api/resources/folderEntities/client/Client.js +1 -1
  38. package/dist/api/resources/sandboxes/client/Client.js +3 -3
  39. package/dist/api/resources/testSuiteRuns/client/Client.js +3 -3
  40. package/dist/api/resources/testSuites/client/Client.js +4 -4
  41. package/dist/api/resources/workflowDeployments/client/Client.js +4 -4
  42. package/dist/api/resources/workflowSandboxes/client/Client.js +1 -1
  43. package/dist/api/types/IterationStateEnum.d.ts +3 -1
  44. package/dist/api/types/IterationStateEnum.js +1 -0
  45. package/dist/environments.d.ts +2 -2
  46. package/dist/environments.js +1 -1
  47. package/dist/serialization/types/IterationStateEnum.d.ts +1 -1
  48. package/dist/serialization/types/IterationStateEnum.js +1 -1
  49. package/environments.d.ts +2 -2
  50. package/environments.js +1 -1
  51. package/package.json +1 -1
  52. package/reference.md +17 -3
  53. package/serialization/types/IterationStateEnum.d.ts +1 -1
  54. package/serialization/types/IterationStateEnum.js +1 -1
@@ -0,0 +1,181 @@
1
+ types:
2
+ WorkflowDeploymentsListRequestStatus:
3
+ enum:
4
+ - ACTIVE
5
+ - ARCHIVED
6
+ source:
7
+ openapi: openapi/openapi.yml
8
+ imports:
9
+ root: __package__.yml
10
+ service:
11
+ auth: false
12
+ base-path: ''
13
+ endpoints:
14
+ list:
15
+ path: /v1/workflow-deployments
16
+ method: GET
17
+ auth: true
18
+ docs: Used to list all Workflow Deployments.
19
+ request:
20
+ name: WorkflowDeploymentsListRequest
21
+ query-parameters:
22
+ limit:
23
+ type: optional<integer>
24
+ docs: Number of results to return per page.
25
+ offset:
26
+ type: optional<integer>
27
+ docs: The initial index from which to return the results.
28
+ ordering:
29
+ type: optional<string>
30
+ docs: Which field to use when ordering the results.
31
+ status:
32
+ type: optional<WorkflowDeploymentsListRequestStatus>
33
+ docs: status
34
+ response:
35
+ docs: ''
36
+ type: root.PaginatedSlimWorkflowDeploymentList
37
+ url: Default
38
+ availability: pre-release
39
+ examples:
40
+ - response:
41
+ body:
42
+ count: 123
43
+ next: http://api.example.org/accounts/?offset=400&limit=100
44
+ previous: http://api.example.org/accounts/?offset=200&limit=100
45
+ results:
46
+ - id: id
47
+ name: name
48
+ label: label
49
+ status: ACTIVE
50
+ environment: DEVELOPMENT
51
+ created: '2024-01-15T09:30:00Z'
52
+ last_deployed_on: '2024-01-15T09:30:00Z'
53
+ input_variables:
54
+ - id: id
55
+ key: key
56
+ type: STRING
57
+ output_variables:
58
+ - id: id
59
+ key: key
60
+ type: STRING
61
+ description: description
62
+ audiences:
63
+ - customers
64
+ retrieve:
65
+ path: /v1/workflow-deployments/{id}
66
+ method: GET
67
+ auth: true
68
+ docs: Used to retrieve a workflow deployment given its ID or name.
69
+ path-parameters:
70
+ id:
71
+ type: string
72
+ docs: Either the Workflow Deployment's ID or its unique name
73
+ response:
74
+ docs: ''
75
+ type: root.WorkflowDeploymentRead
76
+ url: Default
77
+ availability: pre-release
78
+ examples:
79
+ - path-parameters:
80
+ id: id
81
+ response:
82
+ body:
83
+ id: id
84
+ name: name
85
+ label: label
86
+ status: ACTIVE
87
+ environment: DEVELOPMENT
88
+ created: '2024-01-15T09:30:00Z'
89
+ last_deployed_on: '2024-01-15T09:30:00Z'
90
+ last_deployed_history_item_id: last_deployed_history_item_id
91
+ input_variables:
92
+ - id: id
93
+ key: key
94
+ type: STRING
95
+ output_variables:
96
+ - id: id
97
+ key: key
98
+ type: STRING
99
+ description: description
100
+ audiences:
101
+ - customers
102
+ retrieve_workflow_release_tag:
103
+ path: /v1/workflow-deployments/{id}/release-tags/{name}
104
+ method: GET
105
+ auth: true
106
+ docs: >-
107
+ Retrieve a Workflow Release Tag by tag name, associated with a specified
108
+ Workflow Deployment.
109
+ path-parameters:
110
+ id:
111
+ type: string
112
+ docs: A UUID string identifying this workflow deployment.
113
+ name:
114
+ type: string
115
+ docs: >-
116
+ The name of the Release Tag associated with this Workflow Deployment
117
+ that you'd like to retrieve.
118
+ response:
119
+ docs: ''
120
+ type: root.WorkflowReleaseTagRead
121
+ url: Default
122
+ availability: pre-release
123
+ examples:
124
+ - path-parameters:
125
+ id: id
126
+ name: name
127
+ response:
128
+ body:
129
+ name: name
130
+ source: SYSTEM
131
+ history_item:
132
+ id: id
133
+ timestamp: '2024-01-15T09:30:00Z'
134
+ audiences:
135
+ - customers
136
+ update_workflow_release_tag:
137
+ path: /v1/workflow-deployments/{id}/release-tags/{name}
138
+ method: PATCH
139
+ auth: true
140
+ docs: >-
141
+ Updates an existing Release Tag associated with the specified Workflow
142
+ Deployment.
143
+ path-parameters:
144
+ id:
145
+ type: string
146
+ docs: A UUID string identifying this workflow deployment.
147
+ name:
148
+ type: string
149
+ docs: >-
150
+ The name of the Release Tag associated with this Workflow Deployment
151
+ that you'd like to update.
152
+ request:
153
+ name: PatchedWorkflowReleaseTagUpdateRequest
154
+ body:
155
+ properties:
156
+ history_item_id:
157
+ type: optional<string>
158
+ docs: The ID of the Workflow Deployment History Item to tag
159
+ validation:
160
+ format: uuid
161
+ response:
162
+ docs: ''
163
+ type: root.WorkflowReleaseTagRead
164
+ url: Default
165
+ availability: pre-release
166
+ examples:
167
+ - path-parameters:
168
+ id: id
169
+ name: name
170
+ request: {}
171
+ response:
172
+ body:
173
+ name: name
174
+ source: SYSTEM
175
+ history_item:
176
+ id: id
177
+ timestamp: '2024-01-15T09:30:00Z'
178
+ audiences:
179
+ - customers
180
+ source:
181
+ openapi: openapi/openapi.yml
@@ -0,0 +1,85 @@
1
+ imports:
2
+ root: __package__.yml
3
+ service:
4
+ auth: false
5
+ base-path: ''
6
+ endpoints:
7
+ deploy_workflow:
8
+ path: /v1/workflow-sandboxes/{id}/workflows/{workflow_id}/deploy
9
+ method: POST
10
+ auth: true
11
+ path-parameters:
12
+ id:
13
+ type: string
14
+ docs: A UUID string identifying this workflow sandbox.
15
+ workflow_id:
16
+ type: string
17
+ docs: An ID identifying the Workflow you'd like to deploy.
18
+ request:
19
+ name: DeploySandboxWorkflowRequest
20
+ body:
21
+ properties:
22
+ workflow_deployment_id:
23
+ type: optional<string>
24
+ docs: >-
25
+ The Vellum-generated ID of the Workflow Deployment you'd like to
26
+ update. Cannot specify both this and workflow_deployment_name.
27
+ Leave null to create a new Workflow Deployment.
28
+ validation:
29
+ format: uuid
30
+ workflow_deployment_name:
31
+ type: optional<string>
32
+ docs: >-
33
+ The unique name of the Workflow Deployment you'd like to either
34
+ create or update. Cannot specify both this and
35
+ workflow_deployment_id. If provided and matches an existing
36
+ Workflow Deployment, that Workflow Deployment will be updated.
37
+ Otherwise, a new Prompt Deployment will be created.
38
+ validation:
39
+ minLength: 1
40
+ label:
41
+ type: optional<string>
42
+ docs: >-
43
+ In the event that a new Workflow Deployment is created, this
44
+ will be the label it's given.
45
+ validation:
46
+ minLength: 1
47
+ release_tags:
48
+ type: optional<list<string>>
49
+ docs: >-
50
+ Optionally provide the release tags that you'd like to be
51
+ associated with the latest release of the created/updated Prompt
52
+ Deployment.
53
+ response:
54
+ docs: ''
55
+ type: root.WorkflowDeploymentRead
56
+ url: Default
57
+ availability: pre-release
58
+ examples:
59
+ - path-parameters:
60
+ id: id
61
+ workflow_id: workflow_id
62
+ request: {}
63
+ response:
64
+ body:
65
+ id: id
66
+ name: name
67
+ label: label
68
+ status: ACTIVE
69
+ environment: DEVELOPMENT
70
+ created: '2024-01-15T09:30:00Z'
71
+ last_deployed_on: '2024-01-15T09:30:00Z'
72
+ last_deployed_history_item_id: last_deployed_history_item_id
73
+ input_variables:
74
+ - id: id
75
+ key: key
76
+ type: STRING
77
+ output_variables:
78
+ - id: id
79
+ key: key
80
+ type: STRING
81
+ description: description
82
+ audiences:
83
+ - customers
84
+ source:
85
+ openapi: openapi/openapi.yml
@@ -0,0 +1,4 @@
1
+ {
2
+ "organization" : "vellum",
3
+ "version" : "0.41.16"
4
+ }