Skip to content

Commit c9712d5

Browse files
fern-api[bot]fern-api[bot]
committed
feat(openapi): add new tool types and improve tool configuration
1 parent 554a319 commit c9712d5

File tree

1 file changed

+257
-0
lines changed

1 file changed

+257
-0
lines changed

‎fern/apis/api/openapi.json‎

Lines changed: 257 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26601,6 +26601,263 @@
2660126601
"metadata"
2660226602
]
2660326603
},
26604+
"BashToolWithToolCall": {
26605+
"type": "object",
26606+
"properties": {
26607+
"async": {
26608+
"type": "boolean",
26609+
"description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
26610+
"example": false
26611+
},
26612+
"messages": {
26613+
"type": "array",
26614+
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
26615+
"items": {
26616+
"oneOf": [
26617+
{
26618+
"$ref": "#/components/schemas/ToolMessageStart",
26619+
"title": "ToolMessageStart"
26620+
},
26621+
{
26622+
"$ref": "#/components/schemas/ToolMessageComplete",
26623+
"title": "ToolMessageComplete"
26624+
},
26625+
{
26626+
"$ref": "#/components/schemas/ToolMessageFailed",
26627+
"title": "ToolMessageFailed"
26628+
},
26629+
{
26630+
"$ref": "#/components/schemas/ToolMessageDelayed",
26631+
"title": "ToolMessageDelayed"
26632+
}
26633+
]
26634+
}
26635+
},
26636+
"type": {
26637+
"type": "string",
26638+
"enum": [
26639+
"bash"
26640+
],
26641+
"description": "The type of tool. \"bash\" for Bash tool."
26642+
},
26643+
"subType": {
26644+
"type": "string",
26645+
"enum": [
26646+
"bash_20241022"
26647+
],
26648+
"description": "The sub type of tool."
26649+
},
26650+
"toolCall": {
26651+
"$ref": "#/components/schemas/ToolCall"
26652+
},
26653+
"name": {
26654+
"type": "string",
26655+
"description": "The name of the tool, fixed to 'bash'",
26656+
"default": "bash",
26657+
"enum": [
26658+
"bash"
26659+
]
26660+
},
26661+
"function": {
26662+
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
26663+
"allOf": [
26664+
{
26665+
"$ref": "#/components/schemas/OpenAIFunction"
26666+
}
26667+
]
26668+
},
26669+
"server": {
26670+
"description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.",
26671+
"allOf": [
26672+
{
26673+
"$ref": "#/components/schemas/Server"
26674+
}
26675+
]
26676+
}
26677+
},
26678+
"required": [
26679+
"type",
26680+
"subType",
26681+
"toolCall",
26682+
"name"
26683+
]
26684+
},
26685+
"ComputerToolWithToolCall": {
26686+
"type": "object",
26687+
"properties": {
26688+
"async": {
26689+
"type": "boolean",
26690+
"description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
26691+
"example": false
26692+
},
26693+
"messages": {
26694+
"type": "array",
26695+
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
26696+
"items": {
26697+
"oneOf": [
26698+
{
26699+
"$ref": "#/components/schemas/ToolMessageStart",
26700+
"title": "ToolMessageStart"
26701+
},
26702+
{
26703+
"$ref": "#/components/schemas/ToolMessageComplete",
26704+
"title": "ToolMessageComplete"
26705+
},
26706+
{
26707+
"$ref": "#/components/schemas/ToolMessageFailed",
26708+
"title": "ToolMessageFailed"
26709+
},
26710+
{
26711+
"$ref": "#/components/schemas/ToolMessageDelayed",
26712+
"title": "ToolMessageDelayed"
26713+
}
26714+
]
26715+
}
26716+
},
26717+
"type": {
26718+
"type": "string",
26719+
"enum": [
26720+
"computer"
26721+
],
26722+
"description": "The type of tool. \"computer\" for Computer tool."
26723+
},
26724+
"subType": {
26725+
"type": "string",
26726+
"enum": [
26727+
"computer_20241022"
26728+
],
26729+
"description": "The sub type of tool."
26730+
},
26731+
"toolCall": {
26732+
"$ref": "#/components/schemas/ToolCall"
26733+
},
26734+
"name": {
26735+
"type": "string",
26736+
"description": "The name of the tool, fixed to 'computer'",
26737+
"default": "computer",
26738+
"enum": [
26739+
"computer"
26740+
]
26741+
},
26742+
"displayWidthPx": {
26743+
"type": "number",
26744+
"description": "The display width in pixels"
26745+
},
26746+
"displayHeightPx": {
26747+
"type": "number",
26748+
"description": "The display height in pixels"
26749+
},
26750+
"displayNumber": {
26751+
"type": "number",
26752+
"description": "Optional display number"
26753+
},
26754+
"function": {
26755+
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
26756+
"allOf": [
26757+
{
26758+
"$ref": "#/components/schemas/OpenAIFunction"
26759+
}
26760+
]
26761+
},
26762+
"server": {
26763+
"description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.",
26764+
"allOf": [
26765+
{
26766+
"$ref": "#/components/schemas/Server"
26767+
}
26768+
]
26769+
}
26770+
},
26771+
"required": [
26772+
"type",
26773+
"subType",
26774+
"toolCall",
26775+
"name",
26776+
"displayWidthPx",
26777+
"displayHeightPx"
26778+
]
26779+
},
26780+
"TextEditorToolWithToolCall": {
26781+
"type": "object",
26782+
"properties": {
26783+
"async": {
26784+
"type": "boolean",
26785+
"description": "This determines if the tool is async.\n\nIf async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server.\n\nIf sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server.\n\nDefaults to synchronous (`false`).",
26786+
"example": false
26787+
},
26788+
"messages": {
26789+
"type": "array",
26790+
"description": "These are the messages that will be spoken to the user as the tool is running.\n\nFor some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.",
26791+
"items": {
26792+
"oneOf": [
26793+
{
26794+
"$ref": "#/components/schemas/ToolMessageStart",
26795+
"title": "ToolMessageStart"
26796+
},
26797+
{
26798+
"$ref": "#/components/schemas/ToolMessageComplete",
26799+
"title": "ToolMessageComplete"
26800+
},
26801+
{
26802+
"$ref": "#/components/schemas/ToolMessageFailed",
26803+
"title": "ToolMessageFailed"
26804+
},
26805+
{
26806+
"$ref": "#/components/schemas/ToolMessageDelayed",
26807+
"title": "ToolMessageDelayed"
26808+
}
26809+
]
26810+
}
26811+
},
26812+
"type": {
26813+
"type": "string",
26814+
"enum": [
26815+
"textEditor"
26816+
],
26817+
"description": "The type of tool. \"textEditor\" for Text Editor tool."
26818+
},
26819+
"subType": {
26820+
"type": "string",
26821+
"enum": [
26822+
"text_editor_20241022"
26823+
],
26824+
"description": "The sub type of tool."
26825+
},
26826+
"toolCall": {
26827+
"$ref": "#/components/schemas/ToolCall"
26828+
},
26829+
"name": {
26830+
"type": "string",
26831+
"description": "The name of the tool, fixed to 'str_replace_editor'",
26832+
"default": "str_replace_editor",
26833+
"enum": [
26834+
"str_replace_editor"
26835+
]
26836+
},
26837+
"function": {
26838+
"description": "This is the function definition of the tool.\n\nFor `endCall`, `transferCall`, and `dtmf` tools, this is auto-filled based on tool-specific fields like `tool.destinations`. But, even in those cases, you can provide a custom function definition for advanced use cases.\n\nAn example of an advanced use case is if you want to customize the message that's spoken for `endCall` tool. You can specify a function where it returns an argument \"reason\". Then, in `messages` array, you can have many \"request-complete\" messages. One of these messages will be triggered if the `messages[].conditions` matches the \"reason\" argument.",
26839+
"allOf": [
26840+
{
26841+
"$ref": "#/components/schemas/OpenAIFunction"
26842+
}
26843+
]
26844+
},
26845+
"server": {
26846+
"description": "This is the server that will be hit when this tool is requested by the model.\n\nAll requests will be sent with the call object among other things. You can find more details in the Server URL documentation.\n\nThis overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.",
26847+
"allOf": [
26848+
{
26849+
"$ref": "#/components/schemas/Server"
26850+
}
26851+
]
26852+
}
26853+
},
26854+
"required": [
26855+
"type",
26856+
"subType",
26857+
"toolCall",
26858+
"name"
26859+
]
26860+
},
2660426861
"StepDestination": {
2660526862
"type": "object",
2660626863
"properties": {

0 commit comments

Comments
 (0)