From 153a08f3e3795302cefb2f73a4771efa08926601 Mon Sep 17 00:00:00 2001 From: eyw520 <64514273+eyw520@users.noreply.github.com> Date: Mon, 20 Oct 2025 18:37:55 +0000 Subject: [PATCH] update fern definition --- fern/apis/fai/openapi.json | 774 ++++++++++++++++++++++++++----------- 1 file changed, 544 insertions(+), 230 deletions(-) diff --git a/fern/apis/fai/openapi.json b/fern/apis/fai/openapi.json index c1fac269b..1366938e9 100644 --- a/fern/apis/fai/openapi.json +++ b/fern/apis/fai/openapi.json @@ -8,7 +8,9 @@ "paths": { "/analytics/histogram/{domain}": { "get": { - "tags": ["Analytics"], + "tags": [ + "Analytics" + ], "summary": "Get Analytics Histogram", "operationId": "get_analytics_histogram", "parameters": [ @@ -93,7 +95,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -101,21 +105,15 @@ ] } }, - "/analytics/insights/{domain}": { - "get": { - "tags": ["Analytics"], - "summary": "Get Analytics Insights", - "operationId": "get_analytics_insights", + "/analytics/insights/generate_all": { + "post": { + "tags": [ + "Analytics" + ], + "summary": "Generate All Insights", + "description": "Generate insights for all domains with queries in the specified period.", + "operationId": "generate_all_insights", "parameters": [ - { - "name": "domain", - "in": "path", - "required": true, - "schema": { - "type": "string", - "title": "Domain" - } - }, { "name": "start_date", "in": "query", @@ -130,10 +128,10 @@ "type": "null" } ], - "description": "The start date of the period to retrieve analytics for", + "description": "The start date of the period to generate insights for", "title": "Start Date" }, - "description": "The start date of the period to retrieve analytics for" + "description": "The start date of the period to generate insights for" }, { "name": "end_date", @@ -149,10 +147,10 @@ "type": "null" } ], - "description": "The end date of the period to retrieve analytics for", + "description": "The end date of the period to generate insights for", "title": "End Date" }, - "description": "The end date of the period to retrieve analytics for" + "description": "The end date of the period to generate insights for" } ], "responses": { @@ -160,9 +158,7 @@ "description": "Successful Response", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/GetInsightsResponse" - } + "schema": {} } } }, @@ -177,58 +173,51 @@ } } }, - "x-fern-audiences": ["internal"], - "security": [ - { - "bearerAuth": [] - } + "x-fern-audiences": [ + "internal" ] } }, - "/analytics/insights/generate_all": { + "/analytics/insights/trigger_scheduled": { "post": { - "tags": ["Analytics"], - "summary": "Generate All Insights", - "description": "Generate insights for all domains with queries in the specified period.", - "operationId": "generate_all_insights", + "tags": [ + "Analytics" + ], + "summary": "Trigger Scheduled Insights Generation", + "description": "Manually trigger the scheduled weekly insights generation job.", + "operationId": "trigger_scheduled_insights_generation", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-fern-audiences": [ + "internal" + ] + } + }, + "/analytics/insights/{domain}": { + "get": { + "tags": [ + "Analytics" + ], + "summary": "Get Query Insights", + "description": "Get the most recent insights for a domain.", + "operationId": "get_query_insights", "parameters": [ { - "name": "start_date", - "in": "query", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "description": "The start date of the period to generate insights for", - "title": "Start Date" - }, - "description": "The start date of the period to generate insights for" - }, - { - "name": "end_date", - "in": "query", - "required": false, + "name": "domain", + "in": "path", + "required": true, "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "description": "The end date of the period to generate insights for", - "title": "End Date" - }, - "description": "The end date of the period to generate insights for" + "type": "string", + "title": "Domain" + } } ], "responses": { @@ -236,7 +225,9 @@ "description": "Successful Response", "content": { "application/json": { - "schema": {} + "schema": { + "$ref": "#/components/schemas/GetInsightsResponse" + } } } }, @@ -251,31 +242,21 @@ } } }, - "x-fern-audiences": ["internal"] - } - }, - "/analytics/insights/trigger_scheduled": { - "post": { - "tags": ["Analytics"], - "summary": "Trigger Scheduled Insights Generation", - "description": "Manually trigger the scheduled weekly insights generation job.", - "operationId": "trigger_scheduled_insights_generation", - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": {} - } - } + "x-fern-audiences": [ + "internal" + ], + "security": [ + { + "bearerAuth": [] } - }, - "x-fern-audiences": ["internal"] + ] } }, "/analytics/scheduler/status": { "get": { - "tags": ["Analytics"], + "tags": [ + "Analytics" + ], "summary": "Get Scheduler Status", "description": "Get the status of the scheduler and its jobs.", "operationId": "get_scheduler_status", @@ -289,12 +270,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/chat/{domain}": { "post": { - "tags": ["Chat"], + "tags": [ + "Chat" + ], "summary": "Post Chat Completion", "operationId": "post_chat_completion", "parameters": [ @@ -340,7 +325,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -350,7 +337,9 @@ }, "/conversation/{domain}/{conversation_id}": { "get": { - "tags": ["Conversation"], + "tags": [ + "Conversation" + ], "summary": "Get Conversation By Id", "operationId": "get_conversation_by_id", "parameters": [ @@ -395,7 +384,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -405,7 +396,9 @@ }, "/discord/install": { "post": { - "tags": ["Discord"], + "tags": [ + "Discord" + ], "summary": "Create Discord Integration", "operationId": "create_discord_integration", "parameters": [ @@ -441,7 +434,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -451,7 +446,9 @@ }, "/discord/install/callback": { "get": { - "tags": ["Discord"], + "tags": [ + "Discord" + ], "summary": "Handle Discord Install Callback", "operationId": "handle_discord_install_callback", "responses": { @@ -464,12 +461,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/document/{domain}/create": { "post": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Create Document", "operationId": "create_document", "parameters": [ @@ -519,7 +520,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -529,7 +532,9 @@ }, "/document/{domain}/batch-create": { "post": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Batch Create Document", "operationId": "batch_create_document", "parameters": [ @@ -583,7 +588,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -593,7 +600,9 @@ }, "/document/{domain}/{document_id}": { "patch": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Update Document", "operationId": "update_document", "parameters": [ @@ -648,7 +657,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -656,7 +667,9 @@ ] }, "get": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Get Document By Id", "operationId": "get_document_by_id", "parameters": [ @@ -701,7 +714,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -711,7 +726,9 @@ }, "/document/{domain}/delete": { "delete": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Delete Document By Id", "operationId": "delete_document_by_id", "parameters": [ @@ -757,7 +774,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -767,7 +786,9 @@ }, "/document/{domain}/batch-delete": { "delete": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Batch Delete Document", "operationId": "batch_delete_document", "parameters": [ @@ -817,7 +838,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -827,7 +850,9 @@ }, "/document/{domain}": { "get": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Get Documents", "operationId": "get_documents", "parameters": [ @@ -899,7 +924,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -909,7 +936,9 @@ }, "/document/{domain}/delete-all": { "delete": { - "tags": ["Document"], + "tags": [ + "Document" + ], "summary": "Delete All Documents", "operationId": "delete_all_documents", "parameters": [ @@ -945,7 +974,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -955,7 +986,9 @@ }, "/feedback/{domain}": { "post": { - "tags": ["Feedback"], + "tags": [ + "Feedback" + ], "summary": "Create Feedback", "operationId": "create_feedback", "parameters": [ @@ -1001,12 +1034,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/feedback/{domain}/{conversation_id}": { "get": { - "tags": ["Feedback"], + "tags": [ + "Feedback" + ], "summary": "Get Feedback By Id", "operationId": "get_feedback_by_id", "parameters": [ @@ -1051,7 +1088,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1061,7 +1100,9 @@ }, "/guidance/{domain}/create": { "post": { - "tags": ["Guidance"], + "tags": [ + "Guidance" + ], "summary": "Create Guidance", "operationId": "create_guidance", "parameters": [ @@ -1107,7 +1148,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -1117,7 +1160,9 @@ }, "/guidance/{domain}/{guidance_id}": { "patch": { - "tags": ["Guidance"], + "tags": [ + "Guidance" + ], "summary": "Update", "operationId": "update", "parameters": [ @@ -1172,7 +1217,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -1180,7 +1227,9 @@ ] }, "delete": { - "tags": ["Guidance"], + "tags": [ + "Guidance" + ], "summary": "Delete Guidance By Id", "operationId": "delete_guidance_by_id", "parameters": [ @@ -1225,7 +1274,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -1233,7 +1284,9 @@ ] }, "get": { - "tags": ["Guidance"], + "tags": [ + "Guidance" + ], "summary": "Get Guidance By Id", "operationId": "get_guidance_by_id", "parameters": [ @@ -1278,7 +1331,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -1288,7 +1343,9 @@ }, "/guidance/{domain}": { "get": { - "tags": ["Guidance"], + "tags": [ + "Guidance" + ], "summary": "Get Guidances", "operationId": "get_guidances", "parameters": [ @@ -1360,7 +1417,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -1370,7 +1429,9 @@ }, "/health": { "get": { - "tags": ["Health"], + "tags": [ + "Health" + ], "summary": "Health Check", "description": "Health check endpoint that returns the application status.", "operationId": "health_check", @@ -1384,12 +1445,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/index/{domain}/reconstruct": { "post": { - "tags": ["Index"], + "tags": [ + "Index" + ], "summary": "Reconstruct Query Index", "operationId": "reconstruct_query_index", "parameters": [ @@ -1425,7 +1490,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1435,7 +1502,9 @@ }, "/index/{domain}/sync": { "post": { - "tags": ["Index"], + "tags": [ + "Index" + ], "summary": "Sync Index To Query Index", "operationId": "sync_index_to_query_index", "parameters": [ @@ -1481,7 +1550,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1491,7 +1562,9 @@ }, "/jobs/{job_id}/status": { "get": { - "tags": ["Index"], + "tags": [ + "Index" + ], "summary": "Get Job Status", "operationId": "get_job_status", "parameters": [ @@ -1527,12 +1600,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/mcp/semantic/{domain}": { "post": { - "tags": ["Mcp"], + "tags": [ + "Mcp" + ], "summary": "Get Mcp Semantic Query", "operationId": "get_mcp_semantic_query", "parameters": [ @@ -1578,7 +1655,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1588,7 +1667,9 @@ }, "/mcp/bmf/{domain}": { "post": { - "tags": ["Mcp"], + "tags": [ + "Mcp" + ], "summary": "Get Mcp Bmf Query", "operationId": "get_mcp_bmf_query", "parameters": [ @@ -1634,7 +1715,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1644,7 +1727,9 @@ }, "/queries": { "post": { - "tags": ["Query"], + "tags": [ + "Query" + ], "summary": "Create Query", "operationId": "create_query", "parameters": [ @@ -1690,7 +1775,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1700,7 +1787,9 @@ }, "/queries/{domain}": { "get": { - "tags": ["Query"], + "tags": [ + "Query" + ], "summary": "Get Recent Queries", "operationId": "get_recent_queries", "parameters": [ @@ -1847,7 +1936,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -1857,7 +1948,9 @@ }, "/settings/ask-ai": { "get": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Get Settings", "description": "Get settings for a domain and organization.", "operationId": "get_settings", @@ -1894,12 +1987,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/settings/ask-ai/docs": { "get": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Get Docs Settings", "description": "Get settings for a domain and organization.", "operationId": "get_docs_settings", @@ -1936,12 +2033,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/settings/ask-ai/slack": { "get": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Get Slack Settings", "description": "Get settings for a domain and organization.", "operationId": "get_slack_settings", @@ -1978,12 +2079,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/settings/ask-ai/discord": { "get": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Get Discord Settings", "description": "Get settings for a domain and organization.", "operationId": "get_discord_settings", @@ -2020,12 +2125,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/settings/ask-ai/toggle": { "post": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Toggle Ask Ai", "description": "Toggle Ask AI setting and return job_id for tracking.", "operationId": "toggle_ask_ai", @@ -2081,7 +2190,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -2091,7 +2202,9 @@ }, "/settings/ask-ai/reindex": { "post": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Reindex Ask Ai", "description": "Manually trigger reindex for an already enabled Ask AI setup.", "operationId": "reindex_ask_ai", @@ -2137,7 +2250,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -2147,7 +2262,9 @@ }, "/settings/ask-ai/toggle/status": { "get": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Get Toggle Status", "description": "Get the status of Ask AI toggle operation.", "operationId": "get_toggle_status", @@ -2184,7 +2301,9 @@ } } }, - "x-fern-audiences": ["internal"], + "x-fern-audiences": [ + "internal" + ], "security": [ { "bearerAuth": [] @@ -2194,7 +2313,9 @@ }, "/settings/reindex-preview-callback": { "post": { - "tags": ["Settings"], + "tags": [ + "Settings" + ], "summary": "Reindex Preview Callback", "description": "Handle callback from Upstash QStash when preview reindex completes.", "operationId": "reindex_preview_callback", @@ -2228,12 +2349,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/integrations": { "post": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Create Slack Integration", "operationId": "create_slack_integration", "requestBody": { @@ -2268,12 +2393,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/events": { "post": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Handle Slack Events", "operationId": "handle_slack_events", "responses": { @@ -2286,12 +2415,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/slash-commands": { "post": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Handle Slack Slash Commands", "operationId": "handle_slack_slash_commands", "responses": { @@ -2304,12 +2437,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/interactions": { "post": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Handle Slack Interactions", "operationId": "handle_slack_interactions", "responses": { @@ -2322,12 +2459,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/oauth/callback": { "get": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Handle Slack Oauth Callback", "operationId": "handle_slack_oauth_callback", "parameters": [ @@ -2377,12 +2518,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/get-install": { "get": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Get Slack Install Link", "operationId": "get_slack_install_link", "parameters": [ @@ -2416,7 +2561,9 @@ } } }, - "x-fern-audiences": ["customers"], + "x-fern-audiences": [ + "customers" + ], "security": [ { "bearerAuth": [] @@ -2426,7 +2573,9 @@ }, "/slack/integrations/{domain}": { "get": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "List Slack Integrations", "operationId": "list_slack_integrations", "parameters": [ @@ -2460,12 +2609,16 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } }, "/slack/get-install/{integration_id}": { "get": { - "tags": ["Slack"], + "tags": [ + "Slack" + ], "summary": "Get Slack Install Link By Id", "operationId": "get_slack_install_link_by_id", "parameters": [ @@ -2499,7 +2652,9 @@ } } }, - "x-fern-audiences": ["internal"] + "x-fern-audiences": [ + "internal" + ] } } }, @@ -2509,7 +2664,10 @@ "properties": { "role": { "type": "string", - "enum": ["user", "assistant"], + "enum": [ + "user", + "assistant" + ], "title": "Role" }, "content": { @@ -2518,7 +2676,10 @@ } }, "type": "object", - "required": ["role", "content"], + "required": [ + "role", + "content" + ], "title": "ChatMessage" }, "Conversation": { @@ -2541,7 +2702,11 @@ } }, "type": "object", - "required": ["conversation_id", "created_at", "turns"], + "required": [ + "conversation_id", + "created_at", + "turns" + ], "title": "Conversation" }, "ConversationTurn": { @@ -2571,7 +2736,11 @@ } }, "type": "object", - "required": ["role", "text", "created_at"], + "required": [ + "role", + "text", + "created_at" + ], "title": "ConversationTurn" }, "ConversationTurnFeedback": { @@ -2593,7 +2762,9 @@ } }, "type": "object", - "required": ["is_helpful"], + "required": [ + "is_helpful" + ], "title": "ConversationTurnFeedback" }, "CreateDocumentRequest": { @@ -2692,7 +2863,9 @@ } }, "type": "object", - "required": ["document"], + "required": [ + "document" + ], "title": "CreateDocumentRequest" }, "CreateDocumentResponse": { @@ -2704,7 +2877,9 @@ } }, "type": "object", - "required": ["document_id"], + "required": [ + "document_id" + ], "title": "CreateDocumentResponse" }, "CreateFeedbackRequest": { @@ -2755,7 +2930,14 @@ } }, "type": "object", - "required": ["conversation_id", "query_id", "domain", "is_helpful", "feedback_message", "user_email"], + "required": [ + "conversation_id", + "query_id", + "domain", + "is_helpful", + "feedback_message", + "user_email" + ], "title": "CreateFeedbackRequest" }, "CreateFeedbackResponse": { @@ -2767,7 +2949,9 @@ } }, "type": "object", - "required": ["feedback_id"], + "required": [ + "feedback_id" + ], "title": "CreateFeedbackResponse" }, "CreateGuidanceRequest": { @@ -2787,7 +2971,10 @@ } }, "type": "object", - "required": ["context", "document"], + "required": [ + "context", + "document" + ], "title": "CreateGuidanceRequest" }, "CreateGuidanceResponse": { @@ -2799,7 +2986,9 @@ } }, "type": "object", - "required": ["guidance_id"], + "required": [ + "guidance_id" + ], "title": "CreateGuidanceResponse" }, "CreateQueryResponse": { @@ -2811,7 +3000,9 @@ } }, "type": "object", - "required": ["query_id"], + "required": [ + "query_id" + ], "title": "CreateQueryResponse" }, "CreateSlackIntegration": { @@ -2822,7 +3013,9 @@ } }, "type": "object", - "required": ["domain"], + "required": [ + "domain" + ], "title": "CreateSlackIntegration" }, "DeleteDocumentRequest": { @@ -2834,7 +3027,9 @@ } }, "type": "object", - "required": ["document_id"], + "required": [ + "document_id" + ], "title": "DeleteDocumentRequest" }, "DeleteDocumentResponse": { @@ -2846,7 +3041,9 @@ } }, "type": "object", - "required": ["success"], + "required": [ + "success" + ], "title": "DeleteDocumentResponse" }, "DeleteGuidanceResponse": { @@ -2858,7 +3055,9 @@ } }, "type": "object", - "required": ["success"], + "required": [ + "success" + ], "title": "DeleteGuidanceResponse" }, "DiscordIntegrationResponse": { @@ -2869,7 +3068,9 @@ } }, "type": "object", - "required": ["integration_url"], + "required": [ + "integration_url" + ], "title": "DiscordIntegrationResponse" }, "Document": { @@ -2971,7 +3172,14 @@ } }, "type": "object", - "required": ["document_id", "domain", "chunk", "document", "created_at", "updated_at"], + "required": [ + "document_id", + "domain", + "chunk", + "document", + "created_at", + "updated_at" + ], "title": "Document" }, "Feedback": { @@ -3021,7 +3229,13 @@ } }, "type": "object", - "required": ["query_id", "conversation_id", "domain", "is_helpful", "created_at"], + "required": [ + "query_id", + "conversation_id", + "domain", + "is_helpful", + "created_at" + ], "title": "Feedback" }, "GetConversationResponse": { @@ -3032,7 +3246,9 @@ } }, "type": "object", - "required": ["conversation"], + "required": [ + "conversation" + ], "title": "GetConversationResponse" }, "GetDocumentResponse": { @@ -3043,7 +3259,9 @@ } }, "type": "object", - "required": ["document"], + "required": [ + "document" + ], "title": "GetDocumentResponse" }, "GetDocumentsResponse": { @@ -3062,7 +3280,10 @@ } }, "type": "object", - "required": ["documents", "pagination"], + "required": [ + "documents", + "pagination" + ], "title": "GetDocumentsResponse" }, "GetFeedbackResponse": { @@ -3073,7 +3294,9 @@ } }, "type": "object", - "required": ["feedback"], + "required": [ + "feedback" + ], "title": "GetFeedbackResponse" }, "GetGuidanceResponse": { @@ -3084,7 +3307,9 @@ } }, "type": "object", - "required": ["guidance"], + "required": [ + "guidance" + ], "title": "GetGuidanceResponse" }, "GetGuidancesResponse": { @@ -3103,7 +3328,10 @@ } }, "type": "object", - "required": ["guidances", "pagination"], + "required": [ + "guidances", + "pagination" + ], "title": "GetGuidancesResponse" }, "GetHistogramAnalyticsResponse": { @@ -3118,7 +3346,9 @@ } }, "type": "object", - "required": ["bars"], + "required": [ + "bars" + ], "title": "GetHistogramAnalyticsResponse" }, "GetInsightsResponse": { @@ -3133,7 +3363,9 @@ } }, "type": "object", - "required": ["insights"], + "required": [ + "insights" + ], "title": "GetInsightsResponse" }, "GetMcpBmfQueryRequest": { @@ -3145,7 +3377,9 @@ } }, "type": "object", - "required": ["keywords"], + "required": [ + "keywords" + ], "title": "GetMcpBmfQueryRequest" }, "GetMcpBmfQueryResponse": { @@ -3160,7 +3394,9 @@ } }, "type": "object", - "required": ["documents"], + "required": [ + "documents" + ], "title": "GetMcpBmfQueryResponse" }, "GetMcpSemanticQueryRequest": { @@ -3172,7 +3408,9 @@ } }, "type": "object", - "required": ["semantic_query"], + "required": [ + "semantic_query" + ], "title": "GetMcpSemanticQueryRequest" }, "GetMcpSemanticQueryResponse": { @@ -3187,7 +3425,9 @@ } }, "type": "object", - "required": ["documents"], + "required": [ + "documents" + ], "title": "GetMcpSemanticQueryResponse" }, "GetQueriesResponse": { @@ -3206,7 +3446,10 @@ } }, "type": "object", - "required": ["queries", "pagination"], + "required": [ + "queries", + "pagination" + ], "title": "GetQueriesResponse" }, "GetSettingsResponse": { @@ -3230,12 +3473,18 @@ } }, "type": "object", - "required": ["ask_ai_enabled"], + "required": [ + "ask_ai_enabled" + ], "title": "GetSettingsResponse" }, "GroupBy": { "type": "string", - "enum": ["DAY", "WEEK", "MONTH"], + "enum": [ + "DAY", + "WEEK", + "MONTH" + ], "title": "GroupBy" }, "Guidance": { @@ -3271,7 +3520,14 @@ } }, "type": "object", - "required": ["domain", "context", "document", "guidance_id", "created_at", "updated_at"], + "required": [ + "domain", + "context", + "document", + "guidance_id", + "created_at", + "updated_at" + ], "title": "Guidance" }, "HTTPValidationError": { @@ -3332,7 +3588,10 @@ } }, "type": "object", - "required": ["query", "conversationId"], + "required": [ + "query", + "conversationId" + ], "title": "InsightExample" }, "InsightWithMetadata": { @@ -3354,7 +3613,11 @@ } }, "type": "object", - "required": ["insightText", "numberOfQueries", "examples"], + "required": [ + "insightText", + "numberOfQueries", + "examples" + ], "title": "InsightWithMetadata" }, "JobStatusResponse": { @@ -3427,12 +3690,19 @@ } }, "type": "object", - "required": ["job_id", "status", "created_at"], + "required": [ + "job_id", + "status", + "created_at" + ], "title": "JobStatusResponse" }, "LanguageModel": { "type": "string", - "enum": ["claude-4-sonnet-20250514", "command-a-03-2025"], + "enum": [ + "claude-4-sonnet-20250514", + "command-a-03-2025" + ], "title": "LanguageModel" }, "PaginationResponse": { @@ -3451,7 +3721,11 @@ } }, "type": "object", - "required": ["total", "page", "limit"], + "required": [ + "total", + "page", + "limit" + ], "title": "PaginationResponse" }, "PostChatCompletionRequest": { @@ -3489,7 +3763,9 @@ } }, "type": "object", - "required": ["messages"], + "required": [ + "messages" + ], "title": "PostChatCompletionRequest" }, "PostChatCompletionResponse": { @@ -3512,7 +3788,10 @@ } }, "type": "object", - "required": ["turns", "citations"], + "required": [ + "turns", + "citations" + ], "title": "PostChatCompletionResponse" }, "Query": { @@ -3559,7 +3838,15 @@ } }, "type": "object", - "required": ["query_id", "conversation_id", "domain", "text", "role", "source", "created_at"], + "required": [ + "query_id", + "conversation_id", + "domain", + "text", + "role", + "source", + "created_at" + ], "title": "Query" }, "ReconstructIndexResponse": { @@ -3571,7 +3858,9 @@ } }, "type": "object", - "required": ["success"], + "required": [ + "success" + ], "title": "ReconstructIndexResponse" }, "SlackIntegrationResponse": { @@ -3625,7 +3914,11 @@ } }, "type": "object", - "required": ["integration_id", "domain", "created_at"], + "required": [ + "integration_id", + "domain", + "created_at" + ], "title": "SlackIntegrationResponse" }, "SyncIndexRequest": { @@ -3637,7 +3930,9 @@ } }, "type": "object", - "required": ["index_name"], + "required": [ + "index_name" + ], "title": "SyncIndexRequest" }, "SyncIndexResponse": { @@ -3649,7 +3944,9 @@ } }, "type": "object", - "required": ["job_id"], + "required": [ + "job_id" + ], "title": "SyncIndexResponse" }, "ToggleAskAiResponse": { @@ -3678,7 +3975,10 @@ } }, "type": "object", - "required": ["success", "ask_ai_enabled"], + "required": [ + "success", + "ask_ai_enabled" + ], "title": "ToggleAskAiResponse" }, "ToggleStatusResponse": { @@ -3707,7 +4007,10 @@ } }, "type": "object", - "required": ["status", "ask_ai_enabled"], + "required": [ + "status", + "ask_ai_enabled" + ], "title": "ToggleStatusResponse" }, "UpdateDocumentRequest": { @@ -3823,7 +4126,9 @@ } }, "type": "object", - "required": ["document"], + "required": [ + "document" + ], "title": "UpdateDocumentResponse" }, "UpdateGuidanceRequest": { @@ -3867,7 +4172,9 @@ } }, "type": "object", - "required": ["guidance"], + "required": [ + "guidance" + ], "title": "UpdateGuidanceResponse" }, "UpstashCallbackRequest": { @@ -3976,7 +4283,10 @@ } }, "type": "object", - "required": ["status", "sourceMessageId"], + "required": [ + "status", + "sourceMessageId" + ], "title": "UpstashCallbackRequest", "description": "Callback payload from Upstash QStash when a queued job completes." }, @@ -4006,7 +4316,11 @@ } }, "type": "object", - "required": ["loc", "msg", "type"], + "required": [ + "loc", + "msg", + "type" + ], "title": "ValidationError" } }, @@ -4032,4 +4346,4 @@ "x-fern-server-name": "Local" } ] -} +} \ No newline at end of file