Skip to content

Update API specifications with fern api update #459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 103 additions & 17 deletions fern/apis/api/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -5470,6 +5470,26 @@
}
}
},
"NodeArtifact": {
"type": "object",
"properties": {
"nodeName": {
"type": "string",
"description": "This is the node id."
},
"messages": {
"description": "This is the messages that were spoken during the node.",
"type": "array",
"items": {
"type": "object"
}
},
"variables": {
"type": "object",
"description": "This is the object containing the variables extracted from the node."
}
}
},
"Artifact": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -5543,6 +5563,17 @@
"pcapUrl": {
"type": "string",
"description": "This is the packet capture url for the call. This is only available for `phone` type calls where phone number's provider is `vapi` or `byo-phone-number`."
},
"nodes": {
"description": "This is the history of workflow nodes that were executed during the call.",
"type": "array",
"items": {
"$ref": "#/components/schemas/NodeArtifact"
}
},
"variables": {
"type": "object",
"description": "This is the state of variables at the end of the workflow execution."
}
}
},
Expand Down Expand Up @@ -8606,10 +8637,6 @@
"type": "string"
}
},
"regex": {
"type": "string",
"description": "This is a regex that will be used to validate data in question."
},
"value": {
"type": "string",
"description": "This the value that will be used in filling the property."
Expand Down Expand Up @@ -11923,6 +11950,14 @@
]
}
},
"toolStrictCompatibilityMode": {
"type": "string",
"description": "Azure OpenAI doesn't support `maxLength` right now https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/structured-outputs?tabs=python-secure%2Cdotnet-entra-id&pivots=programming-language-csharp#unsupported-type-specific-keywords. Need to strip.\n\n- `strip-parameters-with-unsupported-validation` will strip parameters with unsupported validation.\n- `strip-unsupported-validation` will keep the parameters but strip unsupported validation.\n\n@default `strip-unsupported-validation`",
"enum": [
"strip-parameters-with-unsupported-validation",
"strip-unsupported-validation"
]
},
"temperature": {
"type": "number",
"description": "This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.",
Expand Down Expand Up @@ -13026,7 +13061,6 @@
}
},
"model": {
"description": "These are the options for the workflow's LLM.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowOpenAIModel",
Expand All @@ -13047,6 +13081,10 @@
"items": {
"$ref": "#/components/schemas/Edge"
}
},
"globalPrompt": {
"type": "string",
"maxLength": 5000
}
},
"required": [
Expand Down Expand Up @@ -20595,7 +20633,6 @@
}
},
"model": {
"description": "These are the options for the workflow's LLM.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowOpenAIModel",
Expand All @@ -20616,6 +20653,10 @@
"items": {
"$ref": "#/components/schemas/Edge"
}
},
"globalPrompt": {
"type": "string",
"maxLength": 5000
}
},
"required": [
Expand Down Expand Up @@ -21056,6 +21097,7 @@
"call.in-progress.error-vapifault-transport-never-connected",
"call.in-progress.error-vapifault-transport-connected-but-call-not-active",
"call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing",
"call.in-progress.error-vapifault-worker-died",
"call.in-progress.error-vapifault-openai-llm-failed",
"call.in-progress.error-vapifault-azure-openai-llm-failed",
"call.in-progress.error-vapifault-groq-llm-failed",
Expand Down Expand Up @@ -21443,7 +21485,12 @@
"phone-call-provider-closed-websocket",
"call.forwarding.operator-busy",
"silence-timed-out",
"call.in-progress.error-sip-telephony-provider-failed-to-connect-call",
"call.in-progress.error-sip-inbound-call-failed-to-connect",
"call.in-progress.error-providerfault-outbound-sip-403-forbidden",
"call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required",
"call.in-progress.error-providerfault-outbound-sip-503-service-unavailable",
"call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable",
"call.in-progress.error-sip-outbound-call-failed-to-connect",
"call.ringing.hook-executed-say",
"call.ringing.hook-executed-transfer",
"twilio-failed-to-connect-call",
Expand Down Expand Up @@ -22923,12 +22970,19 @@
"maxLength": 40
},
"status": {
"type": "string",
"description": "This is the current status of the session. Can be either 'active' or 'completed'.",
"enum": [
"active",
"completed"
],
"type": "string"
]
},
"expirationSeconds": {
"type": "number",
"description": "Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.",
"minimum": 60,
"maximum": 2592000,
"example": 86400
},
"assistantId": {
"type": "string",
Expand Down Expand Up @@ -23007,12 +23061,19 @@
"maxLength": 40
},
"status": {
"type": "string",
"description": "This is the current status of the session. Can be either 'active' or 'completed'.",
"enum": [
"active",
"completed"
],
"type": "string"
]
},
"expirationSeconds": {
"type": "number",
"description": "Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.",
"minimum": 60,
"maximum": 2592000,
"example": 86400
},
"assistantId": {
"type": "string",
Expand Down Expand Up @@ -23085,12 +23146,19 @@
"maxLength": 40
},
"status": {
"type": "string",
"description": "This is the new status for the session.",
"enum": [
"active",
"completed"
],
"type": "string"
]
},
"expirationSeconds": {
"type": "number",
"description": "Session expiration time in seconds. Defaults to 24 hours (86400 seconds) if not set.",
"minimum": 60,
"maximum": 2592000,
"example": 86400
},
"messages": {
"type": "array",
Expand Down Expand Up @@ -29577,7 +29645,6 @@
}
},
"model": {
"description": "These are the options for the workflow's LLM.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowOpenAIModel",
Expand Down Expand Up @@ -29612,6 +29679,10 @@
"items": {
"$ref": "#/components/schemas/Edge"
}
},
"globalPrompt": {
"type": "string",
"maxLength": 5000
}
},
"required": [
Expand Down Expand Up @@ -29643,7 +29714,6 @@
}
},
"model": {
"description": "These are the options for the workflow's LLM.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowOpenAIModel",
Expand All @@ -29664,6 +29734,10 @@
"items": {
"$ref": "#/components/schemas/Edge"
}
},
"globalPrompt": {
"type": "string",
"maxLength": 5000
}
}
},
Expand Down Expand Up @@ -38088,6 +38162,7 @@
"call.in-progress.error-vapifault-transport-never-connected",
"call.in-progress.error-vapifault-transport-connected-but-call-not-active",
"call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing",
"call.in-progress.error-vapifault-worker-died",
"call.in-progress.error-vapifault-openai-llm-failed",
"call.in-progress.error-vapifault-azure-openai-llm-failed",
"call.in-progress.error-vapifault-groq-llm-failed",
Expand Down Expand Up @@ -38475,7 +38550,12 @@
"phone-call-provider-closed-websocket",
"call.forwarding.operator-busy",
"silence-timed-out",
"call.in-progress.error-sip-telephony-provider-failed-to-connect-call",
"call.in-progress.error-sip-inbound-call-failed-to-connect",
"call.in-progress.error-providerfault-outbound-sip-403-forbidden",
"call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required",
"call.in-progress.error-providerfault-outbound-sip-503-service-unavailable",
"call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable",
"call.in-progress.error-sip-outbound-call-failed-to-connect",
"call.ringing.hook-executed-say",
"call.ringing.hook-executed-transfer",
"twilio-failed-to-connect-call",
Expand Down Expand Up @@ -39199,6 +39279,7 @@
"call.in-progress.error-vapifault-transport-never-connected",
"call.in-progress.error-vapifault-transport-connected-but-call-not-active",
"call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing",
"call.in-progress.error-vapifault-worker-died",
"call.in-progress.error-vapifault-openai-llm-failed",
"call.in-progress.error-vapifault-azure-openai-llm-failed",
"call.in-progress.error-vapifault-groq-llm-failed",
Expand Down Expand Up @@ -39586,7 +39667,12 @@
"phone-call-provider-closed-websocket",
"call.forwarding.operator-busy",
"silence-timed-out",
"call.in-progress.error-sip-telephony-provider-failed-to-connect-call",
"call.in-progress.error-sip-inbound-call-failed-to-connect",
"call.in-progress.error-providerfault-outbound-sip-403-forbidden",
"call.in-progress.error-providerfault-outbound-sip-407-proxy-authentication-required",
"call.in-progress.error-providerfault-outbound-sip-503-service-unavailable",
"call.in-progress.error-providerfault-outbound-sip-480-temporarily-unavailable",
"call.in-progress.error-sip-outbound-call-failed-to-connect",
"call.ringing.hook-executed-say",
"call.ringing.hook-executed-transfer",
"twilio-failed-to-connect-call",
Expand Down