diff --git a/fern/apis/api/openapi.json b/fern/apis/api/openapi.json index 05f4a0446..20a2c2a8b 100644 --- a/fern/apis/api/openapi.json +++ b/fern/apis/api/openapi.json @@ -2992,6 +2992,7 @@ "get": { "operationId": "LoggingController_logsQuery", "summary": "Get Logs", + "deprecated": true, "parameters": [ { "name": "type", @@ -3201,6 +3202,7 @@ "delete": { "operationId": "LoggingController_logsDeleteQuery", "summary": "Delete Logs", + "deprecated": true, "parameters": [ { "name": "type", @@ -7214,7 +7216,8 @@ "description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b", "enum": [ "grok-beta", - "grok-2" + "grok-2", + "grok-3" ] }, "provider": { @@ -7360,6 +7363,49 @@ } ] } + }, + "formattersEnabled": { + "type": "array", + "description": "List of formatters to apply. If not provided, all default formatters will be applied.\nIf provided, only the specified formatters will be applied.\nNote: Some essential formatters like angle bracket removal will always be applied.\n@default undefined", + "enum": [ + "markdown", + "asterisk", + "quote", + "dash", + "newline", + "colon", + "acronym", + "dollarAmount", + "email", + "date", + "time", + "distance", + "unit", + "percentage", + "phoneNumber", + "number" + ], + "items": { + "type": "string", + "enum": [ + "markdown", + "asterisk", + "quote", + "dash", + "newline", + "colon", + "acronym", + "dollarAmount", + "email", + "date", + "time", + "distance", + "unit", + "percentage", + "phoneNumber", + "number" + ] + } } } }, @@ -13233,8 +13279,10 @@ "pipeline-error-rime-ai-voice-failed", "pipeline-error-neets-voice-failed", "pipeline-error-smallest-ai-voice-failed", + "pipeline-error-neuphonic-voice-failed", "pipeline-error-deepgram-transcriber-failed", "pipeline-error-gladia-transcriber-failed", + "pipeline-error-speechmatics-transcriber-failed", "pipeline-error-assembly-ai-transcriber-failed", "pipeline-error-talkscriber-transcriber-failed", "pipeline-error-azure-speech-transcriber-failed", @@ -23154,115 +23202,6 @@ "role" ] }, - "OrgWithOrgUser": { - "type": "object", - "properties": { - "hipaaEnabled": { - "type": "boolean", - "description": "When this is enabled, no logs, recordings, or transcriptions will be stored. At the end of the call, you will still receive an end-of-call-report message to store on your server. Defaults to false.\nWhen HIPAA is enabled, only OpenAI/Custom LLM or Azure Providers will be available for LLM and Voice respectively.\nThis is due to the compliance requirements of HIPAA. Other providers may not meet these requirements.", - "example": false - }, - "subscription": { - "$ref": "#/components/schemas/Subscription" - }, - "subscriptionId": { - "type": "string", - "description": "This is the ID of the subscription the org belongs to." - }, - "id": { - "type": "string", - "description": "This is the unique identifier for the org." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the org was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the org was last updated." - }, - "stripeCustomerId": { - "type": "string", - "description": "This is the Stripe customer for the org." - }, - "stripeSubscriptionId": { - "type": "string", - "description": "This is the subscription for the org." - }, - "stripeSubscriptionItemId": { - "type": "string", - "description": "This is the subscription's subscription item." - }, - "stripeSubscriptionCurrentPeriodStart": { - "format": "date-time", - "type": "string", - "description": "This is the subscription's current period start." - }, - "stripeSubscriptionStatus": { - "type": "string", - "description": "This is the subscription's status." - }, - "plan": { - "description": "This is the plan for the org.", - "allOf": [ - { - "$ref": "#/components/schemas/OrgPlan" - } - ] - }, - "name": { - "type": "string", - "description": "This is the name of the org. This is just for your own reference.", - "maxLength": 40 - }, - "channel": { - "type": "string", - "description": "This is the channel of the org. There is the cluster the API traffic for the org will be directed.", - "enum": [ - "default", - "weekly" - ] - }, - "billingLimit": { - "type": "number", - "description": "This is the monthly billing limit for the org. To go beyond $1000/mo, please contact us at support@vapi.ai.", - "minimum": 0, - "maximum": 1000 - }, - "server": { - "description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server", - "allOf": [ - { - "$ref": "#/components/schemas/Server" - } - ] - }, - "concurrencyLimit": { - "type": "number", - "description": "This is the concurrency limit for the org. This is the maximum number of calls that can be active at any given time. To go beyond 10, please contact us at support@vapi.ai.", - "minimum": 1, - "maximum": 10 - }, - "invitedByUserId": { - "type": "string" - }, - "role": { - "type": "string", - "enum": [ - "admin", - "editor", - "viewer" - ] - } - }, - "required": [ - "id", - "createdAt", - "updatedAt" - ] - }, "UpdateUserRoleDTO": { "type": "object", "properties": { @@ -23349,6 +23288,7 @@ "deepgram", "lmnt", "neets", + "neuphonic", "openai", "playht", "rime-ai", @@ -24040,6 +23980,7 @@ "deepgram", "lmnt", "neets", + "neuphonic", "openai", "playht", "rime-ai", @@ -24056,6 +23997,7 @@ "deepgram", "lmnt", "neets", + "neuphonic", "openai", "playht", "rime-ai", @@ -24066,400 +24008,6 @@ } } }, - "Eval": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "This is the unique identifier for the evaluation." - }, - "orgId": { - "type": "string", - "description": "This is the unique identifier for the org that this evaluation belongs to." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the evaluation was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the evaluation was last updated." - }, - "name": { - "type": "string", - "description": "This is the name of the evaluation.", - "maxLength": 80 - }, - "phoneNumberId": { - "type": "string", - "description": "This is the phone number ID associated with this evaluation." - } - }, - "required": [ - "id", - "orgId", - "createdAt", - "updatedAt" - ] - }, - "EvalsPaginatedResponse": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Eval" - } - }, - "metadata": { - "$ref": "#/components/schemas/PaginationMeta" - } - }, - "required": [ - "results", - "metadata" - ] - }, - "CreateEvalDto": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "This is the name of the evaluation.", - "maxLength": 80 - }, - "phoneNumberId": { - "type": "string", - "description": "This is the phone number ID associated with this evaluation." - } - } - }, - "UpdateEvalDto": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "This is the name of the evaluation.", - "maxLength": 80 - }, - "phoneNumberId": { - "type": "string", - "description": "This is the phone number ID associated with this evaluation." - } - } - }, - "EvalTestVoice": { - "type": "object", - "properties": { - "scorers": { - "type": "array", - "description": "These are the scorers used to evaluate the test.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/EvalTestScorerAI", - "title": "AI" - } - ] - } - }, - "type": { - "type": "string", - "description": "This is the type of the test, which must be voice.", - "enum": [ - "voice" - ], - "maxLength": 100 - }, - "id": { - "type": "string", - "description": "This is the unique identifier for the test." - }, - "evalId": { - "type": "string", - "description": "This is the unique identifier for the evaluation this test belongs to." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the test was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the test was last updated." - }, - "name": { - "type": "string", - "description": "This is the name of the test.", - "maxLength": 80 - }, - "script": { - "type": "string", - "description": "This is the script to be used for the voice test.", - "maxLength": 10000 - }, - "attempts": { - "type": "number", - "description": "This is the number of attempts allowed for the test.", - "minimum": 1, - "maximum": 10 - } - }, - "required": [ - "scorers", - "type", - "id", - "evalId", - "createdAt", - "updatedAt", - "script", - "attempts" - ] - }, - "EvalTest": { - "type": "object", - "properties": { - "scorers": { - "type": "array", - "description": "These are the scorers used to evaluate the test.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/EvalTestScorerAI", - "title": "AI" - } - ] - } - }, - "type": { - "type": "string", - "description": "This is the type of the test, which must be voice.", - "enum": [ - "voice" - ], - "maxLength": 100 - }, - "id": { - "type": "string", - "description": "This is the unique identifier for the test." - }, - "evalId": { - "type": "string", - "description": "This is the unique identifier for the evaluation this test belongs to." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the test was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the test was last updated." - }, - "name": { - "type": "string", - "description": "This is the name of the test.", - "maxLength": 80 - }, - "script": { - "type": "string", - "description": "This is the script to be used for the voice test.", - "maxLength": 10000 - }, - "attempts": { - "type": "number", - "description": "This is the number of attempts allowed for the test.", - "minimum": 1, - "maximum": 10 - } - }, - "required": [ - "scorers", - "type", - "id", - "evalId", - "createdAt", - "updatedAt", - "script", - "attempts" - ] - }, - "EvalTestsPaginatedResponse": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EvalTest" - } - }, - "metadata": { - "$ref": "#/components/schemas/PaginationMeta" - } - }, - "required": [ - "results", - "metadata" - ] - }, - "EvalRunTestAttemptCall": { - "type": "object", - "properties": { - "artifact": { - "description": "This is the artifact associated with the call.", - "allOf": [ - { - "$ref": "#/components/schemas/Artifact" - } - ] - } - }, - "required": [ - "artifact" - ] - }, - "EvalRunScorer": { - "type": "object", - "properties": {} - }, - "EvalRunTestAttempt": { - "type": "object", - "properties": { - "call": { - "description": "This is the call made during the test attempt.", - "allOf": [ - { - "$ref": "#/components/schemas/EvalRunTestAttemptCall" - } - ] - }, - "scorers": { - "description": "These are the scorers used to evaluate the test attempt.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EvalRunScorer" - } - } - }, - "required": [ - "call", - "scorers" - ] - }, - "EvalRunTestResult": { - "type": "object", - "properties": { - "testId": { - "type": "string", - "description": "This is the unique identifier for the test." - }, - "attempts": { - "description": "These are the attempts made for this test.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EvalRunTestAttempt" - } - } - }, - "required": [ - "testId", - "attempts" - ] - }, - "EvalRun": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "This is the current status of the evaluation run.", - "enum": [ - "queued", - "in-progress", - "completed" - ] - }, - "id": { - "type": "string", - "description": "This is the unique identifier for the evaluation run." - }, - "evalId": { - "type": "string", - "description": "This is the unique identifier for the evaluation this run belongs to." - }, - "createdAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the evaluation run was created." - }, - "updatedAt": { - "format": "date-time", - "type": "string", - "description": "This is the ISO 8601 date-time string of when the evaluation run was last updated." - }, - "testResults": { - "description": "These are the results of the tests in this evaluation run.", - "type": "array", - "items": { - "$ref": "#/components/schemas/EvalRunTestResult" - } - }, - "name": { - "type": "string", - "description": "This is the name of the evaluation run.", - "maxLength": 80 - } - }, - "required": [ - "status", - "id", - "evalId", - "createdAt", - "updatedAt", - "testResults" - ] - }, - "EvalRunsPaginatedResponse": { - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EvalRun" - } - }, - "metadata": { - "$ref": "#/components/schemas/PaginationMeta" - } - }, - "required": [ - "results", - "metadata" - ] - }, - "CreateEvalRunDto": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "This is the name of the evaluation run.", - "maxLength": 80 - } - } - }, - "UpdateEvalRunDto": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "This is the name of the evaluation run.", - "maxLength": 80 - } - } - }, "ClientMessageWorkflowNodeStarted": { "type": "object", "properties": { @@ -25209,8 +24757,10 @@ "pipeline-error-rime-ai-voice-failed", "pipeline-error-neets-voice-failed", "pipeline-error-smallest-ai-voice-failed", + "pipeline-error-neuphonic-voice-failed", "pipeline-error-deepgram-transcriber-failed", "pipeline-error-gladia-transcriber-failed", + "pipeline-error-speechmatics-transcriber-failed", "pipeline-error-assembly-ai-transcriber-failed", "pipeline-error-talkscriber-transcriber-failed", "pipeline-error-azure-speech-transcriber-failed", @@ -26011,8 +25561,10 @@ "pipeline-error-rime-ai-voice-failed", "pipeline-error-neets-voice-failed", "pipeline-error-smallest-ai-voice-failed", + "pipeline-error-neuphonic-voice-failed", "pipeline-error-deepgram-transcriber-failed", "pipeline-error-gladia-transcriber-failed", + "pipeline-error-speechmatics-transcriber-failed", "pipeline-error-assembly-ai-transcriber-failed", "pipeline-error-talkscriber-transcriber-failed", "pipeline-error-azure-speech-transcriber-failed", @@ -27420,6 +26972,10 @@ "title": "SipTransferDestination" } ] + }, + "content": { + "type": "string", + "description": "This is the content to say." } }, "required": [