This repository was archived by the owner on Oct 15, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathBashTool.java
More file actions
414 lines (356 loc) · 17.1 KB
/
Copy pathBashTool.java
File metadata and controls
414 lines (356 loc) · 17.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/**
* This file was auto-generated by Fern from our API Definition.
*/
package com.vapi.api.types;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.vapi.api.core.ObjectMappers;
import java.time.OffsetDateTime;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import org.jetbrains.annotations.NotNull;
@JsonInclude(JsonInclude.Include.NON_ABSENT)
@JsonDeserialize(builder = BashTool.Builder.class)
public final class BashTool {
private final Optional<List<BashToolMessagesItem>> messages;
private final Optional<Server> server;
private final String id;
private final String orgId;
private final OffsetDateTime createdAt;
private final OffsetDateTime updatedAt;
private final Optional<OpenAiFunction> function;
private final Map<String, Object> additionalProperties;
private BashTool(
Optional<List<BashToolMessagesItem>> messages,
Optional<Server> server,
String id,
String orgId,
OffsetDateTime createdAt,
OffsetDateTime updatedAt,
Optional<OpenAiFunction> function,
Map<String, Object> additionalProperties) {
this.messages = messages;
this.server = server;
this.id = id;
this.orgId = orgId;
this.createdAt = createdAt;
this.updatedAt = updatedAt;
this.function = function;
this.additionalProperties = additionalProperties;
}
/**
* @return These are the messages that will be spoken to the user as the tool is running.
* <p>For some tools, this is auto-filled based on special fields like <code>tool.destinations</code>. For others like the function tool, these can be custom configured.</p>
*/
@JsonProperty("messages")
public Optional<List<BashToolMessagesItem>> getMessages() {
return messages;
}
/**
* @return The sub type of tool.
*/
@JsonProperty("subType")
public String getSubType() {
return "bash_20241022";
}
/**
* @return This is the server where a <code>tool-calls</code> webhook will be sent.
* <p>Notes:</p>
* <ul>
* <li>Webhook is sent to this server when a tool call is made.</li>
* <li>Webhook contains the call, assistant, and phone number objects.</li>
* <li>Webhook contains the variables set on the assistant.</li>
* <li>Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.</li>
* <li>Webhook expects a response with tool call result.</li>
* </ul>
*/
@JsonProperty("server")
public Optional<Server> getServer() {
return server;
}
/**
* @return This is the unique identifier for the tool.
*/
@JsonProperty("id")
public String getId() {
return id;
}
/**
* @return This is the unique identifier for the organization that this tool belongs to.
*/
@JsonProperty("orgId")
public String getOrgId() {
return orgId;
}
/**
* @return This is the ISO 8601 date-time string of when the tool was created.
*/
@JsonProperty("createdAt")
public OffsetDateTime getCreatedAt() {
return createdAt;
}
/**
* @return This is the ISO 8601 date-time string of when the tool was last updated.
*/
@JsonProperty("updatedAt")
public OffsetDateTime getUpdatedAt() {
return updatedAt;
}
/**
* @return This is the function definition of the tool.
* <p>For <code>endCall</code>, <code>transferCall</code>, and <code>dtmf</code> tools, this is auto-filled based on tool-specific fields like <code>tool.destinations</code>. But, even in those cases, you can provide a custom function definition for advanced use cases.</p>
* <p>An example of an advanced use case is if you want to customize the message that's spoken for <code>endCall</code> tool. You can specify a function where it returns an argument "reason". Then, in <code>messages</code> array, you can have many "request-complete" messages. One of these messages will be triggered if the <code>messages[].conditions</code> matches the "reason" argument.</p>
*/
@JsonProperty("function")
public Optional<OpenAiFunction> getFunction() {
return function;
}
/**
* @return The name of the tool, fixed to 'bash'
*/
@JsonProperty("name")
public String getName() {
return "bash";
}
@java.lang.Override
public boolean equals(Object other) {
if (this == other) return true;
return other instanceof BashTool && equalTo((BashTool) other);
}
@JsonAnyGetter
public Map<String, Object> getAdditionalProperties() {
return this.additionalProperties;
}
private boolean equalTo(BashTool other) {
return messages.equals(other.messages)
&& server.equals(other.server)
&& id.equals(other.id)
&& orgId.equals(other.orgId)
&& createdAt.equals(other.createdAt)
&& updatedAt.equals(other.updatedAt)
&& function.equals(other.function);
}
@java.lang.Override
public int hashCode() {
return Objects.hash(
this.messages, this.server, this.id, this.orgId, this.createdAt, this.updatedAt, this.function);
}
@java.lang.Override
public String toString() {
return ObjectMappers.stringify(this);
}
public static IdStage builder() {
return new Builder();
}
public interface IdStage {
/**
* <p>This is the unique identifier for the tool.</p>
*/
OrgIdStage id(@NotNull String id);
Builder from(BashTool other);
}
public interface OrgIdStage {
/**
* <p>This is the unique identifier for the organization that this tool belongs to.</p>
*/
CreatedAtStage orgId(@NotNull String orgId);
}
public interface CreatedAtStage {
/**
* <p>This is the ISO 8601 date-time string of when the tool was created.</p>
*/
UpdatedAtStage createdAt(@NotNull OffsetDateTime createdAt);
}
public interface UpdatedAtStage {
/**
* <p>This is the ISO 8601 date-time string of when the tool was last updated.</p>
*/
_FinalStage updatedAt(@NotNull OffsetDateTime updatedAt);
}
public interface _FinalStage {
BashTool build();
/**
* <p>These are the messages that will be spoken to the user as the tool is running.</p>
* <p>For some tools, this is auto-filled based on special fields like <code>tool.destinations</code>. For others like the function tool, these can be custom configured.</p>
*/
_FinalStage messages(Optional<List<BashToolMessagesItem>> messages);
_FinalStage messages(List<BashToolMessagesItem> messages);
/**
* <p>This is the server where a <code>tool-calls</code> webhook will be sent.</p>
* <p>Notes:</p>
* <ul>
* <li>Webhook is sent to this server when a tool call is made.</li>
* <li>Webhook contains the call, assistant, and phone number objects.</li>
* <li>Webhook contains the variables set on the assistant.</li>
* <li>Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.</li>
* <li>Webhook expects a response with tool call result.</li>
* </ul>
*/
_FinalStage server(Optional<Server> server);
_FinalStage server(Server server);
/**
* <p>This is the function definition of the tool.</p>
* <p>For <code>endCall</code>, <code>transferCall</code>, and <code>dtmf</code> tools, this is auto-filled based on tool-specific fields like <code>tool.destinations</code>. But, even in those cases, you can provide a custom function definition for advanced use cases.</p>
* <p>An example of an advanced use case is if you want to customize the message that's spoken for <code>endCall</code> tool. You can specify a function where it returns an argument "reason". Then, in <code>messages</code> array, you can have many "request-complete" messages. One of these messages will be triggered if the <code>messages[].conditions</code> matches the "reason" argument.</p>
*/
_FinalStage function(Optional<OpenAiFunction> function);
_FinalStage function(OpenAiFunction function);
}
@JsonIgnoreProperties(ignoreUnknown = true)
public static final class Builder implements IdStage, OrgIdStage, CreatedAtStage, UpdatedAtStage, _FinalStage {
private String id;
private String orgId;
private OffsetDateTime createdAt;
private OffsetDateTime updatedAt;
private Optional<OpenAiFunction> function = Optional.empty();
private Optional<Server> server = Optional.empty();
private Optional<List<BashToolMessagesItem>> messages = Optional.empty();
@JsonAnySetter
private Map<String, Object> additionalProperties = new HashMap<>();
private Builder() {}
@java.lang.Override
public Builder from(BashTool other) {
messages(other.getMessages());
server(other.getServer());
id(other.getId());
orgId(other.getOrgId());
createdAt(other.getCreatedAt());
updatedAt(other.getUpdatedAt());
function(other.getFunction());
return this;
}
/**
* <p>This is the unique identifier for the tool.</p>
* <p>This is the unique identifier for the tool.</p>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
@JsonSetter("id")
public OrgIdStage id(@NotNull String id) {
this.id = Objects.requireNonNull(id, "id must not be null");
return this;
}
/**
* <p>This is the unique identifier for the organization that this tool belongs to.</p>
* <p>This is the unique identifier for the organization that this tool belongs to.</p>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
@JsonSetter("orgId")
public CreatedAtStage orgId(@NotNull String orgId) {
this.orgId = Objects.requireNonNull(orgId, "orgId must not be null");
return this;
}
/**
* <p>This is the ISO 8601 date-time string of when the tool was created.</p>
* <p>This is the ISO 8601 date-time string of when the tool was created.</p>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
@JsonSetter("createdAt")
public UpdatedAtStage createdAt(@NotNull OffsetDateTime createdAt) {
this.createdAt = Objects.requireNonNull(createdAt, "createdAt must not be null");
return this;
}
/**
* <p>This is the ISO 8601 date-time string of when the tool was last updated.</p>
* <p>This is the ISO 8601 date-time string of when the tool was last updated.</p>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
@JsonSetter("updatedAt")
public _FinalStage updatedAt(@NotNull OffsetDateTime updatedAt) {
this.updatedAt = Objects.requireNonNull(updatedAt, "updatedAt must not be null");
return this;
}
/**
* <p>This is the function definition of the tool.</p>
* <p>For <code>endCall</code>, <code>transferCall</code>, and <code>dtmf</code> tools, this is auto-filled based on tool-specific fields like <code>tool.destinations</code>. But, even in those cases, you can provide a custom function definition for advanced use cases.</p>
* <p>An example of an advanced use case is if you want to customize the message that's spoken for <code>endCall</code> tool. You can specify a function where it returns an argument "reason". Then, in <code>messages</code> array, you can have many "request-complete" messages. One of these messages will be triggered if the <code>messages[].conditions</code> matches the "reason" argument.</p>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
public _FinalStage function(OpenAiFunction function) {
this.function = Optional.ofNullable(function);
return this;
}
/**
* <p>This is the function definition of the tool.</p>
* <p>For <code>endCall</code>, <code>transferCall</code>, and <code>dtmf</code> tools, this is auto-filled based on tool-specific fields like <code>tool.destinations</code>. But, even in those cases, you can provide a custom function definition for advanced use cases.</p>
* <p>An example of an advanced use case is if you want to customize the message that's spoken for <code>endCall</code> tool. You can specify a function where it returns an argument "reason". Then, in <code>messages</code> array, you can have many "request-complete" messages. One of these messages will be triggered if the <code>messages[].conditions</code> matches the "reason" argument.</p>
*/
@java.lang.Override
@JsonSetter(value = "function", nulls = Nulls.SKIP)
public _FinalStage function(Optional<OpenAiFunction> function) {
this.function = function;
return this;
}
/**
* <p>This is the server where a <code>tool-calls</code> webhook will be sent.</p>
* <p>Notes:</p>
* <ul>
* <li>Webhook is sent to this server when a tool call is made.</li>
* <li>Webhook contains the call, assistant, and phone number objects.</li>
* <li>Webhook contains the variables set on the assistant.</li>
* <li>Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.</li>
* <li>Webhook expects a response with tool call result.</li>
* </ul>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
public _FinalStage server(Server server) {
this.server = Optional.ofNullable(server);
return this;
}
/**
* <p>This is the server where a <code>tool-calls</code> webhook will be sent.</p>
* <p>Notes:</p>
* <ul>
* <li>Webhook is sent to this server when a tool call is made.</li>
* <li>Webhook contains the call, assistant, and phone number objects.</li>
* <li>Webhook contains the variables set on the assistant.</li>
* <li>Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}.</li>
* <li>Webhook expects a response with tool call result.</li>
* </ul>
*/
@java.lang.Override
@JsonSetter(value = "server", nulls = Nulls.SKIP)
public _FinalStage server(Optional<Server> server) {
this.server = server;
return this;
}
/**
* <p>These are the messages that will be spoken to the user as the tool is running.</p>
* <p>For some tools, this is auto-filled based on special fields like <code>tool.destinations</code>. For others like the function tool, these can be custom configured.</p>
* @return Reference to {@code this} so that method calls can be chained together.
*/
@java.lang.Override
public _FinalStage messages(List<BashToolMessagesItem> messages) {
this.messages = Optional.ofNullable(messages);
return this;
}
/**
* <p>These are the messages that will be spoken to the user as the tool is running.</p>
* <p>For some tools, this is auto-filled based on special fields like <code>tool.destinations</code>. For others like the function tool, these can be custom configured.</p>
*/
@java.lang.Override
@JsonSetter(value = "messages", nulls = Nulls.SKIP)
public _FinalStage messages(Optional<List<BashToolMessagesItem>> messages) {
this.messages = messages;
return this;
}
@java.lang.Override
public BashTool build() {
return new BashTool(messages, server, id, orgId, createdAt, updatedAt, function, additionalProperties);
}
}
}