Skip to content

Update API specifications with fern api update #794

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

Closed
wants to merge 1 commit into from
Closed

Update API specifications with fern api update #794

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
151 changes: 151 additions & 0 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4386,6 +4386,50 @@
]
}
},
"/structured-output/suggest": {
"post": {
"operationId": "StructuredOutputController_suggest",
"summary": "Generate AI-Powered Structured Output Suggestions",
"description": "Analyzes assistant configuration and generates contextual structured output recommendations",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateStructuredOutputSuggestionsDTO"
}
}
}
},
"responses": {
"200": {
"description": "Array of suggested structured outputs with relevance scores"
},
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"tags": [
"Structured Outputs"
],
"security": [
{
"bearer": []
}
]
}
},
"/reporting/insight": {
"post": {
"operationId": "InsightController_create",
Expand Down Expand Up @@ -7908,6 +7952,17 @@
"maximum": 50,
"default": 2
},
"speakerLabels": {
"description": "Provides friendly speaker labels that map to diarization indices (Speaker 1 -> labels[0]).",
"example": [
"Agent",
"Customer"
],
"type": "array",
"items": {
"type": "string"
}
},
"enablePartials": {
"type": "boolean",
"description": "This enables partial transcripts during speech recognition. When false, only final transcripts are returned.\n\n@default true",
Expand Down Expand Up @@ -9705,6 +9760,17 @@
"maximum": 50,
"default": 2
},
"speakerLabels": {
"description": "Provides friendly speaker labels that map to diarization indices (Speaker 1 -> labels[0]).",
"example": [
"Agent",
"Customer"
],
"type": "array",
"items": {
"type": "string"
}
},
"enablePartials": {
"type": "boolean",
"description": "This enables partial transcripts during speech recognition. When false, only final transcripts are returned.\n\n@default true",
Expand Down Expand Up @@ -30705,6 +30771,14 @@
"type": "number",
"description": "This is the average latency for complete turns."
},
"fromTransportLatencyAverage": {
"type": "number",
"description": "This is the average latency for packets received from the transport provider in milliseconds."
},
"toTransportLatencyAverage": {
"type": "number",
"description": "This is the average latency for packets sent to the transport provider in milliseconds."
},
"numUserInterrupted": {
"type": "number",
"description": "This is the number of times the user was interrupted by the assistant during the call."
Expand Down Expand Up @@ -39708,6 +39782,16 @@
"providerId"
]
},
"ComplianceOverride": {
"type": "object",
"properties": {
"forceStoreOnHipaaEnabled": {
"type": "boolean",
"description": "Force storage for this output under HIPAA. Only enable if output contains no sensitive data.",
"example": false
}
}
},
"StructuredOutput": {
"type": "object",
"properties": {
Expand All @@ -39732,6 +39816,17 @@
}
]
},
"compliancePlan": {
"description": "Compliance configuration for this output. Only enable overrides if no sensitive data will be stored.",
"example": {
"forceStoreOnHipaaEnabled": false
},
"allOf": [
{
"$ref": "#/components/schemas/ComplianceOverride"
}
]
},
"id": {
"type": "string",
"description": "This is the unique identifier for the structured output."
Expand Down Expand Up @@ -39834,6 +39929,17 @@
}
]
},
"compliancePlan": {
"description": "Compliance configuration for this output. Only enable overrides if no sensitive data will be stored.",
"example": {
"forceStoreOnHipaaEnabled": false
},
"allOf": [
{
"$ref": "#/components/schemas/ComplianceOverride"
}
]
},
"name": {
"type": "string",
"description": "This is the name of the structured output.",
Expand Down Expand Up @@ -39896,6 +40002,17 @@
}
]
},
"compliancePlan": {
"description": "Compliance configuration for this output. Only enable overrides if no sensitive data will be stored.",
"example": {
"forceStoreOnHipaaEnabled": false
},
"allOf": [
{
"$ref": "#/components/schemas/ComplianceOverride"
}
]
},
"name": {
"type": "string",
"description": "This is the name of the structured output.",
Expand Down Expand Up @@ -39962,6 +40079,40 @@
"callIds"
]
},
"GenerateStructuredOutputSuggestionsDTO": {
"type": "object",
"properties": {
"assistantId": {
"type": "string",
"description": "The assistant ID to analyze and generate suggestions for",
"example": "550e8400-e29b-41d4-a716-446655440000"
},
"count": {
"type": "number",
"description": "Number of suggestions to generate",
"minimum": 1,
"maximum": 10,
"default": 6
},
"excludeIds": {
"description": "Existing structured output IDs to exclude from suggestions",
"type": "array",
"items": {
"type": "string"
}
},
"seed": {
"type": "number",
"description": "Iteration/seed for generating diverse suggestions (0 = first generation, 1+ = regenerations with increasing specificity)",
"minimum": 0,
"maximum": 10,
"default": 0
}
},
"required": [
"assistantId"
]
},
"TesterPlan": {
"type": "object",
"properties": {
Expand Down