Skip to content

Commit f82f604

Browse files
dsinghvisahil485
andauthored
Update fern definition (#1346)
Co-authored-by: sahil485 <[email protected]>
1 parent 9e2251e commit f82f604

File tree

1 file changed

+146
-1
lines changed

1 file changed

+146
-1
lines changed

fern/apis/fai/openapi.json

Lines changed: 146 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,95 @@
275275
]
276276
}
277277
},
278+
"/analytics/resolution/{domain}": {
279+
"get": {
280+
"tags": [
281+
"Analytics"
282+
],
283+
"summary": "Get Conversation Resolution",
284+
"description": "Get conversation resolution metrics for a domain in a given time period.",
285+
"operationId": "get_conversation_resolution",
286+
"parameters": [
287+
{
288+
"name": "domain",
289+
"in": "path",
290+
"required": true,
291+
"schema": {
292+
"type": "string",
293+
"title": "Domain"
294+
}
295+
},
296+
{
297+
"name": "start_date",
298+
"in": "query",
299+
"required": false,
300+
"schema": {
301+
"anyOf": [
302+
{
303+
"type": "string",
304+
"format": "date-time"
305+
},
306+
{
307+
"type": "null"
308+
}
309+
],
310+
"description": "The start date of the period to retrieve resolution metrics for",
311+
"title": "Start Date"
312+
},
313+
"description": "The start date of the period to retrieve resolution metrics for"
314+
},
315+
{
316+
"name": "end_date",
317+
"in": "query",
318+
"required": false,
319+
"schema": {
320+
"anyOf": [
321+
{
322+
"type": "string",
323+
"format": "date-time"
324+
},
325+
{
326+
"type": "null"
327+
}
328+
],
329+
"description": "The end date of the period to retrieve resolution metrics for",
330+
"title": "End Date"
331+
},
332+
"description": "The end date of the period to retrieve resolution metrics for"
333+
}
334+
],
335+
"responses": {
336+
"200": {
337+
"description": "Successful Response",
338+
"content": {
339+
"application/json": {
340+
"schema": {
341+
"$ref": "#/components/schemas/GetConversationResolutionResponse"
342+
}
343+
}
344+
}
345+
},
346+
"422": {
347+
"description": "Validation Error",
348+
"content": {
349+
"application/json": {
350+
"schema": {
351+
"$ref": "#/components/schemas/HTTPValidationError"
352+
}
353+
}
354+
}
355+
}
356+
},
357+
"x-fern-audiences": [
358+
"internal"
359+
],
360+
"security": [
361+
{
362+
"bearerAuth": []
363+
}
364+
]
365+
}
366+
},
278367
"/chat/{domain}": {
279368
"post": {
280369
"tags": [
@@ -2136,7 +2225,7 @@
21362225
"Settings"
21372226
],
21382227
"summary": "Toggle Ask Ai",
2139-
"description": "Toggle Ask AI setting and return job_id for tracking.",
2228+
"description": "Toggle Ask AI setting and return job_id for tracking.\n\nArgs:\n domain: Domain to toggle Ask AI for\n org_name: Organization name\n preview: Whether this is a preview deployment\n locations: Optional list of locations to enable. Valid values: docs, slack, discord",
21402229
"operationId": "toggle_ask_ai",
21412230
"parameters": [
21422231
{
@@ -2166,6 +2255,30 @@
21662255
"default": false,
21672256
"title": "Preview"
21682257
}
2258+
},
2259+
{
2260+
"name": "locations",
2261+
"in": "query",
2262+
"required": false,
2263+
"schema": {
2264+
"anyOf": [
2265+
{
2266+
"type": "array",
2267+
"items": {
2268+
"enum": [
2269+
"docs",
2270+
"slack",
2271+
"discord"
2272+
],
2273+
"type": "string"
2274+
}
2275+
},
2276+
{
2277+
"type": "null"
2278+
}
2279+
],
2280+
"title": "Locations"
2281+
}
21692282
}
21702283
],
21712284
"responses": {
@@ -3238,6 +3351,38 @@
32383351
],
32393352
"title": "Feedback"
32403353
},
3354+
"GetConversationResolutionResponse": {
3355+
"properties": {
3356+
"total_conversations": {
3357+
"type": "integer",
3358+
"title": "Total Conversations",
3359+
"description": "Total number of conversations in the period"
3360+
},
3361+
"resolved_conversations": {
3362+
"type": "integer",
3363+
"title": "Resolved Conversations",
3364+
"description": "Number of resolved conversations"
3365+
},
3366+
"unresolved_conversations": {
3367+
"type": "integer",
3368+
"title": "Unresolved Conversations",
3369+
"description": "Number of unresolved conversations"
3370+
},
3371+
"resolution_rate": {
3372+
"type": "number",
3373+
"title": "Resolution Rate",
3374+
"description": "Percentage of conversations resolved (0-100)"
3375+
}
3376+
},
3377+
"type": "object",
3378+
"required": [
3379+
"total_conversations",
3380+
"resolved_conversations",
3381+
"unresolved_conversations",
3382+
"resolution_rate"
3383+
],
3384+
"title": "GetConversationResolutionResponse"
3385+
},
32413386
"GetConversationResponse": {
32423387
"properties": {
32433388
"conversation": {

0 commit comments

Comments
 (0)