Skip to content

Update API specifications with fern api update #503

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.

Sign up for GitHub

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

Update API specifications with fern api update #503

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
149 changes: 143 additions & 6 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5278,6 +5278,10 @@
"type": "number",
"description": "This is the cost of Vapi."
},
"chat": {
"type": "number",
"description": "This is the cost of chat interactions."
},
"total": {
"type": "number",
"description": "This is the total cost of the call."
Expand Down Expand Up @@ -5623,6 +5627,10 @@
{
"$ref": "#/components/schemas/FallbackOpenAITranscriber",
"title": "OpenAI"
},
{
"$ref": "#/components/schemas/FallbackCartesiaTranscriber",
"title": "Cartesia"
}
]
}
Expand Down Expand Up @@ -5661,6 +5669,30 @@
"description": "Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false",
"example": false
},
"endOfTurnConfidenceThreshold": {
"type": "number",
"minimum": 0,
"maximum": 1,
"example": 0.7
},
"minEndOfTurnSilenceWhenConfident": {
"type": "number",
"description": "The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
"minimum": 0,
"example": 160
},
"wordFinalizationMaxWaitTime": {
"type": "number",
"description": "The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
"minimum": 0,
"example": 160
},
"maxTurnSilence": {
"type": "number",
"description": "The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400",
"minimum": 0,
"example": 400
},
"realtimeUrl": {
"type": "string",
"description": "The WebSocket URL that the transcriber connects to."
Expand Down Expand Up @@ -7101,6 +7133,30 @@
"description": "Uses Assembly AI's new Universal Streaming API. See: https://www.assemblyai.com/docs/speech-to-text/universal-streaming\n\n@default false",
"example": false
},
"endOfTurnConfidenceThreshold": {
"type": "number",
"minimum": 0,
"maximum": 1,
"example": 0.7
},
"minEndOfTurnSilenceWhenConfident": {
"type": "number",
"description": "The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
"minimum": 0,
"example": 160
},
"wordFinalizationMaxWaitTime": {
"type": "number",
"description": "The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.\n\n@default 160",
"minimum": 0,
"example": 160
},
"maxTurnSilence": {
"type": "number",
"description": "The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.\n\n@default 400",
"minimum": 0,
"example": 400
},
"realtimeUrl": {
"type": "string",
"description": "The WebSocket URL that the transcriber connects to."
Expand Down Expand Up @@ -12895,7 +12951,16 @@
},
"VariableExtractionPlan": {
"type": "object",
"properties": {}
"properties": {
"schema": {
"description": "This is the schema of parameters we want to extract from the response",
"allOf": [
{
"$ref": "#/components/schemas/JsonSchema"
}
]
}
}
},
"ConversationNode": {
"type": "object",
Expand Down Expand Up @@ -12962,6 +13027,10 @@
{
"$ref": "#/components/schemas/OpenAITranscriber",
"title": "OpenAITranscriber"
},
{
"$ref": "#/components/schemas/CartesiaTranscriber",
"title": "CartesiaTranscriber"
}
]
},
Expand Down Expand Up @@ -19291,6 +19360,10 @@
{
"$ref": "#/components/schemas/OpenAITranscriber",
"title": "OpenAITranscriber"
},
{
"$ref": "#/components/schemas/CartesiaTranscriber",
"title": "CartesiaTranscriber"
}
]
},
Expand Down Expand Up @@ -20060,6 +20133,10 @@
{
"$ref": "#/components/schemas/OpenAITranscriber",
"title": "OpenAITranscriber"
},
{
"$ref": "#/components/schemas/CartesiaTranscriber",
"title": "CartesiaTranscriber"
}
]
},
Expand Down Expand Up @@ -21254,6 +21331,7 @@
"assistant-request-returned-invalid-assistant",
"assistant-request-returned-no-assistant",
"assistant-request-returned-forwarding-phone-number",
"scheduled-call-deleted",
"call.start.error-get-org",
"call.start.error-get-subscription",
"call.start.error-get-assistant",
Expand All @@ -21264,6 +21342,7 @@
"call.start.error-vapi-number-outbound-daily-limit",
"call.start.error-get-transport",
"assistant-not-valid",
"unknown-error",
"database-error",
"assistant-not-found",
"pipeline-error-openai-voice-failed",
Expand Down Expand Up @@ -21330,7 +21409,6 @@
"call.in-progress.error-vapifault-azure-speech-transcriber-failed",
"call.in-progress.error-pipeline-no-available-llm-model",
"worker-shutdown",
"unknown-error",
"vonage-disconnected",
"vonage-failed-to-connect-call",
"vonage-completed",
Expand Down Expand Up @@ -22662,6 +22740,26 @@
"format": "date-time",
"type": "string",
"description": "This is the ISO 8601 date-time string of when the chat was last updated."
},
"costs": {
"type": "array",
"description": "These are the costs of individual components of the chat in USD.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ModelCost",
"title": "ModelCost"
},
{
"$ref": "#/components/schemas/ChatCost",
"title": "ChatCost"
}
]
}
},
"cost": {
"type": "number",
"description": "This is the cost of the chat in USD."
}
},
"required": [
Expand Down Expand Up @@ -23607,6 +23705,10 @@
{
"$ref": "#/components/schemas/OpenAITranscriber",
"title": "OpenAITranscriber"
},
{
"$ref": "#/components/schemas/CartesiaTranscriber",
"title": "CartesiaTranscriber"
}
]
},
Expand Down Expand Up @@ -24436,6 +24538,10 @@
{
"$ref": "#/components/schemas/OpenAITranscriber",
"title": "OpenAITranscriber"
},
{
"$ref": "#/components/schemas/CartesiaTranscriber",
"title": "CartesiaTranscriber"
}
]
},
Expand Down Expand Up @@ -28250,8 +28356,9 @@
},
"name": {
"type": "string",
"description": "This is the name of the tool. This will be passed to the model.",
"maxLength": 40
"description": "This is the name of the tool. This will be passed to the model.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.",
"maxLength": 40,
"pattern": "/^[a-zA-Z0-9_-]{1,40}$/"
},
"description": {
"type": "string",
Expand Down Expand Up @@ -28286,6 +28393,14 @@
}
]
},
"variableExtractionPlan": {
"description": "This is the plan that controls the variable extraction from the tool's response.",
"allOf": [
{
"$ref": "#/components/schemas/VariableExtractionPlan"
}
]
},
"function": {
"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.",
"allOf": [
Expand Down Expand Up @@ -38354,6 +38469,7 @@
"assistant-request-returned-invalid-assistant",
"assistant-request-returned-no-assistant",
"assistant-request-returned-forwarding-phone-number",
"scheduled-call-deleted",
"call.start.error-get-org",
"call.start.error-get-subscription",
"call.start.error-get-assistant",
Expand All @@ -38364,6 +38480,7 @@
"call.start.error-vapi-number-outbound-daily-limit",
"call.start.error-get-transport",
"assistant-not-valid",
"unknown-error",
"database-error",
"assistant-not-found",
"pipeline-error-openai-voice-failed",
Expand Down Expand Up @@ -38430,7 +38547,6 @@
"call.in-progress.error-vapifault-azure-speech-transcriber-failed",
"call.in-progress.error-pipeline-no-available-llm-model",
"worker-shutdown",
"unknown-error",
"vonage-disconnected",
"vonage-failed-to-connect-call",
"vonage-completed",
Expand Down Expand Up @@ -39474,6 +39590,7 @@
"assistant-request-returned-invalid-assistant",
"assistant-request-returned-no-assistant",
"assistant-request-returned-forwarding-phone-number",
"scheduled-call-deleted",
"call.start.error-get-org",
"call.start.error-get-subscription",
"call.start.error-get-assistant",
Expand All @@ -39484,6 +39601,7 @@
"call.start.error-vapi-number-outbound-daily-limit",
"call.start.error-get-transport",
"assistant-not-valid",
"unknown-error",
"database-error",
"assistant-not-found",
"pipeline-error-openai-voice-failed",
Expand Down Expand Up @@ -39550,7 +39668,6 @@
"call.in-progress.error-vapifault-azure-speech-transcriber-failed",
"call.in-progress.error-pipeline-no-available-llm-model",
"worker-shutdown",
"unknown-error",
"vonage-disconnected",
"vonage-failed-to-connect-call",
"vonage-completed",
Expand Down Expand Up @@ -41701,6 +41818,26 @@
"cost"
]
},
"ChatCost": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "This is the type of cost, always 'chat' for this class.",
"enum": [
"chat"
]
},
"cost": {
"type": "number",
"description": "This is the cost of the component in USD."
}
},
"required": [
"type",
"cost"
]
},
"FunctionToolWithToolCall": {
"type": "object",
"properties": {
Expand Down