vellum-ai 0.13.21 → 0.13.23
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.
- package/Client.d.ts +10 -0
- package/Client.js +63 -10
- package/api/client/requests/ExecuteApiRequest.d.ts +17 -0
- package/api/client/requests/ExecuteApiRequest.js +5 -0
- package/api/client/requests/index.d.ts +1 -0
- package/api/resources/adHoc/client/Client.js +1 -1
- package/api/resources/containerImages/client/Client.js +4 -4
- package/api/resources/deployments/client/Client.js +7 -7
- package/api/resources/documentIndexes/client/Client.js +8 -8
- package/api/resources/documents/client/Client.js +5 -5
- package/api/resources/folderEntities/client/Client.js +2 -2
- package/api/resources/metricDefinitions/client/Client.js +2 -2
- package/api/resources/mlModels/client/Client.js +1 -1
- package/api/resources/organizations/client/Client.js +1 -1
- package/api/resources/sandboxes/client/Client.js +3 -3
- package/api/resources/testSuiteRuns/client/Client.js +3 -3
- package/api/resources/testSuites/client/Client.js +4 -4
- package/api/resources/workflowDeployments/client/Client.js +6 -6
- package/api/resources/workflowSandboxes/client/Client.js +1 -1
- package/api/resources/workflows/client/Client.js +2 -2
- package/api/resources/workspaceSecrets/client/Client.js +2 -2
- package/api/resources/workspaces/client/Client.js +1 -1
- package/api/types/ExecuteApiRequestBearerToken.d.ts +5 -0
- package/api/types/ExecuteApiRequestBearerToken.js +5 -0
- package/api/types/ExecuteApiRequestBody.d.ts +4 -0
- package/api/types/ExecuteApiRequestBody.js +5 -0
- package/api/types/ExecuteApiRequestHeadersValue.d.ts +5 -0
- package/api/types/ExecuteApiRequestHeadersValue.js +5 -0
- package/api/types/ExecuteApiResponse.d.ts +9 -0
- package/api/types/ExecuteApiResponse.js +5 -0
- package/api/types/MethodEnum.d.ts +18 -0
- package/api/types/MethodEnum.js +13 -0
- package/api/types/VellumSecret.d.ts +6 -0
- package/api/types/VellumSecret.js +5 -0
- package/api/types/index.d.ts +6 -0
- package/api/types/index.js +6 -0
- package/dist/Client.d.ts +10 -0
- package/dist/Client.js +63 -10
- package/dist/api/client/requests/ExecuteApiRequest.d.ts +17 -0
- package/dist/api/client/requests/ExecuteApiRequest.js +5 -0
- package/dist/api/client/requests/index.d.ts +1 -0
- package/dist/api/resources/adHoc/client/Client.js +1 -1
- package/dist/api/resources/containerImages/client/Client.js +4 -4
- package/dist/api/resources/deployments/client/Client.js +7 -7
- package/dist/api/resources/documentIndexes/client/Client.js +8 -8
- package/dist/api/resources/documents/client/Client.js +5 -5
- package/dist/api/resources/folderEntities/client/Client.js +2 -2
- package/dist/api/resources/metricDefinitions/client/Client.js +2 -2
- package/dist/api/resources/mlModels/client/Client.js +1 -1
- package/dist/api/resources/organizations/client/Client.js +1 -1
- package/dist/api/resources/sandboxes/client/Client.js +3 -3
- package/dist/api/resources/testSuiteRuns/client/Client.js +3 -3
- package/dist/api/resources/testSuites/client/Client.js +4 -4
- package/dist/api/resources/workflowDeployments/client/Client.js +6 -6
- package/dist/api/resources/workflowSandboxes/client/Client.js +1 -1
- package/dist/api/resources/workflows/client/Client.js +2 -2
- package/dist/api/resources/workspaceSecrets/client/Client.js +2 -2
- package/dist/api/resources/workspaces/client/Client.js +1 -1
- package/dist/api/types/ExecuteApiRequestBearerToken.d.ts +5 -0
- package/dist/api/types/ExecuteApiRequestBearerToken.js +5 -0
- package/dist/api/types/ExecuteApiRequestBody.d.ts +4 -0
- package/dist/api/types/ExecuteApiRequestBody.js +5 -0
- package/dist/api/types/ExecuteApiRequestHeadersValue.d.ts +5 -0
- package/dist/api/types/ExecuteApiRequestHeadersValue.js +5 -0
- package/dist/api/types/ExecuteApiResponse.d.ts +9 -0
- package/dist/api/types/ExecuteApiResponse.js +5 -0
- package/dist/api/types/MethodEnum.d.ts +18 -0
- package/dist/api/types/MethodEnum.js +13 -0
- package/dist/api/types/VellumSecret.d.ts +6 -0
- package/dist/api/types/VellumSecret.js +5 -0
- package/dist/api/types/index.d.ts +6 -0
- package/dist/api/types/index.js +6 -0
- package/dist/serialization/client/requests/ExecuteApiRequest.d.ts +20 -0
- package/dist/serialization/client/requests/ExecuteApiRequest.js +51 -0
- package/dist/serialization/client/requests/index.d.ts +1 -0
- package/dist/serialization/client/requests/index.js +3 -1
- package/dist/serialization/types/ExecuteApiRequestBearerToken.d.ts +11 -0
- package/dist/serialization/types/ExecuteApiRequestBearerToken.js +42 -0
- package/dist/serialization/types/ExecuteApiRequestBody.d.ts +10 -0
- package/dist/serialization/types/ExecuteApiRequestBody.js +44 -0
- package/dist/serialization/types/ExecuteApiRequestHeadersValue.d.ts +11 -0
- package/dist/serialization/types/ExecuteApiRequestHeadersValue.js +42 -0
- package/dist/serialization/types/ExecuteApiResponse.d.ts +15 -0
- package/dist/serialization/types/ExecuteApiResponse.js +46 -0
- package/dist/serialization/types/MethodEnum.d.ts +10 -0
- package/dist/serialization/types/MethodEnum.js +41 -0
- package/dist/serialization/types/VellumSecret.d.ts +12 -0
- package/dist/serialization/types/VellumSecret.js +43 -0
- package/dist/serialization/types/index.d.ts +6 -0
- package/dist/serialization/types/index.js +6 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/serialization/client/requests/ExecuteApiRequest.d.ts +20 -0
- package/serialization/client/requests/ExecuteApiRequest.js +51 -0
- package/serialization/client/requests/index.d.ts +1 -0
- package/serialization/client/requests/index.js +3 -1
- package/serialization/types/ExecuteApiRequestBearerToken.d.ts +11 -0
- package/serialization/types/ExecuteApiRequestBearerToken.js +42 -0
- package/serialization/types/ExecuteApiRequestBody.d.ts +10 -0
- package/serialization/types/ExecuteApiRequestBody.js +44 -0
- package/serialization/types/ExecuteApiRequestHeadersValue.d.ts +11 -0
- package/serialization/types/ExecuteApiRequestHeadersValue.js +42 -0
- package/serialization/types/ExecuteApiResponse.d.ts +15 -0
- package/serialization/types/ExecuteApiResponse.js +46 -0
- package/serialization/types/MethodEnum.d.ts +10 -0
- package/serialization/types/MethodEnum.js +41 -0
- package/serialization/types/VellumSecret.d.ts +12 -0
- package/serialization/types/VellumSecret.js +43 -0
- package/serialization/types/index.d.ts +6 -0
- package/serialization/types/index.js +6 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/.mock/definition/__package__.yml +0 -6819
- package/.mock/definition/adHoc.yml +0 -64
- package/.mock/definition/api.yml +0 -17
- package/.mock/definition/containerImages.yml +0 -148
- package/.mock/definition/deployments.yml +0 -372
- package/.mock/definition/documentIndexes.yml +0 -448
- package/.mock/definition/documents.yml +0 -281
- package/.mock/definition/folderEntities.yml +0 -135
- package/.mock/definition/metricDefinitions.yml +0 -96
- package/.mock/definition/mlModels.yml +0 -36
- package/.mock/definition/organizations.yml +0 -29
- package/.mock/definition/sandboxes.yml +0 -205
- package/.mock/definition/testSuiteRuns.yml +0 -163
- package/.mock/definition/testSuites.yml +0 -192
- package/.mock/definition/workflowDeployments.yml +0 -299
- package/.mock/definition/workflowSandboxes.yml +0 -94
- package/.mock/definition/workflows.yml +0 -80
- package/.mock/definition/workspaceSecrets.yml +0 -78
- package/.mock/definition/workspaces.yml +0 -29
- package/.mock/fern.config.json +0 -4
- package/.mock/openapi/openapi.yml +0 -12271
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
imports:
|
|
2
|
-
root: __package__.yml
|
|
3
|
-
service:
|
|
4
|
-
auth: false
|
|
5
|
-
base-path: ''
|
|
6
|
-
endpoints:
|
|
7
|
-
adhoc_execute_prompt_stream:
|
|
8
|
-
path: /v1/ad-hoc/execute-prompt-stream
|
|
9
|
-
method: POST
|
|
10
|
-
auth: true
|
|
11
|
-
source:
|
|
12
|
-
openapi: openapi/openapi.yml
|
|
13
|
-
request:
|
|
14
|
-
name: AdHocExecutePromptStream
|
|
15
|
-
body:
|
|
16
|
-
properties:
|
|
17
|
-
ml_model:
|
|
18
|
-
type: string
|
|
19
|
-
validation:
|
|
20
|
-
minLength: 1
|
|
21
|
-
input_values: list<root.PromptRequestInput>
|
|
22
|
-
input_variables: list<root.VellumVariable>
|
|
23
|
-
parameters: root.PromptParameters
|
|
24
|
-
settings: optional<root.PromptSettings>
|
|
25
|
-
blocks: list<root.PromptBlock>
|
|
26
|
-
functions: optional<list<root.FunctionDefinition>>
|
|
27
|
-
expand_meta: optional<root.AdHocExpandMeta>
|
|
28
|
-
content-type: application/json
|
|
29
|
-
response-stream:
|
|
30
|
-
docs: ''
|
|
31
|
-
type: root.AdHocExecutePromptEvent
|
|
32
|
-
format: json
|
|
33
|
-
url: Predict
|
|
34
|
-
availability: pre-release
|
|
35
|
-
errors:
|
|
36
|
-
- root.BadRequestError
|
|
37
|
-
- root.ForbiddenError
|
|
38
|
-
- root.InternalServerError
|
|
39
|
-
examples:
|
|
40
|
-
- request:
|
|
41
|
-
ml_model: ml_model
|
|
42
|
-
input_values:
|
|
43
|
-
- key: key
|
|
44
|
-
type: STRING
|
|
45
|
-
value: value
|
|
46
|
-
input_variables:
|
|
47
|
-
- id: id
|
|
48
|
-
key: key
|
|
49
|
-
type: STRING
|
|
50
|
-
parameters: {}
|
|
51
|
-
blocks:
|
|
52
|
-
- block_type: JINJA
|
|
53
|
-
template: template
|
|
54
|
-
response:
|
|
55
|
-
stream:
|
|
56
|
-
- state: INITIATED
|
|
57
|
-
meta:
|
|
58
|
-
model_name: model_name
|
|
59
|
-
latency: 1
|
|
60
|
-
execution_id: execution_id
|
|
61
|
-
audiences:
|
|
62
|
-
- internal
|
|
63
|
-
source:
|
|
64
|
-
openapi: openapi/openapi.yml
|
package/.mock/definition/api.yml
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
name: api
|
|
2
|
-
error-discrimination:
|
|
3
|
-
strategy: status-code
|
|
4
|
-
display-name: Vellum Client API
|
|
5
|
-
environments:
|
|
6
|
-
Production:
|
|
7
|
-
urls:
|
|
8
|
-
Default: https://api.vellum.ai
|
|
9
|
-
Predict: https://predict.vellum.ai
|
|
10
|
-
Documents: https://documents.vellum.ai
|
|
11
|
-
default-environment: Production
|
|
12
|
-
auth-schemes:
|
|
13
|
-
apiKeyAuth:
|
|
14
|
-
header: X_API_KEY
|
|
15
|
-
name: apiKey
|
|
16
|
-
type: string
|
|
17
|
-
auth: apiKeyAuth
|
|
@@ -1,148 +0,0 @@
|
|
|
1
|
-
imports:
|
|
2
|
-
root: __package__.yml
|
|
3
|
-
service:
|
|
4
|
-
auth: false
|
|
5
|
-
base-path: ''
|
|
6
|
-
endpoints:
|
|
7
|
-
list:
|
|
8
|
-
path: /v1/container-images
|
|
9
|
-
method: GET
|
|
10
|
-
auth: true
|
|
11
|
-
docs: Retrieve a list of container images for the organization.
|
|
12
|
-
source:
|
|
13
|
-
openapi: openapi/openapi.yml
|
|
14
|
-
request:
|
|
15
|
-
name: ContainerImagesListRequest
|
|
16
|
-
query-parameters:
|
|
17
|
-
limit:
|
|
18
|
-
type: optional<integer>
|
|
19
|
-
docs: Number of results to return per page.
|
|
20
|
-
offset:
|
|
21
|
-
type: optional<integer>
|
|
22
|
-
docs: The initial index from which to return the results.
|
|
23
|
-
ordering:
|
|
24
|
-
type: optional<string>
|
|
25
|
-
docs: Which field to use when ordering the results.
|
|
26
|
-
response:
|
|
27
|
-
docs: ''
|
|
28
|
-
type: root.PaginatedContainerImageReadList
|
|
29
|
-
url: Default
|
|
30
|
-
availability: pre-release
|
|
31
|
-
examples:
|
|
32
|
-
- response:
|
|
33
|
-
body:
|
|
34
|
-
count: 123
|
|
35
|
-
next: http://api.example.org/accounts/?offset=400&limit=100
|
|
36
|
-
previous: http://api.example.org/accounts/?offset=200&limit=100
|
|
37
|
-
results:
|
|
38
|
-
- id: id
|
|
39
|
-
name: name
|
|
40
|
-
visibility: DEFAULT
|
|
41
|
-
created: '2024-01-15T09:30:00Z'
|
|
42
|
-
modified: '2024-01-15T09:30:00Z'
|
|
43
|
-
repository: repository
|
|
44
|
-
sha: sha
|
|
45
|
-
tags:
|
|
46
|
-
- name: name
|
|
47
|
-
modified: '2024-01-15T09:30:00Z'
|
|
48
|
-
audiences:
|
|
49
|
-
- internal
|
|
50
|
-
retrieve:
|
|
51
|
-
path: /v1/container-images/{id}
|
|
52
|
-
method: GET
|
|
53
|
-
auth: true
|
|
54
|
-
docs: Retrieve a Container Image by its ID or name.
|
|
55
|
-
source:
|
|
56
|
-
openapi: openapi/openapi.yml
|
|
57
|
-
path-parameters:
|
|
58
|
-
id:
|
|
59
|
-
type: string
|
|
60
|
-
docs: Either the Container Image's ID or its unique name
|
|
61
|
-
response:
|
|
62
|
-
docs: ''
|
|
63
|
-
type: root.ContainerImageRead
|
|
64
|
-
url: Default
|
|
65
|
-
availability: pre-release
|
|
66
|
-
examples:
|
|
67
|
-
- path-parameters:
|
|
68
|
-
id: id
|
|
69
|
-
response:
|
|
70
|
-
body:
|
|
71
|
-
id: id
|
|
72
|
-
name: name
|
|
73
|
-
visibility: DEFAULT
|
|
74
|
-
created: '2024-01-15T09:30:00Z'
|
|
75
|
-
modified: '2024-01-15T09:30:00Z'
|
|
76
|
-
repository: repository
|
|
77
|
-
sha: sha
|
|
78
|
-
tags:
|
|
79
|
-
- name: name
|
|
80
|
-
modified: '2024-01-15T09:30:00Z'
|
|
81
|
-
audiences:
|
|
82
|
-
- internal
|
|
83
|
-
docker-service-token:
|
|
84
|
-
path: /v1/container-images/docker-service-token
|
|
85
|
-
method: GET
|
|
86
|
-
auth: true
|
|
87
|
-
source:
|
|
88
|
-
openapi: openapi/openapi.yml
|
|
89
|
-
response:
|
|
90
|
-
docs: ''
|
|
91
|
-
type: root.DockerServiceToken
|
|
92
|
-
url: Default
|
|
93
|
-
availability: pre-release
|
|
94
|
-
examples:
|
|
95
|
-
- response:
|
|
96
|
-
body:
|
|
97
|
-
access_token: access_token
|
|
98
|
-
organization_id: organization_id
|
|
99
|
-
repository: repository
|
|
100
|
-
audiences:
|
|
101
|
-
- internal
|
|
102
|
-
push_container_image:
|
|
103
|
-
path: /v1/container-images/push
|
|
104
|
-
method: POST
|
|
105
|
-
auth: true
|
|
106
|
-
source:
|
|
107
|
-
openapi: openapi/openapi.yml
|
|
108
|
-
request:
|
|
109
|
-
name: PushContainerImageRequest
|
|
110
|
-
body:
|
|
111
|
-
properties:
|
|
112
|
-
name:
|
|
113
|
-
type: string
|
|
114
|
-
validation:
|
|
115
|
-
minLength: 1
|
|
116
|
-
sha:
|
|
117
|
-
type: string
|
|
118
|
-
validation:
|
|
119
|
-
minLength: 1
|
|
120
|
-
tags: list<string>
|
|
121
|
-
content-type: application/json
|
|
122
|
-
response:
|
|
123
|
-
docs: ''
|
|
124
|
-
type: root.ContainerImageRead
|
|
125
|
-
url: Default
|
|
126
|
-
availability: pre-release
|
|
127
|
-
examples:
|
|
128
|
-
- request:
|
|
129
|
-
name: name
|
|
130
|
-
sha: sha
|
|
131
|
-
tags:
|
|
132
|
-
- tags
|
|
133
|
-
response:
|
|
134
|
-
body:
|
|
135
|
-
id: id
|
|
136
|
-
name: name
|
|
137
|
-
visibility: DEFAULT
|
|
138
|
-
created: '2024-01-15T09:30:00Z'
|
|
139
|
-
modified: '2024-01-15T09:30:00Z'
|
|
140
|
-
repository: repository
|
|
141
|
-
sha: sha
|
|
142
|
-
tags:
|
|
143
|
-
- name: name
|
|
144
|
-
modified: '2024-01-15T09:30:00Z'
|
|
145
|
-
audiences:
|
|
146
|
-
- internal
|
|
147
|
-
source:
|
|
148
|
-
openapi: openapi/openapi.yml
|
|
@@ -1,372 +0,0 @@
|
|
|
1
|
-
types:
|
|
2
|
-
DeploymentsListRequestStatus:
|
|
3
|
-
enum:
|
|
4
|
-
- ACTIVE
|
|
5
|
-
- ARCHIVED
|
|
6
|
-
source:
|
|
7
|
-
openapi: openapi/openapi.yml
|
|
8
|
-
ListDeploymentReleaseTagsRequestSource:
|
|
9
|
-
enum:
|
|
10
|
-
- SYSTEM
|
|
11
|
-
- USER
|
|
12
|
-
source:
|
|
13
|
-
openapi: openapi/openapi.yml
|
|
14
|
-
imports:
|
|
15
|
-
root: __package__.yml
|
|
16
|
-
service:
|
|
17
|
-
auth: false
|
|
18
|
-
base-path: ''
|
|
19
|
-
endpoints:
|
|
20
|
-
list:
|
|
21
|
-
path: /v1/deployments
|
|
22
|
-
method: GET
|
|
23
|
-
auth: true
|
|
24
|
-
docs: Used to list all Prompt Deployments.
|
|
25
|
-
source:
|
|
26
|
-
openapi: openapi/openapi.yml
|
|
27
|
-
request:
|
|
28
|
-
name: DeploymentsListRequest
|
|
29
|
-
query-parameters:
|
|
30
|
-
limit:
|
|
31
|
-
type: optional<integer>
|
|
32
|
-
docs: Number of results to return per page.
|
|
33
|
-
offset:
|
|
34
|
-
type: optional<integer>
|
|
35
|
-
docs: The initial index from which to return the results.
|
|
36
|
-
ordering:
|
|
37
|
-
type: optional<string>
|
|
38
|
-
docs: Which field to use when ordering the results.
|
|
39
|
-
status:
|
|
40
|
-
type: optional<DeploymentsListRequestStatus>
|
|
41
|
-
docs: status
|
|
42
|
-
response:
|
|
43
|
-
docs: ''
|
|
44
|
-
type: root.PaginatedSlimDeploymentReadList
|
|
45
|
-
url: Default
|
|
46
|
-
availability: pre-release
|
|
47
|
-
examples:
|
|
48
|
-
- response:
|
|
49
|
-
body:
|
|
50
|
-
count: 123
|
|
51
|
-
next: http://api.example.org/accounts/?offset=400&limit=100
|
|
52
|
-
previous: http://api.example.org/accounts/?offset=200&limit=100
|
|
53
|
-
results:
|
|
54
|
-
- id: id
|
|
55
|
-
created: '2024-01-15T09:30:00Z'
|
|
56
|
-
label: label
|
|
57
|
-
name: name
|
|
58
|
-
status: ACTIVE
|
|
59
|
-
environment: DEVELOPMENT
|
|
60
|
-
last_deployed_on: '2024-01-15T09:30:00Z'
|
|
61
|
-
input_variables:
|
|
62
|
-
- id: id
|
|
63
|
-
key: key
|
|
64
|
-
type: STRING
|
|
65
|
-
description: description
|
|
66
|
-
audiences:
|
|
67
|
-
- customers
|
|
68
|
-
retrieve:
|
|
69
|
-
path: /v1/deployments/{id}
|
|
70
|
-
method: GET
|
|
71
|
-
auth: true
|
|
72
|
-
docs: Used to retrieve a Prompt Deployment given its ID or name.
|
|
73
|
-
source:
|
|
74
|
-
openapi: openapi/openapi.yml
|
|
75
|
-
path-parameters:
|
|
76
|
-
id:
|
|
77
|
-
type: string
|
|
78
|
-
docs: Either the Deployment's ID or its unique name
|
|
79
|
-
response:
|
|
80
|
-
docs: ''
|
|
81
|
-
type: root.DeploymentRead
|
|
82
|
-
url: Default
|
|
83
|
-
availability: pre-release
|
|
84
|
-
examples:
|
|
85
|
-
- path-parameters:
|
|
86
|
-
id: id
|
|
87
|
-
response:
|
|
88
|
-
body:
|
|
89
|
-
id: id
|
|
90
|
-
created: '2024-01-15T09:30:00Z'
|
|
91
|
-
label: label
|
|
92
|
-
name: name
|
|
93
|
-
status: ACTIVE
|
|
94
|
-
environment: DEVELOPMENT
|
|
95
|
-
last_deployed_on: '2024-01-15T09:30:00Z'
|
|
96
|
-
input_variables:
|
|
97
|
-
- id: id
|
|
98
|
-
key: key
|
|
99
|
-
type: STRING
|
|
100
|
-
required: true
|
|
101
|
-
default:
|
|
102
|
-
type: STRING
|
|
103
|
-
description: description
|
|
104
|
-
active_model_version_ids:
|
|
105
|
-
- active_model_version_ids
|
|
106
|
-
last_deployed_history_item_id: last_deployed_history_item_id
|
|
107
|
-
audiences:
|
|
108
|
-
- customers
|
|
109
|
-
deployment_history_item_retrieve:
|
|
110
|
-
path: /v1/deployments/{id}/history/{history_id_or_release_tag}
|
|
111
|
-
method: GET
|
|
112
|
-
auth: true
|
|
113
|
-
docs: >-
|
|
114
|
-
Retrieve a specific Deployment History Item by either its UUID or the
|
|
115
|
-
name of a Release Tag that points to it.
|
|
116
|
-
source:
|
|
117
|
-
openapi: openapi/openapi.yml
|
|
118
|
-
path-parameters:
|
|
119
|
-
history_id_or_release_tag:
|
|
120
|
-
type: string
|
|
121
|
-
docs: >-
|
|
122
|
-
Either the UUID of Deployment History Item you'd like to retrieve,
|
|
123
|
-
or the name of a Release Tag that's pointing to the Deployment
|
|
124
|
-
History Item you'd like to retrieve.
|
|
125
|
-
id:
|
|
126
|
-
type: string
|
|
127
|
-
docs: A UUID string identifying this deployment.
|
|
128
|
-
response:
|
|
129
|
-
docs: ''
|
|
130
|
-
type: root.DeploymentHistoryItem
|
|
131
|
-
url: Default
|
|
132
|
-
availability: pre-release
|
|
133
|
-
examples:
|
|
134
|
-
- path-parameters:
|
|
135
|
-
history_id_or_release_tag: history_id_or_release_tag
|
|
136
|
-
id: id
|
|
137
|
-
response:
|
|
138
|
-
body:
|
|
139
|
-
id: id
|
|
140
|
-
deployment_id: deployment_id
|
|
141
|
-
timestamp: '2024-01-15T09:30:00Z'
|
|
142
|
-
label: label
|
|
143
|
-
name: name
|
|
144
|
-
input_variables:
|
|
145
|
-
- id: id
|
|
146
|
-
key: key
|
|
147
|
-
type: STRING
|
|
148
|
-
required: true
|
|
149
|
-
default:
|
|
150
|
-
type: STRING
|
|
151
|
-
description: description
|
|
152
|
-
audiences:
|
|
153
|
-
- customers
|
|
154
|
-
list_deployment_release_tags:
|
|
155
|
-
path: /v1/deployments/{id}/release-tags
|
|
156
|
-
method: GET
|
|
157
|
-
auth: true
|
|
158
|
-
docs: List Release Tags associated with the specified Prompt Deployment
|
|
159
|
-
source:
|
|
160
|
-
openapi: openapi/openapi.yml
|
|
161
|
-
path-parameters:
|
|
162
|
-
id:
|
|
163
|
-
type: string
|
|
164
|
-
docs: Either the Prompt Deployment's ID or its unique name
|
|
165
|
-
request:
|
|
166
|
-
name: ListDeploymentReleaseTagsRequest
|
|
167
|
-
query-parameters:
|
|
168
|
-
limit:
|
|
169
|
-
type: optional<integer>
|
|
170
|
-
docs: Number of results to return per page.
|
|
171
|
-
offset:
|
|
172
|
-
type: optional<integer>
|
|
173
|
-
docs: The initial index from which to return the results.
|
|
174
|
-
ordering:
|
|
175
|
-
type: optional<string>
|
|
176
|
-
docs: Which field to use when ordering the results.
|
|
177
|
-
source: optional<ListDeploymentReleaseTagsRequestSource>
|
|
178
|
-
response:
|
|
179
|
-
docs: ''
|
|
180
|
-
type: root.PaginatedDeploymentReleaseTagReadList
|
|
181
|
-
url: Default
|
|
182
|
-
availability: pre-release
|
|
183
|
-
examples:
|
|
184
|
-
- path-parameters:
|
|
185
|
-
id: id
|
|
186
|
-
response:
|
|
187
|
-
body:
|
|
188
|
-
count: 123
|
|
189
|
-
next: http://api.example.org/accounts/?offset=400&limit=100
|
|
190
|
-
previous: http://api.example.org/accounts/?offset=200&limit=100
|
|
191
|
-
results:
|
|
192
|
-
- name: name
|
|
193
|
-
source: SYSTEM
|
|
194
|
-
history_item:
|
|
195
|
-
id: id
|
|
196
|
-
timestamp: '2024-01-15T09:30:00Z'
|
|
197
|
-
audiences:
|
|
198
|
-
- customers
|
|
199
|
-
retrieve_deployment_release_tag:
|
|
200
|
-
path: /v1/deployments/{id}/release-tags/{name}
|
|
201
|
-
method: GET
|
|
202
|
-
auth: true
|
|
203
|
-
docs: >-
|
|
204
|
-
Retrieve a Deployment Release Tag by tag name, associated with a
|
|
205
|
-
specified Deployment.
|
|
206
|
-
source:
|
|
207
|
-
openapi: openapi/openapi.yml
|
|
208
|
-
path-parameters:
|
|
209
|
-
id:
|
|
210
|
-
type: string
|
|
211
|
-
docs: A UUID string identifying this deployment.
|
|
212
|
-
name:
|
|
213
|
-
type: string
|
|
214
|
-
docs: >-
|
|
215
|
-
The name of the Release Tag associated with this Deployment that
|
|
216
|
-
you'd like to retrieve.
|
|
217
|
-
response:
|
|
218
|
-
docs: ''
|
|
219
|
-
type: root.DeploymentReleaseTagRead
|
|
220
|
-
url: Default
|
|
221
|
-
availability: pre-release
|
|
222
|
-
examples:
|
|
223
|
-
- path-parameters:
|
|
224
|
-
id: id
|
|
225
|
-
name: name
|
|
226
|
-
response:
|
|
227
|
-
body:
|
|
228
|
-
name: name
|
|
229
|
-
source: SYSTEM
|
|
230
|
-
history_item:
|
|
231
|
-
id: id
|
|
232
|
-
timestamp: '2024-01-15T09:30:00Z'
|
|
233
|
-
audiences:
|
|
234
|
-
- customers
|
|
235
|
-
update_deployment_release_tag:
|
|
236
|
-
path: /v1/deployments/{id}/release-tags/{name}
|
|
237
|
-
method: PATCH
|
|
238
|
-
auth: true
|
|
239
|
-
docs: >-
|
|
240
|
-
Updates an existing Release Tag associated with the specified Prompt
|
|
241
|
-
Deployment.
|
|
242
|
-
source:
|
|
243
|
-
openapi: openapi/openapi.yml
|
|
244
|
-
path-parameters:
|
|
245
|
-
id:
|
|
246
|
-
type: string
|
|
247
|
-
docs: A UUID string identifying this deployment.
|
|
248
|
-
name:
|
|
249
|
-
type: string
|
|
250
|
-
docs: >-
|
|
251
|
-
The name of the Release Tag associated with this Deployment that
|
|
252
|
-
you'd like to update.
|
|
253
|
-
request:
|
|
254
|
-
name: PatchedDeploymentReleaseTagUpdateRequest
|
|
255
|
-
body:
|
|
256
|
-
properties:
|
|
257
|
-
history_item_id:
|
|
258
|
-
type: optional<string>
|
|
259
|
-
docs: The ID of the Deployment History Item to tag
|
|
260
|
-
validation:
|
|
261
|
-
format: uuid
|
|
262
|
-
content-type: application/json
|
|
263
|
-
response:
|
|
264
|
-
docs: ''
|
|
265
|
-
type: root.DeploymentReleaseTagRead
|
|
266
|
-
url: Default
|
|
267
|
-
availability: pre-release
|
|
268
|
-
examples:
|
|
269
|
-
- path-parameters:
|
|
270
|
-
id: id
|
|
271
|
-
name: name
|
|
272
|
-
request: {}
|
|
273
|
-
response:
|
|
274
|
-
body:
|
|
275
|
-
name: name
|
|
276
|
-
source: SYSTEM
|
|
277
|
-
history_item:
|
|
278
|
-
id: id
|
|
279
|
-
timestamp: '2024-01-15T09:30:00Z'
|
|
280
|
-
audiences:
|
|
281
|
-
- customers
|
|
282
|
-
retrieve_provider_payload:
|
|
283
|
-
path: /v1/deployments/provider-payload
|
|
284
|
-
method: POST
|
|
285
|
-
auth: true
|
|
286
|
-
docs: >
|
|
287
|
-
Given a set of input variable values, compile the exact payload that
|
|
288
|
-
Vellum would send to the configured model provider
|
|
289
|
-
|
|
290
|
-
for execution if the execute-prompt endpoint had been invoked. Note that
|
|
291
|
-
this endpoint does not actually execute the
|
|
292
|
-
|
|
293
|
-
prompt or make an API call to the model provider.
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
This endpoint is useful if you don't want to proxy LLM provider requests
|
|
297
|
-
through Vellum and prefer to send them directly
|
|
298
|
-
|
|
299
|
-
to the provider yourself. Note that no guarantees are made on the format
|
|
300
|
-
of this API's response schema, other than
|
|
301
|
-
|
|
302
|
-
that it will be a valid payload for the configured model provider. It's
|
|
303
|
-
not recommended that you try to parse or
|
|
304
|
-
|
|
305
|
-
derive meaning from the response body and instead, should simply pass it
|
|
306
|
-
directly to the model provider as is.
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
We encourage you to seek advise from Vellum Support before integrating
|
|
310
|
-
with this API for production use.
|
|
311
|
-
source:
|
|
312
|
-
openapi: openapi/openapi.yml
|
|
313
|
-
request:
|
|
314
|
-
name: DeploymentProviderPayloadRequest
|
|
315
|
-
body:
|
|
316
|
-
properties:
|
|
317
|
-
deployment_id:
|
|
318
|
-
type: optional<string>
|
|
319
|
-
docs: >-
|
|
320
|
-
The ID of the deployment. Must provide either this or
|
|
321
|
-
deployment_name.
|
|
322
|
-
validation:
|
|
323
|
-
format: uuid
|
|
324
|
-
deployment_name:
|
|
325
|
-
type: optional<string>
|
|
326
|
-
docs: >-
|
|
327
|
-
The name of the deployment. Must provide either this or
|
|
328
|
-
deployment_id.
|
|
329
|
-
validation:
|
|
330
|
-
minLength: 1
|
|
331
|
-
inputs:
|
|
332
|
-
docs: >-
|
|
333
|
-
The list of inputs defined in the Prompt's deployment with their
|
|
334
|
-
corresponding values.
|
|
335
|
-
type: list<root.PromptDeploymentInputRequest>
|
|
336
|
-
release_tag:
|
|
337
|
-
type: optional<string>
|
|
338
|
-
docs: >-
|
|
339
|
-
Optionally specify a release tag if you want to pin to a
|
|
340
|
-
specific release of the Workflow Deployment
|
|
341
|
-
validation:
|
|
342
|
-
minLength: 1
|
|
343
|
-
expand_meta: optional<root.CompilePromptDeploymentExpandMetaRequest>
|
|
344
|
-
content-type: application/json
|
|
345
|
-
response:
|
|
346
|
-
docs: ''
|
|
347
|
-
type: root.DeploymentProviderPayloadResponse
|
|
348
|
-
url: Default
|
|
349
|
-
availability: pre-release
|
|
350
|
-
errors:
|
|
351
|
-
- root.BadRequestError
|
|
352
|
-
- root.ForbiddenError
|
|
353
|
-
- root.NotFoundError
|
|
354
|
-
- root.InternalServerError
|
|
355
|
-
examples:
|
|
356
|
-
- request:
|
|
357
|
-
inputs:
|
|
358
|
-
- name: name
|
|
359
|
-
type: STRING
|
|
360
|
-
value: value
|
|
361
|
-
response:
|
|
362
|
-
body:
|
|
363
|
-
payload:
|
|
364
|
-
key: value
|
|
365
|
-
meta:
|
|
366
|
-
model_name: model_name
|
|
367
|
-
deployment_release_tag: deployment_release_tag
|
|
368
|
-
prompt_version_id: prompt_version_id
|
|
369
|
-
audiences:
|
|
370
|
-
- customers
|
|
371
|
-
source:
|
|
372
|
-
openapi: openapi/openapi.yml
|