Last active
December 17, 2025 02:14
-
-
Save nicholaschiang/21f3737421960e7970c4e311a7008405 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.1.0", | |
| "info": { | |
| "title": "Alation AI API", | |
| "description": "Public API for working with Alation's AI-powered resources and features (chats, configs, evals, etc.).", | |
| "version": "18.0.0" | |
| }, | |
| "paths": { | |
| "/assets/{asset_id}": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Download asset", | |
| "description": "Download an asset by its asset_id using streaming.", | |
| "operationId": "download_asset", | |
| "parameters": [ | |
| { | |
| "name": "asset_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The descriptive identifier of the asset to download", | |
| "title": "Asset Id" | |
| }, | |
| "description": "The descriptive identifier of the asset to download" | |
| }, | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The chat_id for scoped asset retrieval", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The chat_id for scoped asset retrieval" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/assets/upload_files": { | |
| "post": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Upload assets", | |
| "description": "Upload assets.", | |
| "operationId": "create_file_assets", | |
| "parameters": [ | |
| { | |
| "name": "ttl_hours", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number", | |
| "description": "Time-to-live in hours for the asset. After this time, the asset will expire and be automatically cleaned up. Default: 4 hours.", | |
| "default": 4, | |
| "title": "Ttl Hours" | |
| }, | |
| "description": "Time-to-live in hours for the asset. After this time, the asset will expire and be automatically cleaned up. Default: 4 hours." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Body_create_file_assets_api_v1_assets_upload_files_post" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Files uploaded successfully", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_str_" | |
| } | |
| } | |
| } | |
| }, | |
| "415": { | |
| "description": "Unsupported MIME type" | |
| }, | |
| "422": { | |
| "description": "Unprocessable Entity" | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Create a new Chat", | |
| "description": "Create a new Chat.", | |
| "operationId": "create_chat", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Chat" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Get a page of Chats", | |
| "description": "Get a page of chats ordered by when they were last updated (descending).\n\nIf the same tag is provided in both `include_tags` and `exclude_tags`, `exclude_tags` takes precedence.", | |
| "operationId": "get_chats", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of chats to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of chats to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the chats to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the chats to include in the response." | |
| }, | |
| { | |
| "name": "created_by", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/components/schemas/CreatedByFilterOption", | |
| "description": "Filter chats by who created them.", | |
| "default": "user" | |
| }, | |
| "description": "Filter chats by who created them." | |
| }, | |
| { | |
| "name": "include_tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Only return chats with all of these tags.", | |
| "title": "Include Tags" | |
| }, | |
| "description": "Only return chats with all of these tags." | |
| }, | |
| { | |
| "name": "exclude_tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Do not return chats with any of these tags.", | |
| "title": "Exclude Tags" | |
| }, | |
| "description": "Do not return chats with any of these tags." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_Chat_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/{chat_id}": { | |
| "patch": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Update a Chat", | |
| "description": "Update a Chat's metadata.", | |
| "operationId": "update_chat", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Chat to use.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Chat" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Get a Chat", | |
| "description": "Get a Chat by ID.", | |
| "operationId": "get_chat", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Chat to use.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Chat" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/{chat_id}/tags/add": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Add tags to a chat.", | |
| "description": "Add one or more tags to a chat.\n\nThis operation is idempotent, tags will not be duplicated.", | |
| "operationId": "tag_chat", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Chat to use.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "title": "Tags" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Chat" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/{chat_id}/tags/remove": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Remove tags from a chat.\n\nThis operation is idempotent, removing tags multiple times will be ignored.", | |
| "description": "Remove one or more tags from a chat.", | |
| "operationId": "untag_chat", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Chat to use.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "title": "Tags" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Chat" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/{chat_id}/messages": { | |
| "get": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Get a page of a Chat's Messages", | |
| "description": "Get a page of Messages for a Chat.", | |
| "operationId": "get_chat_messages", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Chat to use.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use." | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of messages to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of messages to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the messages to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the messages to include in the response." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_Message_" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/{chat_id}/eval_expected_output": { | |
| "get": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Get the expected Eval output of a Chat", | |
| "description": "Get the expected Eval output from a Chat's final turn.", | |
| "operationId": "generate_eval_output_from_chat", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Chat to use.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvalExpectedOutput" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/revise_data_product_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Revise Data Product\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Revise Data Product\" Agent.", | |
| "operationId": "post_revise_data_product_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultReviseDataProductAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/revise_data_product_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Revise Data Product\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Revise Data Product\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_revise_data_product_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultReviseDataProductAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/bi_report_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Dashboard Search\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Dashboard Search\" Agent.", | |
| "operationId": "post_bi_report_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/bi_report_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Dashboard Search\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Dashboard Search\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_bi_report_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/catalog_context_search_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Catalog Context Search\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Catalog Context Search\" Agent.", | |
| "operationId": "post_catalog_context_search_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCatalogContextSearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/catalog_context_search_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Catalog Context Search\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Catalog Context Search\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_catalog_context_search_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCatalogContextSearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/catalog_search_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Catalog Search\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Catalog Search\" Agent.", | |
| "operationId": "post_catalog_search_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/catalog_search_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Catalog Search\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Catalog Search\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_catalog_search_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCatalogSearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/charting_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Chart Generation\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Chart Generation\" Agent.", | |
| "operationId": "post_charting_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultSQLQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/charting_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Chart Generation\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Chart Generation\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_charting_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultSQLQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/data_product_query_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Data Product Query\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Data Product Query\" Agent.", | |
| "operationId": "post_data_product_query_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultDataProductQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/data_product_query_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Data Product Query\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Data Product Query\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_data_product_query_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultDataProductQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/deep_research_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Deep Research\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Deep Research\" Agent.", | |
| "operationId": "post_deep_research_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultDeepResearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/deep_research_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Deep Research\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Deep Research\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_deep_research_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultDeepResearchAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/query_flow_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Analytics Agent\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Analytics Agent\" Agent.", | |
| "operationId": "post_query_flow_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultQueryFlowAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/query_flow_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Analytics Agent\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Analytics Agent\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_query_flow_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultQueryFlowAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/data_product_question_manager_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Data Product Question Manager\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Data Product Question Manager\" Agent.", | |
| "operationId": "post_data_product_question_manager_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultSQLQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/data_product_question_manager_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Data Product Question Manager\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Data Product Question Manager\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_data_product_question_manager_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultSQLQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/sql_query_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Query\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Query\" Agent.", | |
| "operationId": "post_sql_query_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultSQLQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/sql_query_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Query\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Query\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_sql_query_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultSQLQueryAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/curation_agent/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Curation\" Agent (streaming)", | |
| "description": "Post a new Message to the Chat using the \"Curation\" Agent.", | |
| "operationId": "post_curation_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCurationAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/default/curation_agent/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message the \"Curation\" Agent (async)", | |
| "description": "Post a new message to the chat using the \"Curation\" agent. This runs the chat as a background task and returns a task ID.", | |
| "operationId": "post_curation_agent_message_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultCurationAgentPayload", | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "The chat could not be found.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/{agent_config_id}/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message an Agent (streaming)", | |
| "description": "Send messages to a specific custom agent.", | |
| "operationId": "post_agent_message", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| }, | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "additionalProperties": true, | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions.", | |
| "title": "Payload" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/agent/{agent_config_id}/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Message an Agent (async)", | |
| "description": "Creates a task to post a message to an Agent as a job.", | |
| "operationId": "post_agent_message_job", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| }, | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "additionalProperties": true, | |
| "description": "The payload to be sent to the agent. This should conform to the input JSON schema of the agent. May optionally include a 'tool_approvals' field with structured approval decisions.", | |
| "title": "Payload" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Message sent successfully. Returns an event stream of `Message` objects.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| }, | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "The message is empty and was ignored." | |
| }, | |
| "409": { | |
| "description": "Chat is busy. Returns an event stream of the running chat.", | |
| "content": { | |
| "text/event-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "The payload is not valid according to the input JSON schema of the agent.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/alation_context_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Alation Context\" tool (streaming)", | |
| "description": "Invoke the \"Alation Context\" directly.", | |
| "operationId": "invoke_alation_context_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__alation_context_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/alation_context_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Alation Context\" tool (async)", | |
| "description": "Invoke the \"Alation Context\" directly as a background task.", | |
| "operationId": "invoke_alation_context_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__alation_context_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/analyze_catalog_question_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Analyze Catalog Question\" tool (streaming)", | |
| "description": "Invoke the \"Analyze Catalog Question\" directly.", | |
| "operationId": "invoke_analyze_catalog_question_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__analyze_catalog_question_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/analyze_catalog_question_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Analyze Catalog Question\" tool (async)", | |
| "description": "Invoke the \"Analyze Catalog Question\" directly as a background task.", | |
| "operationId": "invoke_analyze_catalog_question_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__analyze_catalog_question_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/bi_report_search_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"BI Report Search\" tool (streaming)", | |
| "description": "Invoke the \"BI Report Search\" directly.", | |
| "operationId": "invoke_bi_report_search_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__bi_report_search_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/bi_report_search_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"BI Report Search\" tool (async)", | |
| "description": "Invoke the \"BI Report Search\" directly as a background task.", | |
| "operationId": "invoke_bi_report_search_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__bi_report_search_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/bulk_retrieval_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Bulk Retrieval\" tool (streaming)", | |
| "description": "Invoke the \"Bulk Retrieval\" directly.", | |
| "operationId": "invoke_bulk_retrieval_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__bulk_retrieval_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/bulk_retrieval_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Bulk Retrieval\" tool (async)", | |
| "description": "Invoke the \"Bulk Retrieval\" directly as a background task.", | |
| "operationId": "invoke_bulk_retrieval_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__bulk_retrieval_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/delete_sql_eval_case_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Delete SQL Evaluation Case\" tool (streaming)", | |
| "description": "Invoke the \"Delete SQL Evaluation Case\" directly.", | |
| "operationId": "invoke_delete_sql_eval_case_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__delete_sql_eval_case_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/delete_sql_eval_case_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Delete SQL Evaluation Case\" tool (async)", | |
| "description": "Invoke the \"Delete SQL Evaluation Case\" directly as a background task.", | |
| "operationId": "invoke_delete_sql_eval_case_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__delete_sql_eval_case_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/sql_execution_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"SQL Execution\" tool (streaming)", | |
| "description": "Invoke the \"SQL Execution\" directly.", | |
| "operationId": "invoke_sql_execution_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__sql_execution_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/sql_execution_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"SQL Execution\" tool (async)", | |
| "description": "Invoke the \"SQL Execution\" directly as a background task.", | |
| "operationId": "invoke_sql_execution_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__sql_execution_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/generate_chart_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Chart Generation from Asset\" tool (streaming)", | |
| "description": "Invoke the \"Chart Generation from Asset\" directly.", | |
| "operationId": "invoke_generate_chart_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__generate_chart_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/generate_chart_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Chart Generation from Asset\" tool (async)", | |
| "description": "Invoke the \"Chart Generation from Asset\" directly as a background task.", | |
| "operationId": "invoke_generate_chart_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__generate_chart_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/generate_chart_from_sql_and_code_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Chart Generation\" tool (streaming)", | |
| "description": "Invoke the \"Chart Generation\" directly.", | |
| "operationId": "invoke_generate_chart_from_sql_and_code_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__generate_chart_from_sql_and_code_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/generate_chart_from_sql_and_code_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Chart Generation\" tool (async)", | |
| "description": "Invoke the \"Chart Generation\" directly as a background task.", | |
| "operationId": "invoke_generate_chart_from_sql_and_code_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__generate_chart_from_sql_and_code_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_custom_fields_definitions_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Custom Fields Definitions\" tool (streaming)", | |
| "description": "Invoke the \"Get Custom Fields Definitions\" directly.", | |
| "operationId": "invoke_get_custom_fields_definitions_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_custom_fields_definitions_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_custom_fields_definitions_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Custom Fields Definitions\" tool (async)", | |
| "description": "Invoke the \"Get Custom Fields Definitions\" directly as a background task.", | |
| "operationId": "invoke_get_custom_fields_definitions_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_custom_fields_definitions_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_data_schema_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Data Schema\" tool (streaming)", | |
| "description": "Invoke the \"Get Data Schema\" directly.", | |
| "operationId": "invoke_get_data_schema_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_data_schema_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_data_schema_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Data Schema\" tool (async)", | |
| "description": "Invoke the \"Get Data Schema\" directly as a background task.", | |
| "operationId": "invoke_get_data_schema_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_data_schema_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_data_product_spec_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Data Product Raw Specification\" tool (streaming)", | |
| "description": "Invoke the \"Get Data Product Raw Specification\" directly.", | |
| "operationId": "invoke_get_data_product_spec_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_data_product_spec_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_data_product_spec_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Data Product Raw Specification\" tool (async)", | |
| "description": "Invoke the \"Get Data Product Raw Specification\" directly as a background task.", | |
| "operationId": "invoke_get_data_product_spec_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_data_product_spec_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_data_sources_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Data Sources\" tool (streaming)", | |
| "description": "Invoke the \"Get Data Sources\" directly.", | |
| "operationId": "invoke_get_data_sources_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_data_sources_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_data_sources_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Data Sources\" tool (async)", | |
| "description": "Invoke the \"Get Data Sources\" directly as a background task.", | |
| "operationId": "invoke_get_data_sources_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_data_sources_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_signature_creation_instructions_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Signature Creation Instructions\" tool (streaming)", | |
| "description": "Invoke the \"Get Signature Creation Instructions\" directly.", | |
| "operationId": "invoke_get_signature_creation_instructions_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_signature_creation_instructions_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_signature_creation_instructions_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Signature Creation Instructions\" tool (async)", | |
| "description": "Invoke the \"Get Signature Creation Instructions\" directly as a background task.", | |
| "operationId": "invoke_get_signature_creation_instructions_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_signature_creation_instructions_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_sql_eval_case_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get SQL Evaluation Case\" tool (streaming)", | |
| "description": "Invoke the \"Get SQL Evaluation Case\" directly.", | |
| "operationId": "invoke_get_sql_eval_case_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_sql_eval_case_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_sql_eval_case_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get SQL Evaluation Case\" tool (async)", | |
| "description": "Invoke the \"Get SQL Evaluation Case\" directly as a background task.", | |
| "operationId": "invoke_get_sql_eval_case_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_sql_eval_case_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_sql_eval_set_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get SQL Evaluation Set\" tool (streaming)", | |
| "description": "Invoke the \"Get SQL Evaluation Set\" directly.", | |
| "operationId": "invoke_get_sql_eval_set_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_sql_eval_set_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_sql_eval_set_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get SQL Evaluation Set\" tool (async)", | |
| "description": "Invoke the \"Get SQL Evaluation Set\" directly as a background task.", | |
| "operationId": "invoke_get_sql_eval_set_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_sql_eval_set_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/list_assets_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"List Assets\" tool (streaming)", | |
| "description": "Invoke the \"List Assets\" directly.", | |
| "operationId": "invoke_list_assets_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__list_assets_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/list_assets_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"List Assets\" tool (async)", | |
| "description": "Invoke the \"List Assets\" directly as a background task.", | |
| "operationId": "invoke_list_assets_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__list_assets_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/list_data_products_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"List Available Data Products Pertaining to the query\" tool (streaming)", | |
| "description": "Invoke the \"List Available Data Products Pertaining to the query\" directly.", | |
| "operationId": "invoke_list_data_products_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__list_data_products_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/list_data_products_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"List Available Data Products Pertaining to the query\" tool (async)", | |
| "description": "Invoke the \"List Available Data Products Pertaining to the query\" directly as a background task.", | |
| "operationId": "invoke_list_data_products_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__list_data_products_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/retrieve_asset_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Retrieve Asset\" tool (streaming)", | |
| "description": "Invoke the \"Retrieve Asset\" directly.", | |
| "operationId": "invoke_retrieve_asset_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__retrieve_asset_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/retrieve_asset_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Retrieve Asset\" tool (async)", | |
| "description": "Invoke the \"Retrieve Asset\" directly as a background task.", | |
| "operationId": "invoke_retrieve_asset_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__retrieve_asset_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/save_asset_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Save Asset\" tool (streaming)", | |
| "description": "Invoke the \"Save Asset\" directly.", | |
| "operationId": "invoke_save_asset_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__save_asset_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/save_asset_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Save Asset\" tool (async)", | |
| "description": "Invoke the \"Save Asset\" directly as a background task.", | |
| "operationId": "invoke_save_asset_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__save_asset_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/sql_evaluation_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Run SQL Evaluation\" tool (streaming)", | |
| "description": "Invoke the \"Run SQL Evaluation\" directly.", | |
| "operationId": "invoke_sql_evaluation_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__sql_evaluation_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/sql_evaluation_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Run SQL Evaluation\" tool (async)", | |
| "description": "Invoke the \"Run SQL Evaluation\" directly as a background task.", | |
| "operationId": "invoke_sql_evaluation_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__sql_evaluation_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/search_catalog_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Search Catalog\" tool (streaming)", | |
| "description": "Invoke the \"Search Catalog\" directly.", | |
| "operationId": "invoke_search_catalog_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__search_catalog_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/search_catalog_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Search Catalog\" tool (async)", | |
| "description": "Invoke the \"Search Catalog\" directly as a background task.", | |
| "operationId": "invoke_search_catalog_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__search_catalog_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_search_filter_fields_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Search Filter Fields\" tool (streaming)", | |
| "description": "Invoke the \"Search Filter Fields\" directly.", | |
| "operationId": "invoke_get_search_filter_fields_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_search_filter_fields_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_search_filter_fields_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Search Filter Fields\" tool (async)", | |
| "description": "Invoke the \"Search Filter Fields\" directly as a background task.", | |
| "operationId": "invoke_get_search_filter_fields_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_search_filter_fields_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_search_filter_values_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Search Filter Values\" tool (streaming)", | |
| "description": "Invoke the \"Search Filter Values\" directly.", | |
| "operationId": "invoke_get_search_filter_values_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_search_filter_values_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_search_filter_values_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Search Filter Values\" tool (async)", | |
| "description": "Invoke the \"Search Filter Values\" directly as a background task.", | |
| "operationId": "invoke_get_search_filter_values_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_search_filter_values_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/update_sql_eval_case_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Update SQL Evaluation Case\" tool (streaming)", | |
| "description": "Invoke the \"Update SQL Evaluation Case\" directly.", | |
| "operationId": "invoke_update_sql_eval_case_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__update_sql_eval_case_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/update_sql_eval_case_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Update SQL Evaluation Case\" tool (async)", | |
| "description": "Invoke the \"Update SQL Evaluation Case\" directly as a background task.", | |
| "operationId": "invoke_update_sql_eval_case_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__update_sql_eval_case_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/upload_sql_eval_set_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Upload SQL Evaluation Set\" tool (streaming)", | |
| "description": "Invoke the \"Upload SQL Evaluation Set\" directly.", | |
| "operationId": "invoke_upload_sql_eval_set_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__upload_sql_eval_set_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/upload_sql_eval_set_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Upload SQL Evaluation Set\" tool (async)", | |
| "description": "Invoke the \"Upload SQL Evaluation Set\" directly as a background task.", | |
| "operationId": "invoke_upload_sql_eval_set_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__upload_sql_eval_set_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_catalog_object_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get a Catalog Object\" tool (streaming)", | |
| "description": "Invoke the \"Get a Catalog Object\" directly.", | |
| "operationId": "invoke_get_catalog_object_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_catalog_object_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_catalog_object_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get a Catalog Object\" tool (async)", | |
| "description": "Invoke the \"Get a Catalog Object\" directly as a background task.", | |
| "operationId": "invoke_get_catalog_object_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_catalog_object_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/update_catalog_object_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Update a Catalog Object\" tool (streaming)", | |
| "description": "Invoke the \"Update a Catalog Object\" directly.", | |
| "operationId": "invoke_update_catalog_object_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__update_catalog_object_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/update_catalog_object_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Update a Catalog Object\" tool (async)", | |
| "description": "Invoke the \"Update a Catalog Object\" directly as a background task.", | |
| "operationId": "invoke_update_catalog_object_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__update_catalog_object_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_users_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Users\" tool (streaming)", | |
| "description": "Invoke the \"Get Users\" directly.", | |
| "operationId": "invoke_get_users_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_users_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_users_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Users\" tool (async)", | |
| "description": "Invoke the \"Get Users\" directly as a background task.", | |
| "operationId": "invoke_get_users_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_users_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_groups_tool/stream": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Groups\" tool (streaming)", | |
| "description": "Invoke the \"Get Groups\" directly.", | |
| "operationId": "invoke_get_groups_tool", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_groups_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/chats/tool/default/get_groups_tool/call": { | |
| "post": { | |
| "tags": [ | |
| "Chats" | |
| ], | |
| "summary": "Query the \"Get Groups\" tool (async)", | |
| "description": "Invoke the \"Get Groups\" directly as a background task.", | |
| "operationId": "invoke_get_groups_tool_as_task", | |
| "parameters": [ | |
| { | |
| "name": "chat_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created.", | |
| "title": "Chat Id" | |
| }, | |
| "description": "The ID of the Chat to use. If not provided, a new Chat will be created." | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists.", | |
| "title": "Tags" | |
| }, | |
| "description": "If creating a new chat, add these tags to it. This is ignored if the chat already exists." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/alation_ai__api__v1__endpoints__chat__get_groups_tool_parameters" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ChatTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sql_evaluation_set/{data_product_id}": { | |
| "get": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Get a SQL Eval Set", | |
| "description": "Get a SQL Eval Set for a Data Product.", | |
| "operationId": "get_sql_evaluation_set", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SQLEvaluationSet" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Create SQL Eval Cases", | |
| "description": "Create SQL Evaluation Cases.", | |
| "operationId": "create_sql_evaluation_cases", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "pre_exec_sql", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "SQL to execute before the checking (e.g., for setting session parameters)", | |
| "title": "Pre Exec Sql" | |
| }, | |
| "description": "SQL to execute before the checking (e.g., for setting session parameters)" | |
| }, | |
| { | |
| "name": "auth_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The authentication ID for the credentials to use for the queries. If None, auth_id is obtained from the data product", | |
| "title": "Auth Id" | |
| }, | |
| "description": "The authentication ID for the credentials to use for the queries. If None, auth_id is obtained from the data product" | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/SQLEvaluationCaseCreate" | |
| }, | |
| "title": "Eval Case Creates" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/SQLEvaluationCase" | |
| }, | |
| "title": "Response Create Sql Evaluation Cases Api V1 Sql Evaluation Set Data Product Id Post" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sql_evaluation_set/{data_product_id}/{eval_case_id}": { | |
| "get": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Get a SQL Eval Case", | |
| "description": "Get a single SQL Evaluation Case by ID.", | |
| "operationId": "get_sql_evaluation_case", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "eval_case_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the SQL Eval Case to use.", | |
| "title": "Eval Case Id" | |
| }, | |
| "description": "The ID of the SQL Eval Case to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SQLEvaluationCase" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Update SQL Eval Case", | |
| "description": "Update a SQL Evaluation Case.", | |
| "operationId": "update_sql_evaluation_case", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "eval_case_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the SQL Eval Case to use.", | |
| "title": "Eval Case Id" | |
| }, | |
| "description": "The ID of the SQL Eval Case to use." | |
| }, | |
| { | |
| "name": "pre_exec_sql", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "SQL to execute before the checking (e.g., for setting session parameters)", | |
| "title": "Pre Exec Sql" | |
| }, | |
| "description": "SQL to execute before the checking (e.g., for setting session parameters)" | |
| }, | |
| { | |
| "name": "auth_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The authentication ID for the credentials to use for the queries. If None, auth_id is obtained from the data product", | |
| "title": "Auth Id" | |
| }, | |
| "description": "The authentication ID for the credentials to use for the queries. If None, auth_id is obtained from the data product" | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SQLEvaluationCaseUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SQLEvaluationCase" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Delete a SQL Eval Case", | |
| "description": "Delete a SQL Evaluation Case.", | |
| "operationId": "delete_eval_case", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "eval_case_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the SQL Eval Case to use.", | |
| "title": "Eval Case Id" | |
| }, | |
| "description": "The ID of the SQL Eval Case to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sql_evaluation_set/{data_product_id}/csv": { | |
| "post": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Create SQL Eval Cases from CSV", | |
| "description": "Create SQL Evaluation Cases from a CSV.\n\nThe CSV requires columns titled \"question\" and \"sql\".", | |
| "operationId": "create_sql_eval_cases_from_csv", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "pre_exec_sql", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "SQL to execute before the checking (e.g., for setting session parameters)", | |
| "title": "Pre Exec Sql" | |
| }, | |
| "description": "SQL to execute before the checking (e.g., for setting session parameters)" | |
| }, | |
| { | |
| "name": "auth_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The authentication ID for the credentials to use for the queries. If None, auth_id is obtained from the data product", | |
| "title": "Auth Id" | |
| }, | |
| "description": "The authentication ID for the credentials to use for the queries. If None, auth_id is obtained from the data product" | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Body_create_sql_eval_cases_from_csv_api_v1_sql_evaluation_set__data_product_id__csv_post" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/SQLEvaluationCase" | |
| }, | |
| "title": "Response Create Sql Eval Cases From Csv Api V1 Sql Evaluation Set Data Product Id Csv Post" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/run_sql_evaluation/{data_product_id}": { | |
| "post": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Run a SQL Eval", | |
| "description": "Run a SQL Evaluation on a Data Product's Eval Set.", | |
| "operationId": "run_sql_evaluation", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "data_product_version", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The version of the Data Product to evaluate. If not provided, uses the dp_id alone and uses the version assigned to dp_id.", | |
| "title": "Data Product Version" | |
| }, | |
| "description": "The version of the Data Product to evaluate. If not provided, uses the dp_id alone and uses the version assigned to dp_id." | |
| }, | |
| { | |
| "name": "pre_exec_sql", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "SQL to execute before the Eval (e.g., for setting session parameters)", | |
| "title": "Pre Exec Sql" | |
| }, | |
| "description": "SQL to execute before the Eval (e.g., for setting session parameters)" | |
| }, | |
| { | |
| "name": "auth_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The authentication ID for the credentials to use for the queries.", | |
| "title": "Auth Id" | |
| }, | |
| "description": "The authentication ID for the credentials to use for the queries." | |
| }, | |
| { | |
| "name": "agent_config_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| }, | |
| { | |
| "name": "default_agent_ref", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/DefaultAgentRef" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Reference string of the default agent to use. Only used if no agent_config_id is provided.", | |
| "title": "Default Agent Ref" | |
| }, | |
| "description": "Reference string of the default agent to use. Only used if no agent_config_id is provided." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "title": "Response Run Sql Evaluation Api V1 Run Sql Evaluation Data Product Id Post" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Must provide either agent_config_id or default_agent_ref", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sql_evaluation_results/{data_product_id}": { | |
| "get": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Get SQL Eval Results", | |
| "description": "Get saved results for completed SQL evaluation runs.\n\nResults are sorted by creation time, descending.\nResults include only metadata from the selected evaluation runs.", | |
| "operationId": "get_sql_evaluation_results", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of results to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of results to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the results to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the results to include in the response." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_SQLEvaluationResultMetadata_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sql_evaluation_results/{data_product_id}/{eval_result_id}": { | |
| "get": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Get SQL Eval Result", | |
| "description": "Get a detailed report for a SQL Evaluation run.", | |
| "operationId": "get_sql_evaluation_result", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "eval_result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the SQL Eval result to use.", | |
| "title": "Eval Result Id" | |
| }, | |
| "description": "The ID of the SQL Eval result to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SQLEvaluationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Delete SQL Eval Result", | |
| "description": "Delete a SQL Evaluation Result.", | |
| "operationId": "delete_sql_evaluation_result", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "eval_result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the SQL Eval result to use.", | |
| "title": "Eval Result Id" | |
| }, | |
| "description": "The ID of the SQL Eval result to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/sql_evaluation_results/{data_product_id}/{eval_result_id}/csv": { | |
| "get": { | |
| "tags": [ | |
| "SQL Evaluation" | |
| ], | |
| "summary": "Get SQL Eval Result as CSV", | |
| "description": "Download a CSV of the SQL Evaluation run.", | |
| "operationId": "get_sql_evaluation_result_as_csv", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| }, | |
| { | |
| "name": "eval_result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the SQL Eval result to use.", | |
| "title": "Eval Result Id" | |
| }, | |
| "description": "The ID of the SQL Eval result to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets/": { | |
| "get": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Get a page of Eval Sets", | |
| "description": "Get a page of generic Evaluation Sets.", | |
| "operationId": "get_evaluation_sets", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Agent Config Id" | |
| } | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of results to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of results to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the results to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the results to include in the response." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_GenericEvaluationSet_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets/{eval_set_id}": { | |
| "get": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Get an Eval Set", | |
| "description": "Get a generic Evaluation Set by ID.", | |
| "operationId": "get_evaluation_set", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationSet" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Update an Eval Set", | |
| "description": "Update a generic Evaluation Set.", | |
| "operationId": "update_evaluation_set", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationSetUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationSet" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Delete an Eval Set", | |
| "description": "Delete an Evaluation Set.", | |
| "operationId": "delete_evaluation_set", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets": { | |
| "post": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Create an Eval Set", | |
| "description": "Create a new generic Evaluation Set.", | |
| "operationId": "create_evaluation_set", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationSetCreate" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationSet" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets/{eval_set_id}/cases": { | |
| "post": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Create Eval Cases", | |
| "description": "Create generic Eval Cases.", | |
| "operationId": "create_evaluation_cases", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/GenericEvaluationCaseCreate" | |
| }, | |
| "title": "Eval Case Creates" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/GenericEvaluationCase" | |
| }, | |
| "title": "Response Create Evaluation Cases Api V1 Evaluation Sets Eval Set Id Cases Post" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets/{eval_set_id}/cases/json": { | |
| "post": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Create Eval Cases from JSON", | |
| "description": "Create Eval Cases from a JSON file.\n\nThe file should be a list of cases, with keys: \"inputs\" and \"expected_output\".", | |
| "operationId": "create_eval_cases_from_json", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Body_create_eval_cases_from_json_api_v1_evaluation_sets__eval_set_id__cases_json_post" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/GenericEvaluationCase" | |
| }, | |
| "title": "Response Create Eval Cases From Json Api V1 Evaluation Sets Eval Set Id Cases Json Post" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_cases/{eval_case_id}": { | |
| "get": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Get an Eval Case", | |
| "description": "Get a generic Eval Case.", | |
| "operationId": "get_evaluation_case", | |
| "parameters": [ | |
| { | |
| "name": "eval_case_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Case to use.", | |
| "title": "Eval Case Id" | |
| }, | |
| "description": "The ID of the Eval Case to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationCase" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Update an Eval Case", | |
| "description": "Update a generic Eval Case.", | |
| "operationId": "update_evaluation_case", | |
| "parameters": [ | |
| { | |
| "name": "eval_case_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Case to use.", | |
| "title": "Eval Case Id" | |
| }, | |
| "description": "The ID of the Eval Case to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationCaseUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationCase" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Delete an Eval Case", | |
| "description": "Delete a generic Eval Case.", | |
| "operationId": "delete_evaluation_case", | |
| "parameters": [ | |
| { | |
| "name": "eval_case_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Case to use.", | |
| "title": "Eval Case Id" | |
| }, | |
| "description": "The ID of the Eval Case to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets/{eval_set_id}/run": { | |
| "post": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Run an Eval", | |
| "description": "Run Generic Evaluation on an Evaluation Set.", | |
| "operationId": "run_evaluation", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "title": "Response Run Evaluation Api V1 Evaluation Sets Eval Set Id Run Post" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_sets/{eval_set_id}/results": { | |
| "get": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Get results for an Eval run", | |
| "description": "Get saved results for completed generic evaluation runs.\n\nResults are sorted by creation time, descending.\nResults include only metadata from the selected evaluation runs.", | |
| "operationId": "get_evaluation_results", | |
| "parameters": [ | |
| { | |
| "name": "eval_set_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval Set to use.", | |
| "title": "Eval Set Id" | |
| }, | |
| "description": "The ID of the Eval Set to use." | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of results to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of results to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the results to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the results to include in the response." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_GenericEvaluationResultMetadata_" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_results/{eval_result_id}": { | |
| "get": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Get a report for an Eval run", | |
| "description": "Get a detailed report for a Generic Evaluation run.", | |
| "operationId": "get_evaluation_result", | |
| "parameters": [ | |
| { | |
| "name": "eval_result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval result to use.", | |
| "title": "Eval Result Id" | |
| }, | |
| "description": "The ID of the Eval result to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEvaluationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Delete the results of an Eval run", | |
| "description": "Delete a Generic Evaluation Result.", | |
| "operationId": "delete_evaluation_result", | |
| "parameters": [ | |
| { | |
| "name": "eval_result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval result to use.", | |
| "title": "Eval Result Id" | |
| }, | |
| "description": "The ID of the Eval result to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/evaluation_results/{eval_result_id}/csv": { | |
| "get": { | |
| "tags": [ | |
| "Evaluation" | |
| ], | |
| "summary": "Get a CSV of an Eval run", | |
| "description": "Download a CSV of the Generic Evaluation run.", | |
| "operationId": "get_evaluation_result_as_csv", | |
| "parameters": [ | |
| { | |
| "name": "eval_result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Eval result to use.", | |
| "title": "Eval Result Id" | |
| }, | |
| "description": "The ID of the Eval result to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": {} | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get a page of Agent Configs", | |
| "description": "Get a page of Agent Configs.", | |
| "operationId": "get_agent_configs", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of agent configs to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of agent configs to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the agent configs to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the agent configs to include in the response." | |
| }, | |
| { | |
| "name": "visibility_labels", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/VisibilityLabel" | |
| }, | |
| "description": "Filter by visibility labels.", | |
| "default": [ | |
| "featured", | |
| "regular" | |
| ], | |
| "title": "Visibility Labels" | |
| }, | |
| "description": "Filter by visibility labels." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_AgentConfig_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Create an Agent Config", | |
| "description": "Create an Agent Config.", | |
| "operationId": "create_agent_config", | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfigCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent/{agent_config_id}": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get an Agent Config", | |
| "description": "Get an Agent Config.", | |
| "operationId": "get_agent_config", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Update an Agent Config", | |
| "description": "Update an Agent Config.", | |
| "operationId": "update_agent_config", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfigUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Delete an Agent Config", | |
| "description": "Delete an Agent Config.", | |
| "operationId": "delete_agent_config", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "400": { | |
| "description": "Cannot delete a default Agent Config." | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent/default/{default_agent_ref}": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get a default Agent Config", | |
| "description": "Get a default Agent Config.", | |
| "operationId": "get_default_agent_config", | |
| "parameters": [ | |
| { | |
| "name": "default_agent_ref", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/components/schemas/DefaultAgentRef", | |
| "description": "The default agent ref." | |
| }, | |
| "description": "The default agent ref." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent/{agent_config_id}/publish_as_tool": { | |
| "post": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Publish an Agent as a Tool", | |
| "description": "Publish an Agent as a Tool.", | |
| "operationId": "publish_agent_as_tool", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ToolConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent/{agent_config_id}/unpublish_tool": { | |
| "delete": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Unpublish an Agent as a Tool", | |
| "description": "Unpublish an Agent as a Tool.", | |
| "operationId": "unpublish_agent_tool", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent/{agent_config_id}/clone": { | |
| "post": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Clone an Agent Config", | |
| "description": "Clone an Agent Config.", | |
| "operationId": "clone_agent_config", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/agent/{agent_config_id}/clone_deep_research": { | |
| "post": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Clone a deep-research Agent Config", | |
| "description": "Clone a deep-research Agent Config.", | |
| "operationId": "clone_deep_research_agent_config", | |
| "parameters": [ | |
| { | |
| "name": "agent_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Agent Config to use.", | |
| "title": "Agent Config Id" | |
| }, | |
| "description": "The ID of the Agent Config to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DeepResearchPlanSchema" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/tool": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get a page of Tool Configs", | |
| "description": "Get a page of Tool Configs.", | |
| "operationId": "get_tool_configs", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of tool configs to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of tool configs to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the tool configs to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the tool configs to include in the response." | |
| }, | |
| { | |
| "name": "visibility_labels", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/VisibilityLabel" | |
| }, | |
| "description": "Filter by visibility labels.", | |
| "default": [ | |
| "featured", | |
| "regular" | |
| ], | |
| "title": "Visibility Labels" | |
| }, | |
| "description": "Filter by visibility labels." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_ToolConfig_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/tool/{tool_config_id}": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get a Tool Config", | |
| "description": "Get a Tool Config.", | |
| "operationId": "get_tool_config", | |
| "parameters": [ | |
| { | |
| "name": "tool_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the Tool Config to use.", | |
| "title": "Tool Config Id" | |
| }, | |
| "description": "The ID of the Tool Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ToolConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/llm": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get a page of LLM Configs", | |
| "description": "Get a page of LLM Configs.", | |
| "operationId": "get_llm_configs", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "The maximum number of LLM configs to include in the response.", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "The maximum number of LLM configs to include in the response." | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "The start index of the LLM configs to include in the response.", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "The start index of the LLM configs to include in the response." | |
| }, | |
| { | |
| "name": "visibility_labels", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/VisibilityLabel" | |
| }, | |
| "description": "Filter by visibility labels.", | |
| "default": [ | |
| "featured", | |
| "regular" | |
| ], | |
| "title": "Visibility Labels" | |
| }, | |
| "description": "Filter by visibility labels." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_LLMConfig_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/config/llm/{llm_config_id}": { | |
| "get": { | |
| "tags": [ | |
| "Config" | |
| ], | |
| "summary": "Get an LLM Config", | |
| "description": "Get an LLM Config.", | |
| "operationId": "get_llm_config", | |
| "parameters": [ | |
| { | |
| "name": "llm_config_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The ID of the LLM Config to use.", | |
| "title": "Llm Config Id" | |
| }, | |
| "description": "The ID of the LLM Config to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/LLMConfig" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Resource not found. The detail field specifies which resource.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/task/{task_id}": { | |
| "get": { | |
| "tags": [ | |
| "Task" | |
| ], | |
| "summary": "Get a Task", | |
| "description": "Get details about a specific Task.", | |
| "operationId": "get_task_details", | |
| "parameters": [ | |
| { | |
| "name": "task_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid", | |
| "description": "The ID of the task.", | |
| "title": "Task Id" | |
| }, | |
| "description": "The ID of the task." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskOut" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "A task with the task_id was not found." | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/feedback": { | |
| "post": { | |
| "tags": [ | |
| "Feedback" | |
| ], | |
| "summary": "Create feedback", | |
| "description": "Submit feedback for a data product.", | |
| "operationId": "create_feedback", | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/FeedbackCreate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Feedback" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Feedback" | |
| ], | |
| "summary": "List feedback", | |
| "description": "Browse feedback entries with filters and pagination.", | |
| "operationId": "list_feedback", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "minLength": 1 | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The data product ID to filter feedback by", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The data product ID to filter feedback by" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "minimum": 0, | |
| "description": "Number of items to skip for pagination", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "Number of items to skip for pagination" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "maximum": 1000, | |
| "minimum": 1, | |
| "description": "Maximum number of items to return", | |
| "default": 10, | |
| "title": "Limit" | |
| }, | |
| "description": "Maximum number of items to return" | |
| }, | |
| { | |
| "name": "sort_by", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "enum": [ | |
| "created_at", | |
| "sentiment", | |
| "user_id", | |
| "data_product_id" | |
| ], | |
| "type": "string", | |
| "description": "Field to sort by", | |
| "default": "created_at", | |
| "title": "Sort By" | |
| }, | |
| "description": "Field to sort by" | |
| }, | |
| { | |
| "name": "sort_order", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "enum": [ | |
| "desc", | |
| "asc" | |
| ], | |
| "type": "string", | |
| "description": "Sort order", | |
| "default": "desc", | |
| "title": "Sort Order" | |
| }, | |
| "description": "Sort order" | |
| }, | |
| { | |
| "name": "sentiment", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/SentimentType" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Filter feedback by sentiment", | |
| "title": "Sentiment" | |
| }, | |
| "description": "Filter feedback by sentiment" | |
| }, | |
| { | |
| "name": "user_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid4" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Filter feedback by user ID", | |
| "title": "User Id" | |
| }, | |
| "description": "Filter feedback by user ID" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_Feedback_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/feedback/{feedback_id}": { | |
| "get": { | |
| "tags": [ | |
| "Feedback" | |
| ], | |
| "summary": "Get single feedback", | |
| "description": "Retrieve a feedback entry by its identifier.", | |
| "operationId": "get_feedback_by_id", | |
| "parameters": [ | |
| { | |
| "name": "feedback_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The feedback ID to retrieve", | |
| "title": "Feedback Id" | |
| }, | |
| "description": "The feedback ID to retrieve" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Feedback" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Feedback" | |
| ], | |
| "summary": "Update feedback", | |
| "description": "Update the sentiment or comment for an existing feedback entry.", | |
| "operationId": "update_feedback", | |
| "parameters": [ | |
| { | |
| "name": "feedback_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The feedback ID to update", | |
| "title": "Feedback Id" | |
| }, | |
| "description": "The feedback ID to update" | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/FeedbackUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Feedback" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Feedback" | |
| ], | |
| "summary": "Delete feedback", | |
| "description": "Remove a feedback entry from the system.", | |
| "operationId": "delete_feedback", | |
| "parameters": [ | |
| { | |
| "name": "feedback_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid4", | |
| "description": "The feedback ID to delete", | |
| "title": "Feedback Id" | |
| }, | |
| "description": "The feedback ID to delete" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successful Response" | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/create_data_product": { | |
| "post": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Create data product", | |
| "description": "Create a data product from the provided table and column information.", | |
| "operationId": "create_data_product", | |
| "parameters": [ | |
| { | |
| "name": "generate_missing_descriptions", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": true, | |
| "title": "Generate Missing Descriptions" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataProductCreationInfo" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataProductTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/get_data_product/{task_id}": { | |
| "get": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Get data product task", | |
| "description": "Get details about a specific data product task.", | |
| "operationId": "get_data_product", | |
| "parameters": [ | |
| { | |
| "name": "task_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid", | |
| "description": "The ID of the task.", | |
| "title": "Task Id" | |
| }, | |
| "description": "The ID of the task." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/TaskOut" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "title": "Response Get Data Product Api V1 Data Product Get Data Product Task Id Get" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "A task with the task_id was not found." | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/update_data_product_description": { | |
| "put": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Update data product description", | |
| "description": "Update data product description.", | |
| "operationId": "update_data_product_description", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataProductToUpdate" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "title": "Response Update Data Product Description Api V1 Data Product Update Data Product Description Put" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/{data_product_id}/revise_data_product": { | |
| "post": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Initiate Revise Data Product Workflow", | |
| "description": "Initiate a new \"Suggest Fixes\" workflow for a specified data product.", | |
| "operationId": "initiate_revise_data_product", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the data product to revise.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the data product to revise." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ReviseDataProductRequest" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ReviseDataProductResponse" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/revise_data_product_jobs": { | |
| "get": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Get All Revise Data Product Jobs", | |
| "description": "Retrieve all Revise Data Product jobs.\n\nThe results include running jobs by default, and may optionally be filtered by data product.", | |
| "operationId": "get_all_revise_data_product_results", | |
| "parameters": [ | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "$ref": "#/components/schemas/EvaluationRunStatus", | |
| "description": "Filter by run status", | |
| "default": "RUNNING" | |
| }, | |
| "description": "Filter by run status" | |
| }, | |
| { | |
| "name": "data_product_id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Filter by data product ID", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "Filter by data product ID" | |
| }, | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "description": "Maximum number of results to return", | |
| "default": 100, | |
| "title": "Limit" | |
| }, | |
| "description": "Maximum number of results to return" | |
| }, | |
| { | |
| "name": "offset", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "description": "Number of results to skip", | |
| "default": 0, | |
| "title": "Offset" | |
| }, | |
| "description": "Number of results to skip" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DataPage_ReviseDataProductResultSummary_" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/revise_data_product_jobs/{result_id}": { | |
| "get": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Get Revise Data Product Result", | |
| "description": "Retrieve the current status and intermediate results of a specific \"Suggest Fixes\" task.\n\nOnce complete, it will include the initial and final data product specifications.", | |
| "operationId": "get_revise_data_product_result", | |
| "parameters": [ | |
| { | |
| "name": "result_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid", | |
| "description": "The ID of the result (task ID).", | |
| "title": "Result Id" | |
| }, | |
| "description": "The ID of the result (task ID)." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ReviseDataProductResultDetail" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/{data_product_id}/validate_sql": { | |
| "post": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Validate SQL", | |
| "description": "Validate the SQL statements against the specified data product.", | |
| "operationId": "validate_sql", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "title": "Sql Statements" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/SqlWithValidation" | |
| }, | |
| "title": "Response Validate Sql Api V1 Data Product Data Product Id Validate Sql Post" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/{data_product_id}/extract_metrics": { | |
| "post": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Extract metrics from SQL", | |
| "description": "Extract metrics from the SQL statements against the specified data product", | |
| "operationId": "extract_metrics", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| } | |
| ], | |
| "requestBody": { | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "title": "Sql Statements" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ExtractMetricTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/{data_product_id}/extract_metrics_from_sample_queries": { | |
| "post": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Extract metrics from sample queries", | |
| "description": "Extract metrics from the sample queries against the specified data product", | |
| "operationId": "extract_metrics_from_sample_queries", | |
| "parameters": [ | |
| { | |
| "name": "data_product_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "description": "The ID of the Data Product to use.", | |
| "title": "Data Product Id" | |
| }, | |
| "description": "The ID of the Data Product to use." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ExtractMetricTask" | |
| } | |
| } | |
| } | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/data_product/get_metrics/{task_id}": { | |
| "get": { | |
| "tags": [ | |
| "Data Product" | |
| ], | |
| "summary": "Get data product metrics extraction task", | |
| "description": "Get details about a specific data product metrics extraction task.", | |
| "operationId": "get_metrics", | |
| "parameters": [ | |
| { | |
| "name": "task_id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid", | |
| "description": "The ID of the task.", | |
| "title": "Task Id" | |
| }, | |
| "description": "The ID of the task." | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful Response", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/TaskOut" | |
| }, | |
| { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/SqlMetricResult" | |
| } | |
| } | |
| ], | |
| "title": "Response Get Metrics Api V1 Data Product Get Metrics Task Id Get" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "A task with the task_id was not found." | |
| }, | |
| "422": { | |
| "description": "Validation Error", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPValidationError" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Authentication required. No valid session cookie or bearer token provided, or authentication failed.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "500": { | |
| "description": "Internal server error during request processing.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "additionalProperties": false, | |
| "description": "Standard HTTP error response model.", | |
| "examples": [ | |
| { | |
| "detail": "HTTPException raised." | |
| }, | |
| { | |
| "detail": { | |
| "error": "Validation failed", | |
| "field": "name" | |
| } | |
| } | |
| ], | |
| "properties": { | |
| "detail": { | |
| "description": "Error details.\n\nUsually a human-readable error message, but may contain structured error information for complex\nvalidation failures.", | |
| "title": "Detail" | |
| } | |
| }, | |
| "required": [ | |
| "detail" | |
| ], | |
| "title": "HTTPError", | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "AestheticStyle": { | |
| "properties": { | |
| "interpolate": { | |
| "$ref": "#/components/schemas/InterpolationType", | |
| "description": "Line/area interpolation method", | |
| "default": "monotone" | |
| }, | |
| "point_size": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Point Size", | |
| "description": "Point mark size" | |
| }, | |
| "opacity": { | |
| "anyOf": [ | |
| { | |
| "type": "number" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Opacity", | |
| "description": "Mark opacity (0-1)" | |
| }, | |
| "stroke_width": { | |
| "anyOf": [ | |
| { | |
| "type": "number" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Stroke Width", | |
| "description": "Stroke width for marks" | |
| }, | |
| "corner_radius": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Corner Radius", | |
| "description": "Corner radius for bars" | |
| }, | |
| "color_scheme": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Color Scheme", | |
| "description": "Named color scheme (e.g., 'category10', 'viridis', 'blues')" | |
| }, | |
| "color_domain": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "number" | |
| } | |
| ] | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Color Domain", | |
| "description": "Explicit domain values for color scale" | |
| }, | |
| "color_range": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Color Range", | |
| "description": "Explicit color values for color scale" | |
| }, | |
| "font_family": { | |
| "type": "string", | |
| "title": "Font Family", | |
| "description": "Font family for all text", | |
| "default": "Inter, system-ui, -apple-system, sans-serif" | |
| }, | |
| "label_font_size": { | |
| "type": "integer", | |
| "title": "Label Font Size", | |
| "description": "Font size for axis labels", | |
| "default": 11 | |
| }, | |
| "title_font_size": { | |
| "type": "integer", | |
| "title": "Title Font Size", | |
| "description": "Font size for axis titles", | |
| "default": 12 | |
| }, | |
| "grid_opacity": { | |
| "type": "number", | |
| "title": "Grid Opacity", | |
| "description": "Grid line opacity", | |
| "default": 0.5 | |
| }, | |
| "axis_domain_width": { | |
| "type": "number", | |
| "title": "Axis Domain Width", | |
| "description": "Width of axis domain line", | |
| "default": 1.0 | |
| }, | |
| "mark_properties": { | |
| "additionalProperties": true, | |
| "type": "object", | |
| "title": "Mark Properties", | |
| "description": "Additional mark-specific properties (e.g., {'tooltip': True, 'point': True})" | |
| } | |
| }, | |
| "type": "object", | |
| "title": "AestheticStyle", | |
| "description": "Visual styling and theming configuration.\n\nThis layer defines HOW things look, not WHAT they represent." | |
| }, | |
| "AgentConfig": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the agent config." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "title": "Name", | |
| "description": "Display name of the agent (e.g., \"SQL Query Agent\")." | |
| }, | |
| "description": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Description", | |
| "description": "Optional description of the agent's purpose and capabilities." | |
| }, | |
| "prompt": { | |
| "type": "string", | |
| "title": "Prompt", | |
| "description": "System prompt that defines the agent's behavior and instructions.\n\nThis prompt establishes the agent's role, capabilities, and response format.\nCombined with tool descriptions to form the complete context sent to the LLM." | |
| }, | |
| "llm_config": { | |
| "$ref": "#/components/schemas/LLMConfig", | |
| "description": "The LLM configuration this agent uses for generating responses." | |
| }, | |
| "llm_extra_config": { | |
| "anyOf": [ | |
| { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/OpenAIConfig" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/BedrockConfig" | |
| } | |
| ], | |
| "discriminator": { | |
| "propertyName": "extra_config_type", | |
| "mapping": { | |
| "bedrock_config": "#/components/schemas/BedrockConfig", | |
| "openai_config": "#/components/schemas/OpenAIConfig" | |
| } | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Llm Extra Config", | |
| "description": "Extra configuration for the LLM." | |
| }, | |
| "tool_configs": { | |
| "items": { | |
| "$ref": "#/components/schemas/ToolConfig" | |
| }, | |
| "type": "array", | |
| "title": "Tool Configs", | |
| "description": "List of tools available to this agent during conversations.\n\nTools provide the agent with capabilities like SQL execution, schema lookup,\nand catalog search." | |
| }, | |
| "parameter_bindings": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/ParameterBinding" | |
| }, | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Parameter Bindings", | |
| "description": "Explicit parameter bindings for each tool.\n\nThe order and length of this list matches tool_configs. Each dict maps\nparameter names to their ParameterBinding specifications.\n\nIf None, default bindings are computed based on tool parameter schemas." | |
| }, | |
| "is_default": { | |
| "type": "boolean", | |
| "title": "Is Default", | |
| "description": "Whether this is a system default configuration.\n\nDefault configs are read-only. Users can clone them to create custom configurations." | |
| }, | |
| "tool_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Tool Id", | |
| "description": "The ID of the tool that the agent is published as." | |
| }, | |
| "user_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "User Id", | |
| "description": "ID of the user who created this configuration (null for system defaults)." | |
| }, | |
| "published_status": { | |
| "$ref": "#/components/schemas/PublishedStatus", | |
| "description": "Whether the agent is published (PUBLISHED) or still in draft mode (DRAFT)." | |
| }, | |
| "default_ref": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/DefaultAgentRef" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Reference to the predefined agent (e.g., DefaultAgentRef.SQL_QUERY).\n\nUsed to identify which system default this represents. Only set for default configs." | |
| }, | |
| "visibility_label": { | |
| "$ref": "#/components/schemas/VisibilityLabel", | |
| "description": "Visibility label indicating the prominence of this config." | |
| }, | |
| "input_json_schema": { | |
| "additionalProperties": true, | |
| "type": "object", | |
| "title": "Input Json Schema", | |
| "description": "The input schema for the agent.\n\nSpecifies the inputs that the agents require conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nNote that name of parameters are used to inject dependencies into the tools.\nIf a parameter name matches the argument name of a tool, then it will be\ninjected into the tool. It is up to the developer to ensure that the names\nmatch those required by the tools. The names are not validated.\n\nIf the parameters don't match the arguments of the tools, then the LLM may\nstill be able to manually include them in tool calls." | |
| }, | |
| "output_json_schema": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Output Json Schema", | |
| "description": "The output schema json for the agent.\n\nSpecifies the output that the agents output conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nIf None, the agent will output a string." | |
| }, | |
| "updated_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Updated At", | |
| "description": "The time the config was last updated." | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Created At", | |
| "description": "The time the config was created." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "description", | |
| "prompt", | |
| "llm_config", | |
| "llm_extra_config", | |
| "tool_configs", | |
| "is_default", | |
| "tool_id", | |
| "user_id", | |
| "published_status", | |
| "default_ref", | |
| "visibility_label", | |
| "input_json_schema", | |
| "updated_at", | |
| "created_at" | |
| ], | |
| "title": "AgentConfig", | |
| "description": "Agent configuration response schema.\n\nRepresents a complete agent configuration that combines an LLM, tools, system prompt,\nand input/output schemas into a specialized AI assistant. This is the main entity\nusers interact with for conversations." | |
| }, | |
| "AgentConfigCreate": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "minLength": 2, | |
| "title": "Name", | |
| "description": "The name of the agent." | |
| }, | |
| "description": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Description", | |
| "description": "The description of the agent." | |
| }, | |
| "prompt": { | |
| "type": "string", | |
| "minLength": 2, | |
| "title": "Prompt", | |
| "description": "The prompt for the agent." | |
| }, | |
| "llm_config_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Llm Config Id", | |
| "description": "The ID of the LLM config associated with the agent." | |
| }, | |
| "llm_extra_config": { | |
| "anyOf": [ | |
| { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/OpenAIConfig" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/BedrockConfig" | |
| } | |
| ], | |
| "discriminator": { | |
| "propertyName": "extra_config_type", | |
| "mapping": { | |
| "bedrock_config": "#/components/schemas/BedrockConfig", | |
| "openai_config": "#/components/schemas/OpenAIConfig" | |
| } | |
| } | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Llm Extra Config", | |
| "description": "Extra configuration for the LLM." | |
| }, | |
| "tool_config_ids": { | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "type": "array", | |
| "title": "Tool Config Ids", | |
| "description": "The IDs of the tool configs associated with the agent." | |
| }, | |
| "parameter_bindings": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/ParameterBinding" | |
| }, | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Parameter Bindings", | |
| "description": "Explicit parameter bindings for each tool.\n\nThe order and length of this list must match tool_config_ids. Each dict maps\nparameter names to their ParameterBinding specifications.\n\nIf None, default bindings are computed based on tool parameter schemas:\n- Parameters with defaults \u2192 source=\"fixed\", fixed_value=<default>\n- HIDE_FROM_MODEL parameters without defaults \u2192 source=\"user\"\n- Other parameters \u2192 source=\"agent\"" | |
| }, | |
| "input_json_schema": { | |
| "additionalProperties": true, | |
| "type": "object", | |
| "title": "Input Json Schema", | |
| "description": "The input schema for the agent.\n\nWARNING: This field will be required in the future.\n\nSpecifies the inputs that the agents require conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nNote that name of parameters are used to inject dependencies into the tools.\nIf a parameter name matches the argument name of a tool, then it will be\ninjected into the tool. It is up to the developer to ensure that the names\nmatch those required by the tools. The names are not validated.\n\nIf the parameters don't match the arguments of the tools, then the LLM may\nstill be able to manually include them in tool calls." | |
| }, | |
| "output_json_schema": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Output Json Schema", | |
| "description": "The output schema for the agent.\n\nSpecifies the output that the agents output conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nIf None, the agent will output a string." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "description", | |
| "prompt", | |
| "llm_config_id", | |
| "tool_config_ids" | |
| ], | |
| "title": "AgentConfigCreate", | |
| "description": "Schema for creating an agent config." | |
| }, | |
| "AgentConfigUpdate": { | |
| "properties": { | |
| "name": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "minLength": 2 | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Name", | |
| "description": "The name of the agent." | |
| }, | |
| "description": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Description", | |
| "description": "The description of the agent." | |
| }, | |
| "prompt": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "minLength": 2 | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Prompt", | |
| "description": "The prompt for the agent." | |
| }, | |
| "llm_config_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Llm Config Id", | |
| "description": "The ID of the LLM config associated with the agent." | |
| }, | |
| "llm_extra_config": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/OpenAIConfig" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/BedrockConfig" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Llm Extra Config", | |
| "description": "Extra configuration to pass to the LLM when instantiated.\n\nNote: This will be validated against the LLM config's config_schema." | |
| }, | |
| "tool_config_ids": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Tool Config Ids", | |
| "description": "The IDs of the tool configs associated with the agent.\n\nMust be provided if parameter_bindings are provided." | |
| }, | |
| "parameter_bindings": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/ParameterBinding" | |
| }, | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Parameter Bindings", | |
| "description": "Explicit parameter bindings for each tool.\n\nThe order and length of this list must match tool_config_ids.\nIf provided, tool_config_ids must also be provided." | |
| }, | |
| "published_status": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/PublishedStatus" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The published status of the agent." | |
| }, | |
| "input_json_schema": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Input Json Schema", | |
| "description": "The input schema for the agent.\n\nSpecifies the inputs that the agents require conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nNote that name of parameters are used to inject dependencies into the tools.\nIf a parameter name matches the argument name of a tool, then it will be\ninjected into the tool. It is up to the developer to ensure that the names\nmatch those required by the tools. The names are not validated.\n\nIf the parameters don't match the arguments of the tools, then the LLM may\nstill be able to manually include them in tool calls." | |
| }, | |
| "output_json_schema": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Output Json Schema", | |
| "description": "The output schema for the agent.\n\nSpecifies the output that the agents output conforming to the JSON schema\nstandard.\nref: https://json-schema.org/\n\nIf None, the agent will output a string." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "title": "AgentConfigUpdate", | |
| "description": "Schema for updating an agent config." | |
| }, | |
| "AggregatedMetrics": { | |
| "properties": { | |
| "tenant_user_id": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Tenant User Id", | |
| "description": "Tenant-specific user ID. NULL for tenant-level aggregates." | |
| }, | |
| "metric_type": { | |
| "$ref": "#/components/schemas/UsageMetricType", | |
| "description": "The type of the aggregated metric" | |
| }, | |
| "metric_name": { | |
| "type": "string", | |
| "title": "Metric Name", | |
| "description": "The name of the aggregated metric" | |
| }, | |
| "protocol": { | |
| "$ref": "#/components/schemas/UsageProtocol", | |
| "description": "The protocol source of this aggregated metric" | |
| }, | |
| "product_area": { | |
| "$ref": "#/components/schemas/ProductArea", | |
| "description": "The product area that generated this metric." | |
| }, | |
| "count_map": { | |
| "$ref": "#/components/schemas/UsageCountMap", | |
| "description": "Aggregated counts by hour/day/month" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "tenant_user_id", | |
| "metric_type", | |
| "metric_name", | |
| "protocol", | |
| "product_area", | |
| "count_map" | |
| ], | |
| "title": "AggregatedMetrics", | |
| "description": "Aggregated usage metrics for a specific metric.\n\nContains aggregated usage data for a particular tool, agent, or action,\nbroken down by protocol (HTTP or MCP) and time granularity (hourly, daily, monthly)." | |
| }, | |
| "AggregationMethod": { | |
| "type": "string", | |
| "enum": [ | |
| "sum", | |
| "mean", | |
| "median", | |
| "count", | |
| "max", | |
| "min", | |
| "none" | |
| ], | |
| "title": "AggregationMethod", | |
| "description": "Aggregation methods." | |
| }, | |
| "AnalyticIntent": { | |
| "properties": { | |
| "strategy": { | |
| "$ref": "#/components/schemas/AnalyticStrategy", | |
| "description": "High-level visualization strategy. Must be one of: 'distribution' (histogram, box plot), 'correlation' (scatter, heatmap), 'evolution' (line, area for time series), 'ranking' (sorted bar chart), 'part_to_whole' (pie, stacked bar), 'comparison' (grouped bar, side-by-side)" | |
| }, | |
| "measure_field": { | |
| "type": "string", | |
| "title": "Measure Field", | |
| "description": "The primary quantitative field being analyzed" | |
| }, | |
| "dimension_fields": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array", | |
| "title": "Dimension Fields", | |
| "description": "Categorical/temporal fields that split or group the measure" | |
| }, | |
| "aggregation": { | |
| "$ref": "#/components/schemas/AggregationMethod", | |
| "description": "How to aggregate the measure field. Use NONE if data is pre-aggregated.", | |
| "default": "none" | |
| }, | |
| "filter_expr": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Filter Expr", | |
| "description": "Vega-Lite filter expression (e.g., 'datum.sales > 1000')" | |
| }, | |
| "sort_by": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Sort By", | |
| "description": "Field to sort by (for ranking strategy)" | |
| }, | |
| "sort_descending": { | |
| "type": "boolean", | |
| "title": "Sort Descending", | |
| "description": "Sort order for ranking", | |
| "default": true | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "strategy", | |
| "measure_field" | |
| ], | |
| "title": "AnalyticIntent", | |
| "description": "The analytical purpose of the visualization.\n\nThis layer defines WHAT relationship to show, independent of visual form.\n\nNOTE: Why this layer exists (even without strict validation):\n1. Chain of Thought (CoT): Forcing the LLM to explicitly state its intent (e.g., \"evolution\")\n before choosing visual encodings significantly reduces hallucinations. It grounds the\n model in the *semantic* goal before it attempts the *syntactic* implementation.\n2. Future Potential:\n - Validation: Can be used to cross-check `VisualEncoding` (e.g., ensuring 'evolution'\n strategy actually uses a temporal axis).\n - Accessibility: Can generate rich alt-text (e.g., \"A line chart showing the evolution\n of Sales over Time\") automatically.\n - Smart Defaults: Could be used to infer visual encodings if they are omitted." | |
| }, | |
| "AnalyticStrategy": { | |
| "type": "string", | |
| "enum": [ | |
| "distribution", | |
| "correlation", | |
| "evolution", | |
| "ranking", | |
| "part_to_whole", | |
| "comparison" | |
| ], | |
| "title": "AnalyticStrategy", | |
| "description": "High-level visualization strategies." | |
| }, | |
| "AnnotationSpec": { | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "rule", | |
| "text" | |
| ], | |
| "title": "Type", | |
| "description": "Annotation type" | |
| }, | |
| "value": { | |
| "anyOf": [ | |
| { | |
| "type": "number" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "title": "Value", | |
| "description": "Value for the annotation" | |
| }, | |
| "axis": { | |
| "type": "string", | |
| "enum": [ | |
| "x", | |
| "y" | |
| ], | |
| "title": "Axis", | |
| "description": "Which axis the annotation is on", | |
| "default": "y" | |
| }, | |
| "label": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Label", | |
| "description": "Label text for the annotation" | |
| }, | |
| "color": { | |
| "type": "string", | |
| "title": "Color", | |
| "description": "Annotation color", | |
| "default": "#666" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "type", | |
| "value" | |
| ], | |
| "title": "AnnotationSpec", | |
| "description": "Annotation specification for reference lines or markers." | |
| }, | |
| "AudioUrl": { | |
| "properties": { | |
| "url": { | |
| "type": "string", | |
| "title": "Url", | |
| "description": "The URL of the audio file." | |
| }, | |
| "force_download": { | |
| "type": "boolean", | |
| "title": "Force Download", | |
| "default": false | |
| }, | |
| "vendor_metadata": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Vendor Metadata" | |
| }, | |
| "kind": { | |
| "type": "string", | |
| "const": "audio-url", | |
| "title": "Kind", | |
| "description": "Type identifier, this is available on all parts as a discriminator.", | |
| "default": "audio-url" | |
| }, | |
| "media_type": { | |
| "type": "string", | |
| "title": "Media Type", | |
| "description": "Return the media type of the file, based on the URL or the provided `media_type`.", | |
| "readOnly": true | |
| }, | |
| "identifier": { | |
| "type": "string", | |
| "title": "Identifier", | |
| "description": "The identifier of the file, such as a unique ID.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.", | |
| "readOnly": true | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "url", | |
| "media_type", | |
| "identifier" | |
| ], | |
| "title": "AudioUrl" | |
| }, | |
| "BedrockConfig": { | |
| "properties": { | |
| "extra_config_type": { | |
| "type": "string", | |
| "const": "bedrock_config", | |
| "title": "Extra Config Type", | |
| "default": "bedrock_config" | |
| }, | |
| "thinking": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/BedrockThinkingConfig" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Extended thinking configuration" | |
| }, | |
| "guardrail": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/BedrockGuardrailConfig" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Guardrail configuration" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "title": "BedrockConfig", | |
| "description": "Extra configuration for Bedrock LLM models." | |
| }, | |
| "BedrockGuardrailConfig": { | |
| "properties": { | |
| "guardrail_identifier": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Guardrail Identifier", | |
| "description": "Identifier for the guardrail configuration to use" | |
| }, | |
| "guardrail_version": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Guardrail Version", | |
| "description": "Version of the guardrail to use" | |
| }, | |
| "trace": { | |
| "type": "string", | |
| "enum": [ | |
| "enabled", | |
| "disabled" | |
| ], | |
| "title": "Trace", | |
| "description": "Whether to enable guardrail tracing", | |
| "default": "enabled" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "guardrail_identifier", | |
| "guardrail_version" | |
| ], | |
| "title": "BedrockGuardrailConfig", | |
| "description": "Bedrock LLM guardrail configuration." | |
| }, | |
| "BedrockThinkingConfig": { | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "enum": [ | |
| "enabled", | |
| "disabled" | |
| ], | |
| "title": "Type", | |
| "default": "enabled" | |
| }, | |
| "budget_tokens": { | |
| "type": "integer", | |
| "minimum": 1024.0, | |
| "exclusiveMinimum": 0.0, | |
| "title": "Budget Tokens", | |
| "description": "Maximum number of tokens for internal reasoning" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "budget_tokens" | |
| ], | |
| "title": "BedrockThinkingConfig", | |
| "description": "Bedrock LLM thinking configuration." | |
| }, | |
| "BinaryContent": { | |
| "properties": { | |
| "data": { | |
| "type": "string", | |
| "format": "binary", | |
| "title": "Data", | |
| "description": "The binary data." | |
| }, | |
| "media_type": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "enum": [ | |
| "audio/wav", | |
| "audio/mpeg", | |
| "audio/ogg", | |
| "audio/flac", | |
| "audio/aiff", | |
| "audio/aac" | |
| ] | |
| }, | |
| { | |
| "type": "string", | |
| "enum": [ | |
| "image/jpeg", | |
| "image/png", | |
| "image/gif", | |
| "image/webp" | |
| ] | |
| }, | |
| { | |
| "type": "string", | |
| "enum": [ | |
| "application/pdf", | |
| "text/plain", | |
| "text/csv", | |
| "application/vnd.openxmlformats-officedocument.wordprocessingml.document", | |
| "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", | |
| "text/html", | |
| "text/markdown", | |
| "application/msword", | |
| "application/vnd.ms-excel" | |
| ] | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ], | |
| "title": "Media Type", | |
| "description": "The media type of the binary data." | |
| }, | |
| "vendor_metadata": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Vendor Metadata", | |
| "description": "Vendor-specific metadata for the file.\n\nSupported by:\n- `GoogleModel`: `BinaryContent.vendor_metadata` is used as `video_metadata`: https://ai.google.dev/gemini-api/docs/video-understanding#customize-video-processing\n- `OpenAIChatModel`, `OpenAIResponsesModel`: `BinaryContent.vendor_metadata['detail']` is used as `detail` setting for images" | |
| }, | |
| "kind": { | |
| "type": "string", | |
| "const": "binary", | |
| "title": "Kind", | |
| "description": "Type identifier, this is available on all parts as a discriminator.", | |
| "default": "binary" | |
| }, | |
| "identifier": { | |
| "type": "string", | |
| "title": "Identifier", | |
| "description": "Identifier for the binary content, such as a unique ID.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `BinaryContent`.\n\nThis identifier is only automatically passed to the model when the `BinaryContent` is returned by a tool.\nIf you're passing the `BinaryContent` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `BinaryContent`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.", | |
| "readOnly": true | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "media_type", | |
| "identifier" | |
| ], | |
| "title": "BinaryContent" | |
| }, | |
| "Body_create_eval_cases_from_json_api_v1_evaluation_sets__eval_set_id__cases_json_post": { | |
| "properties": { | |
| "json_file": { | |
| "type": "string", | |
| "format": "binary", | |
| "title": "Json File" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "json_file" | |
| ], | |
| "title": "Body_create_eval_cases_from_json_api_v1_evaluation_sets__eval_set_id__cases_json_post" | |
| }, | |
| "Body_create_file_assets_api_v1_assets_upload_files_post": { | |
| "properties": { | |
| "files": { | |
| "items": { | |
| "type": "string", | |
| "format": "binary" | |
| }, | |
| "type": "array", | |
| "title": "Files", | |
| "description": "Files to upload as assets" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "files" | |
| ], | |
| "title": "Body_create_file_assets_api_v1_assets_upload_files_post" | |
| }, | |
| "Body_create_sql_eval_cases_from_csv_api_v1_sql_evaluation_set__data_product_id__csv_post": { | |
| "properties": { | |
| "csv_file": { | |
| "type": "string", | |
| "format": "binary", | |
| "title": "Csv File" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "csv_file" | |
| ], | |
| "title": "Body_create_sql_eval_cases_from_csv_api_v1_sql_evaluation_set__data_product_id__csv_post" | |
| }, | |
| "BuiltinToolCallPart": { | |
| "properties": { | |
| "tool_name": { | |
| "type": "string", | |
| "title": "Tool Name" | |
| }, | |
| "args": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Args" | |
| }, | |
| "tool_call_id": { | |
| "type": "string", | |
| "title": "Tool Call Id" | |
| }, | |
| "id": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Id" | |
| }, | |
| "provider_details": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Provider Details" | |
| }, | |
| "provider_name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Provider Name", | |
| "description": "The name of the provider that generated the response.\n\nBuilt-in tool calls are only sent back to the same provider." | |
| }, | |
| "part_kind": { | |
| "type": "string", | |
| "const": "builtin-tool-call", | |
| "title": "Part Kind", | |
| "description": "Part type identifier, this is available on all parts as a discriminator.", | |
| "default": "builtin-tool-call" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "tool_name" | |
| ], | |
| "title": "BuiltinToolCallPart" | |
| }, | |
| "BuiltinToolReturnPart": { | |
| "properties": { | |
| "tool_name": { | |
| "type": "string", | |
| "title": "Tool Name" | |
| }, | |
| "content": { | |
| "title": "Content" | |
| }, | |
| "tool_call_id": { | |
| "type": "string", | |
| "title": "Tool Call Id" | |
| }, | |
| "metadata": { | |
| "title": "Metadata" | |
| }, | |
| "timestamp": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Timestamp" | |
| }, | |
| "provider_name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Provider Name", | |
| "description": "The name of the provider that generated the response." | |
| }, | |
| "provider_details": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Provider Details", | |
| "description": "Additional data returned by the provider that can't be mapped to standard fields.\n\nThis is used for data that is required to be sent back to APIs, as well as data users may want to access programmatically." | |
| }, | |
| "part_kind": { | |
| "type": "string", | |
| "const": "builtin-tool-return", | |
| "title": "Part Kind", | |
| "description": "Part type identifier, this is available on all parts as a discriminator.", | |
| "default": "builtin-tool-return" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "tool_name", | |
| "content" | |
| ], | |
| "title": "BuiltinToolReturnPart" | |
| }, | |
| "CachePoint": { | |
| "properties": { | |
| "kind": { | |
| "type": "string", | |
| "const": "cache-point", | |
| "title": "Kind", | |
| "description": "Type identifier, this is available on all parts as a discriminator.", | |
| "default": "cache-point" | |
| }, | |
| "ttl": { | |
| "type": "string", | |
| "enum": [ | |
| "5m", | |
| "1h" | |
| ], | |
| "title": "Ttl", | |
| "description": "The cache time-to-live, either \"5m\" (5 minutes) or \"1h\" (1 hour).\n\nSupported by:\n\n* Anthropic (automatically omitted for Bedrock, as it does not support explicit TTL). See https://docs.claude.com/en/docs/build-with-claude/prompt-caching#1-hour-cache-duration for more information.", | |
| "default": "5m" | |
| } | |
| }, | |
| "type": "object", | |
| "title": "CachePoint" | |
| }, | |
| "CatalogObjectType": { | |
| "type": "string", | |
| "enum": [ | |
| "schema", | |
| "table", | |
| "column" | |
| ], | |
| "title": "CatalogObjectType", | |
| "description": "Enumeration of catalog object types." | |
| }, | |
| "ChannelEncoding": { | |
| "properties": { | |
| "field": { | |
| "type": "string", | |
| "title": "Field", | |
| "description": "Data field name" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/FieldType", | |
| "description": "Vega-Lite data type. Must be one of: 'temporal' (dates/times), 'quantitative' (numbers), 'nominal' (unordered categories), 'ordinal' (ordered categories)" | |
| }, | |
| "title": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Title", | |
| "description": "Axis/legend title" | |
| }, | |
| "aggregate": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/AggregationMethod" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Aggregation method" | |
| }, | |
| "scale": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Scale", | |
| "description": "Scale configuration (domain, range, scheme, etc.)" | |
| }, | |
| "sort": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Sort", | |
| "description": "Sort order for this channel" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "field", | |
| "type" | |
| ], | |
| "title": "ChannelEncoding", | |
| "description": "Encoding for a single visual channel." | |
| }, | |
| "ChartGrammar": { | |
| "properties": { | |
| "data_semantics": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/DataSemantics" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Semantic metadata about the data. If not provided, will be inferred from the data." | |
| }, | |
| "analytic_intent": { | |
| "$ref": "#/components/schemas/AnalyticIntent", | |
| "description": "The analytical purpose and relationships to visualize" | |
| }, | |
| "visual_encoding": { | |
| "$ref": "#/components/schemas/VisualEncoding", | |
| "description": "Mapping of data to visual channels" | |
| }, | |
| "aesthetic": { | |
| "$ref": "#/components/schemas/AestheticStyle", | |
| "description": "Visual styling and theming" | |
| }, | |
| "narrative": { | |
| "$ref": "#/components/schemas/NarrativeContext", | |
| "description": "Titles, labels, and annotations" | |
| }, | |
| "additional_layers": { | |
| "items": { | |
| "$ref": "#/components/schemas/LayerSpec" | |
| }, | |
| "type": "array", | |
| "maxItems": 5, | |
| "title": "Additional Layers", | |
| "description": "Additional chart layers (annotations, reference lines)" | |
| }, | |
| "width": { | |
| "type": "integer", | |
| "title": "Width", | |
| "description": "Chart width in pixels", | |
| "default": 600 | |
| }, | |
| "height": { | |
| "type": "integer", | |
| "title": "Height", | |
| "description": "Chart height in pixels", | |
| "default": 400 | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "analytic_intent", | |
| "visual_encoding", | |
| "narrative" | |
| ], | |
| "title": "ChartGrammar", | |
| "description": "Complete chart specification using 5-layer grammar.\n\nThe LLM populates this structure, and it's deterministically compiled to Vega-Lite." | |
| }, | |
| "Chat": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the Chat." | |
| }, | |
| "name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Name", | |
| "description": "Optional display name for the Chat." | |
| }, | |
| "is_running": { | |
| "type": "boolean", | |
| "title": "Is Running", | |
| "description": "Whether the Chat is currently running an agent.\n\nChats that are running will reject new messages.", | |
| "default": false | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Created At", | |
| "description": "The timestamp when the Chat was created." | |
| }, | |
| "updated_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Updated At", | |
| "description": "The timestamp when the Chat was last updated." | |
| }, | |
| "tenant_user_id": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Tenant User Id", | |
| "description": "The ID of the tenant user who created this chat." | |
| }, | |
| "tags": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array", | |
| "title": "Tags", | |
| "description": "If any, the tags this chat is annotated with." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "created_at", | |
| "updated_at" | |
| ], | |
| "title": "Chat", | |
| "description": "Chat response schema.\n\nRepresents a conversation session between a user and an agent. Contains multiple\nmessages that form the conversation history. Each chat is scoped to a tenant." | |
| }, | |
| "ChatCreate": { | |
| "properties": { | |
| "name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Name", | |
| "description": "Optional display name for the Chat." | |
| }, | |
| "tags": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array", | |
| "title": "Tags", | |
| "description": "If any, the tags to add to the chat." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "title": "ChatCreate", | |
| "description": "Chat create schema." | |
| }, | |
| "ChatTask": { | |
| "properties": { | |
| "task_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Task Id", | |
| "description": "The ID of the chat task." | |
| }, | |
| "chat_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Chat Id", | |
| "description": "The ID of the chat associated with the task." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "task_id", | |
| "chat_id" | |
| ], | |
| "title": "ChatTask", | |
| "description": "Response schema for a chat task." | |
| }, | |
| "ChatUpdate": { | |
| "properties": { | |
| "name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Name", | |
| "description": "Optional display name for the Chat." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "title": "ChatUpdate", | |
| "description": "Chat update schema." | |
| }, | |
| "CreatedByFilterOption": { | |
| "type": "string", | |
| "enum": [ | |
| "user", | |
| "all" | |
| ], | |
| "title": "CreatedByFilterOption", | |
| "description": "Filter options for getting chats." | |
| }, | |
| "CustomFieldOperation": { | |
| "type": "string", | |
| "enum": [ | |
| "add", | |
| "remove", | |
| "replace" | |
| ], | |
| "title": "CustomFieldOperation", | |
| "description": "Enumeration of custom field operations.\n\nThe add and remove operations are only applicable for MULTI_PICKER and OBJECT_SET.\nAll custom fields support the replace operation.\n\nThe default operation for MULTI_PICKER and OBJECT_SET is add.\nOtherwise, the default value is be replace." | |
| }, | |
| "CustomFieldType": { | |
| "type": "string", | |
| "enum": [ | |
| "TEXT", | |
| "DATE", | |
| "PICKER", | |
| "OBJECT_SET", | |
| "RICH_TEXT", | |
| "MULTI_PICKER", | |
| "PEOPLE_SET", | |
| "REFERENCE" | |
| ], | |
| "title": "CustomFieldType", | |
| "description": "Enumeration of custom field types.\n\nThese are defined in django/rosemeta/models/enums.py.\nThey're deprecated, but still used for RDBMS objects." | |
| }, | |
| "CustomFieldUpdate": { | |
| "properties": { | |
| "field_id": { | |
| "type": "integer", | |
| "title": "Field Id" | |
| }, | |
| "field_type": { | |
| "$ref": "#/components/schemas/CustomFieldType" | |
| }, | |
| "value": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "items": { | |
| "$ref": "#/components/schemas/ObjectKey" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/ObjectKey" | |
| } | |
| ], | |
| "title": "Value" | |
| }, | |
| "op": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/CustomFieldOperation" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "field_id", | |
| "field_type", | |
| "value" | |
| ], | |
| "title": "CustomFieldUpdate", | |
| "description": "Represents an update to a custom field." | |
| }, | |
| "DataPage_AgentConfig_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/AgentConfig" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[AgentConfig]" | |
| }, | |
| "DataPage_Chat_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/Chat" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[Chat]" | |
| }, | |
| "DataPage_Feedback_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/Feedback" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[Feedback]" | |
| }, | |
| "DataPage_GenericEvaluationResultMetadata_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/GenericEvaluationResultMetadata" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[GenericEvaluationResultMetadata]" | |
| }, | |
| "DataPage_GenericEvaluationSet_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/GenericEvaluationSet" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[GenericEvaluationSet]" | |
| }, | |
| "DataPage_LLMConfig_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/LLMConfig" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[LLMConfig]" | |
| }, | |
| "DataPage_Message_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/Message" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[Message]" | |
| }, | |
| "DataPage_ReviseDataProductResultSummary_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviseDataProductResultSummary" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[ReviseDataProductResultSummary]" | |
| }, | |
| "DataPage_SQLEvaluationResultMetadata_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/SQLEvaluationResultMetadata" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[SQLEvaluationResultMetadata]" | |
| }, | |
| "DataPage_ToolConfig_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "$ref": "#/components/schemas/ToolConfig" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[ToolConfig]" | |
| }, | |
| "DataPage_str_": { | |
| "properties": { | |
| "data": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array", | |
| "title": "Data", | |
| "description": "List of data objects." | |
| }, | |
| "total": { | |
| "type": "integer", | |
| "minimum": 0.0, | |
| "title": "Total", | |
| "description": "Total number of data objects available." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data", | |
| "total" | |
| ], | |
| "title": "DataPage[str]" | |
| }, | |
| "DataProductCreationInfo": { | |
| "properties": { | |
| "table_column_info_list": { | |
| "items": { | |
| "$ref": "#/components/schemas/TableColumnInfo" | |
| }, | |
| "type": "array", | |
| "title": "Table Column Info List" | |
| }, | |
| "existing_data_product": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Existing Data Product" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "table_column_info_list" | |
| ], | |
| "title": "DataProductCreationInfo", | |
| "description": "Information required to create a data product from a table and columns.\n\nNote: existing_data_product is optional; if provided, then it's the yaml str\nof the entire data product spec." | |
| }, | |
| "DataProductTask": { | |
| "properties": { | |
| "task_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Task Id", | |
| "description": "The ID of the data product task." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "task_id" | |
| ], | |
| "title": "DataProductTask", | |
| "description": "Response schema for a data product task." | |
| }, | |
| "DataProductToUpdate": { | |
| "properties": { | |
| "existing_data_product": { | |
| "type": "string", | |
| "title": "Existing Data Product" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "existing_data_product" | |
| ], | |
| "title": "DataProductToUpdate", | |
| "description": "Information required to update an existing data product." | |
| }, | |
| "DataSemantics": { | |
| "properties": { | |
| "fields": { | |
| "items": { | |
| "$ref": "#/components/schemas/FieldSemantics" | |
| }, | |
| "type": "array", | |
| "title": "Fields", | |
| "description": "Semantic metadata for each field in the dataset" | |
| }, | |
| "row_count": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Row Count", | |
| "description": "Number of rows in the dataset" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "fields" | |
| ], | |
| "title": "DataSemantics", | |
| "description": "Semantic understanding of the dataset.\n\nThis layer is about understanding WHAT we're looking at, not HOW to draw it." | |
| }, | |
| "DeepResearchPlanSchema": { | |
| "properties": { | |
| "plan_title": { | |
| "type": "string", | |
| "title": "Plan Title", | |
| "description": "The title of the research plan. This is used to identify the plan." | |
| }, | |
| "plan_steps": { | |
| "items": { | |
| "$ref": "#/components/schemas/ResearchStep" | |
| }, | |
| "type": "array", | |
| "title": "Plan Steps", | |
| "description": "The research plan as a list of main goals with distinct analytics questions to answer for each goal." | |
| }, | |
| "plan_goal": { | |
| "type": "string", | |
| "title": "Plan Goal", | |
| "description": "The main research goal. This is used to help generate the final summary.", | |
| "default": "" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "plan_title", | |
| "plan_steps" | |
| ], | |
| "title": "DeepResearchPlanSchema", | |
| "description": "Schema for the deep research plan." | |
| }, | |
| "DefaultAgentRef": { | |
| "type": "string", | |
| "enum": [ | |
| "sql_query_agent", | |
| "bi_report_agent", | |
| "catalog_search_agent", | |
| "charting_agent", | |
| "deep_research_agent", | |
| "data_product_query_agent", | |
| "query_flow_agent", | |
| "data_product_question_manager_agent", | |
| "catalog_context_search_agent", | |
| "revise_data_product_agent", | |
| "dp_suggest_fixes_job_agent", | |
| "curation_agent" | |
| ], | |
| "title": "DefaultAgentRef", | |
| "description": "Names of default agents hardcoded into alation AI." | |
| }, | |
| "DefaultCatalogContextSearchAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The user's question or request about the data catalog." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message" | |
| ], | |
| "title": "DefaultCatalogContextSearchAgentPayload", | |
| "description": "The input schema for the catalog context search agent." | |
| }, | |
| "DefaultCatalogSearchAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message" | |
| ], | |
| "title": "DefaultCatalogSearchAgentPayload", | |
| "description": "The input schema for the default catalog search agent." | |
| }, | |
| "DefaultCurationAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| }, | |
| "asset_ids": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Asset Ids", | |
| "description": "List of file asset IDs to use when addressing the curation request." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message" | |
| ], | |
| "title": "DefaultCurationAgentPayload", | |
| "description": "The input schema for the curation agent." | |
| }, | |
| "DefaultDataProductQueryAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| }, | |
| "data_product_id": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Data Product Id", | |
| "description": "The ID of the data product to use." | |
| }, | |
| "auth_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Auth Id", | |
| "description": "The ID of the authentication credentials to use for the query." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "data_product_id" | |
| ], | |
| "title": "DefaultDataProductQueryAgentPayload", | |
| "description": "The input schema for the default data product query agent." | |
| }, | |
| "DefaultDeepResearchAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message" | |
| ], | |
| "title": "DefaultDeepResearchAgentPayload", | |
| "description": "Input schema for the default deep research agent." | |
| }, | |
| "DefaultLLMRef": { | |
| "type": "string", | |
| "enum": [ | |
| "openai:o3", | |
| "openai:gpt-4o", | |
| "openai:gpt-4.1", | |
| "openai:gpt-5-2025-08-07", | |
| "bedrock_us-west-2:anthropic.claude-3-5-sonnet-20240620-v1:0", | |
| "bedrock_us-east-1:anthropic.claude-3-5-sonnet-20240620-v1:0", | |
| "bedrock_eu-west-1:anthropic.claude-3-sonnet-20240229-v1:0", | |
| "bedrock_eu-central-1:anthropic.claude-3-5-sonnet-20240620-v1:0", | |
| "bedrock_ca-central-1:anthropic.claude-3-sonnet-20240229-v1:0", | |
| "bedrock_ap-southeast-2:anthropic.claude-3-5-sonnet-20241022-v2:0", | |
| "bedrock_ap-southeast-1:anthropic.claude-3-5-sonnet-20240620-v1:0", | |
| "bedrock_ap-northeast-1:anthropic.claude-3-5-sonnet-20240620-v1:0", | |
| "bedrock_ap-south-1:anthropic.claude-3-sonnet-20240229-v1:0", | |
| "bedrock_us-east-1:us.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_us-east-2:us.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_us-west-1:us.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_us-west-2:us.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_eu-central-1:eu.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_eu-west-1:eu.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_ap-northeast-1:jp.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_ap-southeast-2:au.anthropic.claude-sonnet-4-5-20250929-v1:0", | |
| "bedrock_ap-southeast-2:apac.anthropic.claude-sonnet-4-20250514-v1:0", | |
| "bedrock_ap-southeast-1:apac.anthropic.claude-sonnet-4-20250514-v1:0", | |
| "bedrock_ap-south-1:apac.anthropic.claude-sonnet-4-20250514-v1:0", | |
| "test" | |
| ], | |
| "title": "DefaultLLMRef", | |
| "description": "Names of default LLMs hardcoded into alation AI.\n\nThe syntax is <provider_name>:<model_name>, which matches Pydantic AI's syntax.\n\nref: https://ai.pydantic.dev/api/models/base/#pydantic_ai.models.KnownModelName" | |
| }, | |
| "DefaultQueryFlowAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| }, | |
| "marketplace_id": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Marketplace Id", | |
| "description": "The ID of the marketplace to use for data product search." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "marketplace_id" | |
| ], | |
| "title": "DefaultQueryFlowAgentPayload", | |
| "description": "The input schema for the default query flow agent." | |
| }, | |
| "DefaultReviseDataProductAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| }, | |
| "data_product_id": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Data Product Id", | |
| "description": "The ID of the data product to evaluate." | |
| }, | |
| "data_product_version": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Data Product Version", | |
| "description": "The version of the data product to evaluate. If None, uses the default version." | |
| } | |
| }, | |
| "additionalProperties": true, | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "data_product_id" | |
| ], | |
| "title": "DefaultReviseDataProductAgentPayload", | |
| "description": "The input schema for the auto improve data product by evalset agent.\n\nNote: The API also accepts an optional 'tool_approvals' field (not included in this schema)\nfor structured approval decisions from the UI. This field is extracted and handled\nseparately by the endpoint before schema validation. When sending approval decisions,\nthe UI should include a non-empty message field (e.g., a space character) to satisfy\nvalidation requirements. The message will be ignored when tool_approvals are present." | |
| }, | |
| "DefaultSQLQueryAgentPayload": { | |
| "properties": { | |
| "message": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Message", | |
| "description": "The message to send to the agent." | |
| }, | |
| "data_product_id": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Data Product Id", | |
| "description": "The ID of the data product to use." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "message", | |
| "data_product_id" | |
| ], | |
| "title": "DefaultSQLQueryAgentPayload", | |
| "description": "The input schema for the default SQL query agent." | |
| }, | |
| "DefaultToolRef": { | |
| "type": "string", | |
| "enum": [ | |
| "alation_context_tool", | |
| "get_context_by_id_tool", | |
| "bulk_retrieval_tool", | |
| "sql_execution_tool", | |
| "get_data_schema_tool", | |
| "generate_chart_from_sql_and_code_tool", | |
| "generate_chart_tool", | |
| "get_search_filter_fields_tool", | |
| "get_search_filter_values_tool", | |
| "search_catalog_tool", | |
| "bi_report_search_tool", | |
| "list_data_products_tool", | |
| "update_data_product_tool", | |
| "get_data_product_spec_tool", | |
| "get_data_sources_tool", | |
| "analyze_catalog_question_tool", | |
| "get_signature_creation_instructions_tool", | |
| "get_custom_fields_definitions_tool", | |
| "save_asset_tool", | |
| "retrieve_asset_tool", | |
| "list_assets_tool", | |
| "sql_evaluation_tool", | |
| "get_sql_eval_set_tool", | |
| "upload_sql_eval_set_tool", | |
| "get_sql_eval_case_tool", | |
| "update_sql_eval_case_tool", | |
| "delete_sql_eval_case_tool", | |
| "finalize_revise_data_product_tool", | |
| "get_catalog_object_tool", | |
| "update_catalog_object_tool", | |
| "get_users_tool", | |
| "get_groups_tool" | |
| ], | |
| "title": "DefaultToolRef", | |
| "description": "Names of default tools hardcoded into alation AI." | |
| }, | |
| "DefaultToolScorerRef": { | |
| "type": "string", | |
| "enum": [ | |
| "llm_judge_scorer", | |
| "sql_execution_scorer", | |
| "chart_generation_scorer" | |
| ], | |
| "title": "DefaultToolScorerRef", | |
| "description": "Names of default tool scorers hardcoded into alation AI." | |
| }, | |
| "DocumentUrl": { | |
| "properties": { | |
| "url": { | |
| "type": "string", | |
| "title": "Url", | |
| "description": "The URL of the document." | |
| }, | |
| "force_download": { | |
| "type": "boolean", | |
| "title": "Force Download", | |
| "default": false | |
| }, | |
| "vendor_metadata": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Vendor Metadata" | |
| }, | |
| "kind": { | |
| "type": "string", | |
| "const": "document-url", | |
| "title": "Kind", | |
| "description": "Type identifier, this is available on all parts as a discriminator.", | |
| "default": "document-url" | |
| }, | |
| "media_type": { | |
| "type": "string", | |
| "title": "Media Type", | |
| "description": "Return the media type of the file, based on the URL or the provided `media_type`.", | |
| "readOnly": true | |
| }, | |
| "identifier": { | |
| "type": "string", | |
| "title": "Identifier", | |
| "description": "The identifier of the file, such as a unique ID.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.", | |
| "readOnly": true | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "url", | |
| "media_type", | |
| "identifier" | |
| ], | |
| "title": "DocumentUrl" | |
| }, | |
| "ErrorDetails": { | |
| "properties": { | |
| "type": { | |
| "type": "string", | |
| "title": "Type", | |
| "description": "The type of error that occurred, this is an identifier designed for\nprogrammatic use that will change rarely or never.\n\n`type` is unique for each error message, and can hence be used as an identifier to build custom error messages." | |
| }, | |
| "loc": { | |
| "items": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "string" | |
| } | |
| ] | |
| }, | |
| "type": "array", | |
| "title": "Loc", | |
| "description": "Tuple of strings and ints identifying where in the schema the error occurred." | |
| }, | |
| "msg": { | |
| "type": "string", | |
| "title": "Msg", | |
| "description": "A human readable error message." | |
| }, | |
| "input": { | |
| "title": "Input", | |
| "description": "The input data at this `loc` that caused the error." | |
| }, | |
| "ctx": { | |
| "additionalProperties": true, | |
| "type": "object", | |
| "title": "Ctx", | |
| "description": "Values which are required to render the error message, and could hence be useful in rendering custom error messages.\nAlso useful for passing custom error data forward." | |
| }, | |
| "url": { | |
| "type": "string", | |
| "title": "Url", | |
| "description": "The documentation URL giving information about the error. No URL is available if\na [`PydanticCustomError`][pydantic_core.PydanticCustomError] is used." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "type", | |
| "loc", | |
| "msg", | |
| "input" | |
| ], | |
| "title": "ErrorDetails" | |
| }, | |
| "EvalToolCall": { | |
| "properties": { | |
| "tool_name": { | |
| "type": "string", | |
| "title": "Tool Name", | |
| "description": "The tool function name, as shown to the model." | |
| }, | |
| "args": { | |
| "additionalProperties": true, | |
| "type": "object", | |
| "title": "Args", | |
| "description": "The tool arguments as a JSON string, as generated by a model." | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "tool_name", | |
| "args" | |
| ], | |
| "title": "EvalToolCall", | |
| "description": "Schema for Eval Tool Call Entries." | |
| }, | |
| "EvaluationResult_Union_int__float__": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name" | |
| }, | |
| "value": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "number" | |
| } | |
| ], | |
| "title": "Value" | |
| }, | |
| "reason": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Reason" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/EvaluatorSpec" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "value", | |
| "reason", | |
| "source" | |
| ], | |
| "title": "EvaluationResult" | |
| }, | |
| "EvaluationResult_bool_": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name" | |
| }, | |
| "value": { | |
| "type": "boolean", | |
| "title": "Value" | |
| }, | |
| "reason": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Reason" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/EvaluatorSpec" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "value", | |
| "reason", | |
| "source" | |
| ], | |
| "title": "EvaluationResult" | |
| }, | |
| "EvaluationResult_str_": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name" | |
| }, | |
| "value": { | |
| "type": "string", | |
| "title": "Value" | |
| }, | |
| "reason": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Reason" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/EvaluatorSpec" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "value", | |
| "reason", | |
| "source" | |
| ], | |
| "title": "EvaluationResult" | |
| }, | |
| "EvaluationRunStatus": { | |
| "type": "string", | |
| "enum": [ | |
| "RUNNING", | |
| "CANCELLED", | |
| "ERROR", | |
| "COMPLETED" | |
| ], | |
| "title": "EvaluationRunStatus", | |
| "description": "Evaluation Status for an Evaluation Run." | |
| }, | |
| "EvaluatorFailure": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name" | |
| }, | |
| "error_message": { | |
| "type": "string", | |
| "title": "Error Message" | |
| }, | |
| "error_stacktrace": { | |
| "type": "string", | |
| "title": "Error Stacktrace" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/EvaluatorSpec" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "error_message", | |
| "error_stacktrace", | |
| "source" | |
| ], | |
| "title": "EvaluatorFailure" | |
| }, | |
| "EvaluatorSpec": {}, | |
| "ExtractMetricTask": { | |
| "properties": { | |
| "task_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Task Id", | |
| "description": "The ID of the extract metric task." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "task_id" | |
| ], | |
| "title": "ExtractMetricTask", | |
| "description": "Response schema for an extract metric task." | |
| }, | |
| "Feedback": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "Unique feedback ID." | |
| }, | |
| "data_product_id": { | |
| "type": "string", | |
| "title": "Data Product Id", | |
| "description": "The data product ID." | |
| }, | |
| "feedback": { | |
| "type": "string", | |
| "title": "Feedback", | |
| "description": "The feedback message." | |
| }, | |
| "message_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Message Id", | |
| "description": "Reference to the message." | |
| }, | |
| "chat_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Chat Id", | |
| "description": "The chat ID." | |
| }, | |
| "sentiment": { | |
| "$ref": "#/components/schemas/SentimentType", | |
| "description": "The feedback sentiment." | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Created At", | |
| "description": "When the feedback was created." | |
| }, | |
| "user_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "User Id", | |
| "description": "ID of the user who provided feedback." | |
| }, | |
| "tenant_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Tenant Id", | |
| "description": "Tenant ID." | |
| }, | |
| "tenant_user_id": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Tenant User Id", | |
| "description": "The tenant-specific user ID from IAM service (integer). May be None for legacy feedback." | |
| }, | |
| "user_details": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/UserDetails" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Additional user information from IAM service." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "data_product_id", | |
| "feedback", | |
| "message_id", | |
| "chat_id", | |
| "sentiment", | |
| "created_at", | |
| "user_id", | |
| "tenant_id", | |
| "tenant_user_id" | |
| ], | |
| "title": "Feedback", | |
| "description": "Schema for feedback response." | |
| }, | |
| "FeedbackCreate": { | |
| "properties": { | |
| "data_product_id": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Data Product Id", | |
| "description": "The data product ID associated with this feedback." | |
| }, | |
| "feedback": { | |
| "type": "string", | |
| "minLength": 1, | |
| "title": "Feedback", | |
| "description": "The actual feedback message from the user." | |
| }, | |
| "message_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Message Id", | |
| "description": "Reference to the MessageModel this feedback is for." | |
| }, | |
| "chat_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Chat Id", | |
| "description": "The chat ID that the message belongs to." | |
| }, | |
| "sentiment": { | |
| "$ref": "#/components/schemas/SentimentType", | |
| "description": "The sentiment of the feedback: positive or negative." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "data_product_id", | |
| "feedback", | |
| "message_id", | |
| "chat_id", | |
| "sentiment" | |
| ], | |
| "title": "FeedbackCreate", | |
| "description": "Schema for creating feedback." | |
| }, | |
| "FeedbackUpdate": { | |
| "properties": { | |
| "feedback": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "minLength": 1 | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Feedback", | |
| "description": "Updated feedback message." | |
| }, | |
| "sentiment": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/SentimentType" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Updated sentiment." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "sentiment" | |
| ], | |
| "title": "FeedbackUpdate", | |
| "description": "Schema for updating feedback (PATCH)." | |
| }, | |
| "FieldSemantics": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name", | |
| "description": "Column name from the data" | |
| }, | |
| "type": { | |
| "$ref": "#/components/schemas/FieldType", | |
| "description": "Vega-Lite data type" | |
| }, | |
| "cardinality": { | |
| "anyOf": [ | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Cardinality", | |
| "description": "Number of unique values (useful for color encoding)" | |
| }, | |
| "display_name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Display Name", | |
| "description": "Human-readable label for axis/legend" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "type" | |
| ], | |
| "title": "FieldSemantics", | |
| "description": "Semantic information about a single data field.\n\nDescribes what a field represents, not how to visualize it." | |
| }, | |
| "FieldType": { | |
| "type": "string", | |
| "enum": [ | |
| "temporal", | |
| "quantitative", | |
| "nominal", | |
| "ordinal" | |
| ], | |
| "title": "FieldType", | |
| "description": "Vega-Lite field types." | |
| }, | |
| "FilePart": { | |
| "properties": { | |
| "content": { | |
| "$ref": "#/components/schemas/BinaryContent", | |
| "description": "The file content of the response." | |
| }, | |
| "id": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Id", | |
| "description": "The identifier of the file part." | |
| }, | |
| "provider_name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Provider Name", | |
| "description": "The name of the provider that generated the response.\n " | |
| }, | |
| "provider_details": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Provider Details", | |
| "description": "Additional data returned by the provider that can't be mapped to standard fields.\n\nThis is used for data that is required to be sent back to APIs, as well as data users may want to access programmatically." | |
| }, | |
| "part_kind": { | |
| "type": "string", | |
| "const": "file", | |
| "title": "Part Kind", | |
| "description": "Part type identifier, this is available on all parts as a discriminator.", | |
| "default": "file" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "content" | |
| ], | |
| "title": "FilePart" | |
| }, | |
| "Filter": { | |
| "properties": { | |
| "filter_id": { | |
| "type": "integer", | |
| "title": "Filter Id" | |
| }, | |
| "filter_values": { | |
| "items": { | |
| "type": "string" | |
| }, | |
| "type": "array", | |
| "title": "Filter Values" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "filter_id", | |
| "filter_values" | |
| ], | |
| "title": "Filter", | |
| "description": "Filter model for search queries." | |
| }, | |
| "GenericEvalExpectedOutput": { | |
| "properties": { | |
| "eval_text": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Eval Text", | |
| "description": "A text-based answer for the case, evaluated by an LLM Judge" | |
| }, | |
| "eval_tool_calls": { | |
| "anyOf": [ | |
| { | |
| "items": { | |
| "$ref": "#/components/schemas/EvalToolCall" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Eval Tool Calls", | |
| "description": "The tool calls the case should make, evaluated by" | |
| } | |
| }, | |
| "type": "object", | |
| "title": "GenericEvalExpectedOutput", | |
| "description": "Expected Output for a Generic Eval Case.\n\nAt least one of eval_text and eval_tool_calls should be provided to score a case.\nIf both are provided, or multiple tool calls are provided, then the overall case's\nscore is an average acrossof the scores for eval_text and each eval_tool_call.\n\nEval Tool Calls compare the output of generated tool calls to expected tool calls.\nThe outputs are compared by tool-specific scorers, which is useful for measuring e.g.\nSQL execution accuracy." | |
| }, | |
| "GenericEvaluationCase": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the Generic Evaluation Case." | |
| }, | |
| "eval_set_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Eval Set Id", | |
| "description": "The Evaluation Set this Evaluation Case belongs to." | |
| }, | |
| "inputs": { | |
| "$ref": "#/components/schemas/JsonValue-Output", | |
| "description": "The inputs for the Generic Evaluation Case as JSON." | |
| }, | |
| "expected_output": { | |
| "$ref": "#/components/schemas/JsonValue-Output", | |
| "description": "The expected outputs for the Generic Evaluation Case as JSON." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "eval_set_id", | |
| "inputs", | |
| "expected_output" | |
| ], | |
| "title": "GenericEvaluationCase", | |
| "description": "Generic Evaluation Case Schema." | |
| }, | |
| "GenericEvaluationCaseCreate": { | |
| "properties": { | |
| "inputs": { | |
| "$ref": "#/components/schemas/JsonValue-Input", | |
| "description": "The inputs for the Generic Evaluation Case as JSON." | |
| }, | |
| "expected_output": { | |
| "$ref": "#/components/schemas/JsonValue-Input", | |
| "description": "The expected output for the Generic Evaluation Case as JSON." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "inputs", | |
| "expected_output" | |
| ], | |
| "title": "GenericEvaluationCaseCreate", | |
| "description": "Generic Evaluation Case Create Schema." | |
| }, | |
| "GenericEvaluationCaseUpdate": { | |
| "properties": { | |
| "inputs": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/JsonValue-Input" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The new inputs for the Generic Evaluation Case. None means no update." | |
| }, | |
| "expected_output": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/JsonValue-Input" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "New expected output for the Generic Evaluation Case. None means no update." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "title": "GenericEvaluationCaseUpdate", | |
| "description": "Generic Evaluation Case Update Schema." | |
| }, | |
| "GenericEvaluationReport": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name" | |
| }, | |
| "cases": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReportCase_TypeVar_TypeVar_TypeVar_" | |
| }, | |
| "type": "array", | |
| "title": "Cases" | |
| }, | |
| "failures": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReportCaseFailure_TypeVar_TypeVar_TypeVar_" | |
| }, | |
| "type": "array", | |
| "title": "Failures" | |
| }, | |
| "experiment_metadata": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Experiment Metadata" | |
| }, | |
| "trace_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Trace Id" | |
| }, | |
| "span_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Span Id" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "cases" | |
| ], | |
| "title": "GenericEvaluationReport", | |
| "description": "Generic Evaluation Report Schema." | |
| }, | |
| "GenericEvaluationResult": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the Result." | |
| }, | |
| "eval_set_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Eval Set Id", | |
| "description": "The Evaluation Set ID this Result applies to." | |
| }, | |
| "eval_set_name": { | |
| "type": "string", | |
| "title": "Eval Set Name", | |
| "description": "The Evaluation Set name this Result applies to." | |
| }, | |
| "eval_set_hash": { | |
| "type": "string", | |
| "title": "Eval Set Hash", | |
| "description": "The hash of the Evaluation Set at the time of evaluation." | |
| }, | |
| "agent_config_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Agent Config Id", | |
| "description": "The ID of the Agent Config used to generate the Result." | |
| }, | |
| "agent_config_hash": { | |
| "type": "string", | |
| "title": "Agent Config Hash", | |
| "description": "The hash of the Agent Config at the time of evaluation." | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Created At", | |
| "description": "When the Result was created." | |
| }, | |
| "num_cases": { | |
| "type": "integer", | |
| "title": "Num Cases", | |
| "description": "The number of eval cases in the Result." | |
| }, | |
| "run_status": { | |
| "$ref": "#/components/schemas/EvaluationRunStatus", | |
| "description": "The evaluation run status." | |
| }, | |
| "llm_name": { | |
| "type": "string", | |
| "title": "Llm Name", | |
| "description": "The name of the LLM used to generate the Result." | |
| }, | |
| "eval_score": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/GenericEvaluationScore" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The overall score of the Result, if the run completed successfully." | |
| }, | |
| "evaluation_report": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/GenericEvaluationReport" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The evaluated Generic Result formatted as a Pydantic Eval Report, if the run completed successfully." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "eval_set_id", | |
| "eval_set_name", | |
| "eval_set_hash", | |
| "agent_config_id", | |
| "agent_config_hash", | |
| "created_at", | |
| "num_cases", | |
| "run_status", | |
| "llm_name" | |
| ], | |
| "title": "GenericEvaluationResult", | |
| "description": "Generic Evaluation Result Schema." | |
| }, | |
| "GenericEvaluationResultMetadata": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the Result." | |
| }, | |
| "eval_set_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Eval Set Id", | |
| "description": "The Evaluation Set ID this Result applies to." | |
| }, | |
| "eval_set_name": { | |
| "type": "string", | |
| "title": "Eval Set Name", | |
| "description": "The Evaluation Set name this Result applies to." | |
| }, | |
| "eval_set_hash": { | |
| "type": "string", | |
| "title": "Eval Set Hash", | |
| "description": "The hash of the Evaluation Set at the time of evaluation." | |
| }, | |
| "agent_config_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Agent Config Id", | |
| "description": "The ID of the Agent Config used to generate the Result." | |
| }, | |
| "agent_config_hash": { | |
| "type": "string", | |
| "title": "Agent Config Hash", | |
| "description": "The hash of the Agent Config at the time of evaluation." | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Created At", | |
| "description": "When the Result was created." | |
| }, | |
| "num_cases": { | |
| "type": "integer", | |
| "title": "Num Cases", | |
| "description": "The number of eval cases in the Result." | |
| }, | |
| "run_status": { | |
| "$ref": "#/components/schemas/EvaluationRunStatus", | |
| "description": "The evaluation run status." | |
| }, | |
| "llm_name": { | |
| "type": "string", | |
| "title": "Llm Name", | |
| "description": "The name of the LLM used to generate the Result." | |
| }, | |
| "eval_score": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/GenericEvaluationScore" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "The overall score of the Result, if the run completed successfully." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "eval_set_id", | |
| "eval_set_name", | |
| "eval_set_hash", | |
| "agent_config_id", | |
| "agent_config_hash", | |
| "created_at", | |
| "num_cases", | |
| "run_status", | |
| "llm_name" | |
| ], | |
| "title": "GenericEvaluationResultMetadata", | |
| "description": "Generic Evaluation Result Schema." | |
| }, | |
| "GenericEvaluationScore": { | |
| "properties": { | |
| "scores": { | |
| "additionalProperties": { | |
| "type": "number" | |
| }, | |
| "type": "object", | |
| "title": "Scores", | |
| "description": "The scores by metric name." | |
| }, | |
| "avg_case_duration_s": { | |
| "type": "number", | |
| "title": "Avg Case Duration S", | |
| "description": "The average duration per case, in seconds, to complete evaluation.", | |
| "default": 0.0 | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "scores" | |
| ], | |
| "title": "GenericEvaluationScore", | |
| "description": "Generic Evaluation Score Schema." | |
| }, | |
| "GenericEvaluationSet": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the Generic Evaluation Set." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "title": "Name", | |
| "description": "The name of the Generic Evaluation Set." | |
| }, | |
| "description": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Description", | |
| "description": "Description of the evaluation set." | |
| }, | |
| "agent_config_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Agent Config Id", | |
| "description": "The ID of the agent config used to generate results." | |
| }, | |
| "rubric": { | |
| "type": "string", | |
| "title": "Rubric", | |
| "description": "The rubric for evaluating generated to expected outputs." | |
| }, | |
| "cases": { | |
| "items": { | |
| "$ref": "#/components/schemas/GenericEvaluationCase" | |
| }, | |
| "type": "array", | |
| "title": "Cases", | |
| "description": "The list of `GenericEvaluationCase` objects." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "agent_config_id", | |
| "rubric", | |
| "cases" | |
| ], | |
| "title": "GenericEvaluationSet", | |
| "description": "Generic Evaluation Set Schema." | |
| }, | |
| "GenericEvaluationSetCreate": { | |
| "properties": { | |
| "name": { | |
| "type": "string", | |
| "title": "Name", | |
| "description": "The name of the Generic Evaluation Set." | |
| }, | |
| "description": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Description", | |
| "description": "Description of the evaluation set." | |
| }, | |
| "agent_config_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Agent Config Id", | |
| "description": "The ID of the Agent Config this evaluation set applies to." | |
| }, | |
| "rubric": { | |
| "type": "string", | |
| "title": "Rubric", | |
| "description": "The rubric to use for judging outputs for a task.", | |
| "default": "Your task is to decide if a submitted answer is correct. Follow these rules strictly:\n1. If an expected output is provided:\n - The answer must include all exact values (numbers, strings, keywords) from the expected output.\n - Small differences in formatting, phrasing, or case are acceptable if the meaning is unchanged.\n - If values are missing, altered, or incorrect, the score is 0.\n - Otherwise, the score is 1.\n2. If no expected output is provided:\n - Score 1 if the answer completely and correctly fulfills the input question/task.\n - Score 0 if it is incomplete, incorrect, or irrelevant.\nReturn only a single score: 1 (correct) or 0 (incorrect).\n" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "name", | |
| "agent_config_id" | |
| ], | |
| "title": "GenericEvaluationSetCreate", | |
| "description": "Generic Evaluation Set Create Schema." | |
| }, | |
| "GenericEvaluationSetUpdate": { | |
| "properties": { | |
| "name": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Name", | |
| "description": "The new name. None means no update." | |
| }, | |
| "description": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Description", | |
| "description": "The new description. None means no update." | |
| }, | |
| "rubric": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Rubric", | |
| "description": "The new rubric. None means no update." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "title": "GenericEvaluationSetUpdate", | |
| "description": "Generic Evaluation Set Update Schema." | |
| }, | |
| "HTTPValidationError": { | |
| "properties": { | |
| "detail": { | |
| "items": { | |
| "$ref": "#/components/schemas/ValidationError" | |
| }, | |
| "type": "array", | |
| "title": "Detail" | |
| } | |
| }, | |
| "type": "object", | |
| "title": "HTTPValidationError" | |
| }, | |
| "ImageUrl": { | |
| "properties": { | |
| "url": { | |
| "type": "string", | |
| "title": "Url", | |
| "description": "The URL of the image." | |
| }, | |
| "force_download": { | |
| "type": "boolean", | |
| "title": "Force Download", | |
| "default": false | |
| }, | |
| "vendor_metadata": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Vendor Metadata" | |
| }, | |
| "kind": { | |
| "type": "string", | |
| "const": "image-url", | |
| "title": "Kind", | |
| "description": "Type identifier, this is available on all parts as a discriminator.", | |
| "default": "image-url" | |
| }, | |
| "media_type": { | |
| "type": "string", | |
| "title": "Media Type", | |
| "description": "Return the media type of the file, based on the URL or the provided `media_type`.", | |
| "readOnly": true | |
| }, | |
| "identifier": { | |
| "type": "string", | |
| "title": "Identifier", | |
| "description": "The identifier of the file, such as a unique ID.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.", | |
| "readOnly": true | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "url", | |
| "media_type", | |
| "identifier" | |
| ], | |
| "title": "ImageUrl" | |
| }, | |
| "InterpolationType": { | |
| "type": "string", | |
| "enum": [ | |
| "linear", | |
| "monotone", | |
| "step", | |
| "step-before", | |
| "step-after", | |
| "basis", | |
| "cardinal" | |
| ], | |
| "title": "InterpolationType", | |
| "description": "Line interpolation types." | |
| }, | |
| "JsonValue-Input": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "number" | |
| }, | |
| { | |
| "type": "boolean" | |
| }, | |
| { | |
| "items": { | |
| "$ref": "#/components/schemas/JsonValue-Input" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/JsonValue-Input" | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "JsonValue-Output": { | |
| "anyOf": [ | |
| { | |
| "type": "string" | |
| }, | |
| { | |
| "type": "integer" | |
| }, | |
| { | |
| "type": "number" | |
| }, | |
| { | |
| "type": "boolean" | |
| }, | |
| { | |
| "items": { | |
| "$ref": "#/components/schemas/JsonValue-Output" | |
| }, | |
| "type": "array" | |
| }, | |
| { | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/JsonValue-Output" | |
| }, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ] | |
| }, | |
| "LLMConfig": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the LLM config." | |
| }, | |
| "name": { | |
| "type": "string", | |
| "title": "Name", | |
| "description": "User-defined display name for the LLM (e.g., \"My Custom GPT-5\")." | |
| }, | |
| "is_default": { | |
| "type": "boolean", | |
| "title": "Is Default", | |
| "description": "Whether this is a system default configuration.\n\nDefault configs are read-only. Users can clone them to create custom configurations." | |
| }, | |
| "user_id": { | |
| "anyOf": [ | |
| { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "User Id", | |
| "description": "ID of the user who created this configuration (null for system defaults)." | |
| }, | |
| "provider": { | |
| "$ref": "#/components/schemas/LLMProvider", | |
| "description": "The LLM provider hosting this model (e.g. OPENAI, BEDROCK)." | |
| }, | |
| "default_ref": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/DefaultLLMRef" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "description": "Reference to the predefined model (e.g., DefaultLLMRef.OPENAI_GPT_5).\n\nOnly set for default configs." | |
| }, | |
| "config_schema": { | |
| "anyOf": [ | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| { | |
| "type": "null" | |
| } | |
| ], | |
| "title": "Config Schema", | |
| "description": "The extra config jsonschema for the LLM." | |
| }, | |
| "visibility_label": { | |
| "$ref": "#/components/schemas/VisibilityLabel", | |
| "description": "Visibility label indicating the prominence of this config." | |
| }, | |
| "updated_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Updated At", | |
| "description": "Timestamp when this configuration was last modified." | |
| }, | |
| "created_at": { | |
| "type": "string", | |
| "format": "date-time", | |
| "title": "Created At", | |
| "description": "Timestamp when this configuration was created." | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "type": "object", | |
| "required": [ | |
| "id", | |
| "name", | |
| "is_default", | |
| "user_id", | |
| "provider", | |
| "default_ref", | |
| "visibility_label", | |
| "updated_at", | |
| "created_at" | |
| ], | |
| "title": "LLMConfig", | |
| "description": "LLM configuration response schema.\n\nUsed to connect to an LLM that can be used by agents." | |
| }, | |
| "LLMProvider": { | |
| "type": "string", | |
| "enum": [ | |
| "openai", | |
| "anthropic", | |
| "bedrock_us-west-2", | |
| "bedrock_us-west-1", | |
| "bedrock_us-east-1", | |
| "bedrock_us-east-2", | |
| "bedrock_eu-west-1", | |
| "bedrock_eu-central-1", | |
| "bedrock_ca-central-1", | |
| "bedrock_ap-southeast-1", | |
| "bedrock_ap-southeast-2", | |
| "bedrock_ap-northeast-1", | |
| "bedrock_ap-south-1" | |
| ], | |
| "title": "LLMProvider", | |
| "description": "Provider of the model." | |
| }, | |
| "LayerSpec": { | |
| "properties": { | |
| "mark": { | |
| "anyOf": [ | |
| { | |
| "$ref": "#/components/schemas/MarkType" | |
| }, | |
| { | |
| "additionalProperties": true, | |
| "type": "object" | |
| } | |
| ], | |
| "title": "Mark", | |
| "description": "Mark type or config" | |
| }, | |
| "encoding": { | |
| "additionalProperties": true, | |
| "type": "object", | |
| "title": "Encoding", | |
| "description": "Encoding for this layer" | |
| }, | |
| "transform": { | |
| "items": { | |
| "additionalProperties": true, | |
| "type": "object" | |
| }, | |
| "type": "array", | |
| "title": "Transform", | |
| "description": "Transforms for this layer" | |
| } | |
| }, | |
| "type": "object", | |
| "required": [ | |
| "mark" | |
| ], | |
| "title": "LayerSpec", | |
| "description": "Specification for an additional chart layer (annotations, reference lines)." | |
| }, | |
| "LegendPosition": { | |
| "type": "string", | |
| "enum": [ | |
| "right", | |
| "left", | |
| "top", | |
| "bottom", | |
| "none" | |
| ], | |
| "title": "LegendPosition", | |
| "description": "Legend position options." | |
| }, | |
| "MarkType": { | |
| "type": "string", | |
| "enum": [ | |
| "bar", | |
| "line", | |
| "point", | |
| "area", | |
| "rect", | |
| "arc", | |
| "rule", | |
| "text", | |
| "circle", | |
| "square", | |
| "boxplot" | |
| ], | |
| "title": "MarkType", | |
| "description": "Vega-Lite mark types." | |
| }, | |
| "Message": { | |
| "properties": { | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Id", | |
| "description": "The ID of the message." | |
| }, | |
| "chat_id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "title": "Chat Id", | |
| "description": "The ID of the chat this message belongs to." | |
| }, | |
| "model_message": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/ModelRequest" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/ModelResponse" | |
| } | |
| ], | |
| "title": "Model Message", | |
| "description": "The pydantic-ai ModelMessage containing message content and metadata.", | |
| "discriminator": { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment