Defaults to applicat{"openapi":"3.1.0","paths":{"/v1/agents":{"get":{"tags":["Agents"],"summary":"Get Agents","description":"Get agents with global search or specific filters.\nIf search is provided, it takes priority over filters.","operationId":"get_agents","parameters":[{"name":"only_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Only Archived"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"dataset_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":25,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Agent_Customized"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Agents"],"summary":"Create Agent","description":"Create a new agent.","operationId":"create_agent","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/bulk-action":{"post":{"tags":["Agents"],"summary":"Agent Bulk Action","description":"Perform a bulk action on a list of agents.","operationId":"agent_bulk_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentBulkActionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/credential-schema":{"post":{"tags":["Agents"],"summary":"Get Credential Schema","description":"Get the credential schema for a flowise agent.","operationId":"get_credential_schema","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowiseGetCredentialSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowiseCredentialUserInput"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/model-status":{"get":{"tags":["Agents"],"summary":"Get Model Status","operationId":"get_model_status","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelStatus"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}},"deprecated":true}},"/v1/agents/models":{"get":{"tags":["Agents"],"summary":"Get Provider Config","operationId":"get_llm_models","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProviderConfig"},"type":"array","title":"Response Get Llm Models"}}}}}}},"/v1/agents/tags/{tag}":{"get":{"tags":["Agents"],"summary":"Get Tagged Agents","description":"Get all ids tagged by *all* tags.","operationId":"get_tagged_agents","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Tag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"title":"Response Get Tagged Agents"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/agents/test-model-connection":{"post":{"tags":["Agents"],"summary":"Test Model Connection","operationId":"test_model_connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelLLM"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/test-tool-connection":{"post":{"tags":["Agents"],"summary":"Test Tool Connection","description":"Test a tool connection.\n\nParameters:\n\nFor `ToolConfigPostgres`:\n- **type**: Literal type indication for Postgres tool (`Postgres`).\n- **connection_string**: Connection string for the Postgres database.\n\nFor `ToolConfigMySQL`:\n- **type**: Literal type indication for MySQL tool (`MySQL`).\n- **connection_string**: Connection string for the MySQL database.\n\nFor `ToolConfigMSSQL`:\n- **type**: Literal type indication for MSSQL tool (`MSSQL`).\n- **connection_string**: Connection string for the MSSQL database.\n\nFor `ToolConfigOracle`:\n- **type**: Literal type indication for Oracle tool (`Oracle`).\n- **connection_string**: Connection string for the Oracle database.\n\nFor `ToolConfigBigQuery`:\n- **type**: Literal type indication for BigQuery tool (`BigQuery`).\n- **project_id**: Project ID for BigQuery.\n- **dataset_id**: Dataset ID for BigQuery.\n- **service_account**: Service account information as a dictionary with keys and values as strings.\n\nFor `ToolConfigPGVector`:\n- **type**: Literal type indication for PG Vector tool (`PGVector`).\n- **connection_string**: Connection string for the PG Vector database.\n- **table_name**: Name of the table in the PG Vector database.\n- **embedding_model**: Configuration of the embedding model to be used.\n - **provider**: Provider of the embedding model (`VertexAIModelGarden`).\n - **project_id**: Project ID for Vertex AI.\n - **endpoint_id**: Endpoint ID for the model.\n - **location**: Location of the Vertex AI endpoint.\n - **service_account**: Service account information as a dictionary with keys and values as strings.","operationId":"test_tool_connection","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ToolConfigPGVector"},{"$ref":"#/components/schemas/ToolConfigPineconeVectorDB"},{"$ref":"#/components/schemas/ToolConfigSQLDatabasePostgres"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMySQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMSSQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseOracle"},{"$ref":"#/components/schemas/ToolConfigBigQuery"},{"$ref":"#/components/schemas/ToolConfigOpenAPI"},{"$ref":"#/components/schemas/ToolConfigMCP-Input"},{"$ref":"#/components/schemas/ToolConfigKnowledge"}],"title":"Payload","discriminator":{"propertyName":"type","mapping":{"PGVector":"#/components/schemas/ToolConfigPGVector","Pinecone":"#/components/schemas/ToolConfigPineconeVectorDB","PostgreSQL":"#/components/schemas/ToolConfigSQLDatabasePostgres","MySQL":"#/components/schemas/ToolConfigSQLDatabaseMySQL","MSSQL":"#/components/schemas/ToolConfigSQLDatabaseMSSQL","Oracle":"#/components/schemas/ToolConfigSQLDatabaseOracle","BigQuery":"#/components/schemas/ToolConfigBigQuery","OpenAPI":"#/components/schemas/ToolConfigOpenAPI","MCP":"#/components/schemas/ToolConfigMCP-Input","Knowledge":"#/components/schemas/ToolConfigKnowledge"}}}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/verify-dataset-schema/{dataset_id}":{"post":{"tags":["Agents"],"summary":"Verify Dataset Schema","operationId":"verify_agent_dataset_schema","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Verify Dataset Schema"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}":{"get":{"tags":["Agents"],"summary":"Get Agent By Id","description":"Get an agent by id.","operationId":"get_agent_by_id","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Agents"],"summary":"Patch Agent","operationId":"patch_agent","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentPatchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Agents"],"summary":"Delete Agent","description":"Delete an agent.","operationId":"delete_agent","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/activate":{"post":{"tags":["Agents"],"summary":"Activate Agent","operationId":"activate_agent","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/archive":{"post":{"tags":["Agents"],"summary":"Archive Agent","operationId":"archive_agent","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/create-dataset":{"post":{"tags":["Agents"],"summary":"Create Agent Dataset","description":"Create a new dataset for agent.","operationId":"create_agent_dataset","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetPayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Agent Dataset"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/deactivate":{"post":{"tags":["Agents"],"summary":"Deactivate Agent","operationId":"deactivate_agent","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/regenerate":{"post":{"tags":["Agents"],"summary":"Regenerate Api Token","operationId":"regenerate_api_token","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/tags":{"post":{"tags":["Agents"],"summary":"Add Agent Tags","description":"Add tags to agent.","operationId":"add_agent_tags","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"title":"Tag List"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Agents"],"summary":"Delete Agent Tags","description":"Delete tags from agent.","operationId":"delete_agent_tags","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"description":"List of tag UUIDs to delete","title":"Ids"},"description":"List of tag UUIDs to delete"}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/unarchive":{"post":{"tags":["Agents"],"summary":"Unarchive Agent","operationId":"unarchive_agent","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/unpublish":{"post":{"tags":["Agents"],"summary":"Deactivate Agent","operationId":"deactivate_agent_v1_agents__agent_id__unpublish_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/versions":{"post":{"tags":["Agents"],"summary":"Create Version","description":"Create a new version.","operationId":"create_version","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Agents"],"summary":"Get Agent Versions","description":"Get versions of the specified agent.","operationId":"get_agent_versions","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Version"},"title":"Response Get Agent Versions"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/agents/{agent_id}/versions/{version_id}":{"patch":{"tags":["Agents"],"summary":"Patch Version","description":"Patch a version.","operationId":"patch_version","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}},{"name":"version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Version Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionPatchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Agents"],"summary":"Get Agent Version","description":"Get specified version of specified agent.","operationId":"get_agent_version","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Agent Id"}},{"name":"version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Version Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/app-worker/{id}/v1/ask":{"post":{"tags":["Agents"],"summary":"Ask","operationId":"ask_ask_post","parameters":[{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Application worker ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AskRequestPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AskResponsePayload"}}}},"400":{"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}},"security":[]}},"/v1/app-worker/{id}/v1/ask/stream":{"post":{"tags":["Agents"],"summary":"Ask Stream","description":"Stream AI response for the given input.\n\nThis endpoint accepts a conversational input and streams the AI-generated\nresponse in chunks as they become available.","operationId":"ask_stream_ask_stream_post","parameters":[{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Application worker ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AskRequestPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamedResponse"}},"text/event-stream":{}}},"400":{"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}},"security":[]}},"/v1/app-worker/{id}/v1/feedback":{"post":{"tags":["Agents"],"summary":"Feedback","description":"Publish feedback to events\n\nParameters:\n- **answer_id**: A UUID representing the message id of the answer\n- **question**: A string representing the question that was asked by the user\n- **answer**: A string representing the answer that was given by the AI\n- **is_positive**: A boolean representing the feedback is positive or negative\n- **negative_feedback_category_harmful**: A boolean representing the feedback category harmful\n- **negative_feedback_category_untrue**: A boolean representing the feedback category untrue\n- **negative_feedback_category_unhelpful**: A boolean representing the feedback category unhelpful\n- **negative_feedback_category_other**: A boolean representing the feedback category other\n- **feedback_description**: A string representing the feedback description","operationId":"feedback_feedback_post","parameters":[{"name":"x-api-token","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Token"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Application worker ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventFeedbackData"}}}},"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}},"security":[]}},"/v1/application-playground/ask":{"post":{"tags":["Agents"],"summary":"Ask Playground","description":"Proxy ask request to the playground service.","operationId":"ask_playground_v1_application_playground_ask_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaygroundAskProxyRequestPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AskResponsePayload"}}}},"400":{"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/application-playground/ask/stream":{"post":{"tags":["Agents"],"summary":"Ask Stream Playground","description":"Proxy streaming ask request to the playground service.","operationId":"ask_stream_playground_v1_application_playground_ask_stream_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaygroundAskProxyRequestPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamedResponse"}},"text/event-stream":{}}},"400":{"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/dashboard-items":{"post":{"tags":["Dashboard-items"],"summary":"Create Dashboard Item","description":"Creates a new dashboard item while assigning it to a dashboard\n:return: DashboardItem","operationId":"create_dashboard_item","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItemCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItem"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Dashboard-items"],"summary":"Get Dashboards Items","description":"Get all dashboard items of tenant, excepts multiple filters\n:return: List[DashboardITem]","operationId":"get_dashboards_items","parameters":[{"name":"dashboard_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Dashboard Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DashboardItem_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/dashboard-items/{dashboard_item_id}":{"get":{"tags":["Dashboard-items"],"summary":"Get Dashboard","description":"returns a specific dashboard item according to id\n:return: DashboardItem","operationId":"get_dashboard_item","parameters":[{"name":"dashboard_item_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItem"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Dashboard-items"],"summary":"Delete dashboard item by ID","operationId":"delete_dashboard_item","parameters":[{"name":"dashboard_item_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Item Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Dashboard-items"],"summary":"Update dashboard item by ID","operationId":"update_dashboard_item","parameters":[{"name":"dashboard_item_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Item Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItemUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardItem"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards":{"post":{"tags":["Dashboards"],"summary":"Create Dashboard","operationId":"create_dashboard","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Dashboards"],"summary":"Get Dashboards","operationId":"get_dashboards","parameters":[{"name":"only_archived","in":"query","required":false,"schema":{"type":"boolean","description":"Only return archived dashboards","default":false,"title":"Only Archived"},"description":"Only return archived dashboards"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Dashboard_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/bulk-action":{"post":{"tags":["Dashboards"],"summary":"Dashboard Bulk Action","description":"Perform a bulk action on a list of dashboards.","operationId":"dashboard_bulk_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardBulkActionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/search":{"post":{"tags":["Dashboards"],"summary":"Search Dashboards","operationId":"search_dashboards","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardSearchParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Dashboard_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/tags/{tag}":{"get":{"tags":["Dashboards"],"summary":"Get Tagged Dashboards","description":"Get all ids tagged by *all* tags.","operationId":"get_tagged_dashboards","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Tag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Get Tagged Dashboards"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/{dashboard_id}":{"get":{"tags":["Dashboards"],"summary":"Get Dashboard","operationId":"get_dashboard","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Dashboards"],"summary":"Delete dashboard by ID","operationId":"delete_dashboard","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Dashboards"],"summary":"Update dashboard by ID","operationId":"update_dashboard","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/{dashboard_id}/archive":{"post":{"tags":["Dashboards"],"summary":"Archive Dashboard","description":"Add tags to dashboard.","operationId":"archive_dashboard","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/{dashboard_id}/tags":{"post":{"tags":["Dashboards"],"summary":"Add Dashboard Tags","description":"Add tags to dashboard.","operationId":"add_dashboard_tags","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Tag List"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Dashboards"],"summary":"Delete Dashboard Tags","description":"Delete tags from dashboard.","operationId":"delete_dashboard_tags","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of tag UUIDs to delete","title":"Ids"},"description":"List of tag UUIDs to delete"}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/dashboards/{dashboard_id}/unarchive":{"post":{"tags":["Dashboards"],"summary":"Unarchive Dashboard","description":"Add tags to dashboard.","operationId":"unarchive_dashboard","parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dashboard Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/dataset-models":{"get":{"tags":["Dataset-model"],"summary":"Get All Dataset Model Info","description":"Get all Dataset-Model connections and details\n- **size**: Number of items per page (use it to get more items than 25 -> all items)\n- **page**: Page number","operationId":"get_all_dataset_model_info","parameters":[{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ModelFullResponse_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset-models/{dataset_id}/{model_id}":{"post":{"tags":["Dataset-model"],"summary":"Connect Dataset Model","description":"Connect a Dataset to a Model\n\n- **dataset_id** (str): Required. The dataset id.\n- **model_id** (str): Required. The model id.","operationId":"connect_dataset_model","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset-model"],"summary":"Disconnect Dataset Model","description":"Disconnect a Dataset from a Model\n\n- **dataset_id** (str): Required. The dataset id.\n- **model_id** (str): Required. The model id.","operationId":"disconnect_dataset_model","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset-sources":{"post":{"tags":["Dataset-sources"],"summary":"Create Dataset Source","description":"Create a new DatasetSource.\n\n- **dataset_id** (str): Required, ID of the dataset. The dataset must already exist.\n- **source_id** (UUID): Required, Unique Identifier(UUID) of the source data. The source must already exist.\n- **folder** (str or None): Optional, Path within the bucket to ingest data from..\n- **query** (str or None): Optional, Query statement to retrieve data.\n- **created_at** (datetime or None): Optional, Timestamp when the data source was created.\n- **updated_at** (datetime or None): Optional, Timestamp when the data source was last updated.\n- **ingest_type** (IngestType): Optional, Type of data ingestion. Default is IngestType.INSERT.","operationId":"create_dataset_source","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSourceCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSourceResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Dataset-sources"],"summary":"Get Dataset Sources","description":"Retrieve all Dataset Sources based on the provided filters.\n\n- **source_id**: ID of the source\n- **folder**: Path within the bucket to ingest data from\n- **id**: ID of the dataset source\n- **dataset_id**: ID of the dataset\n- **created_by**: Creator of the dataset source\n- **ingest_type**: Type of ingestion","operationId":"get_dataset_sources","parameters":[{"name":"source_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"}},{"name":"folder","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"dataset_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"ingest_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IngestType"},{"type":"null"}],"title":"Ingest Type"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DatasetSourceResponseWithSource_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/dataset-sources/{dataset_source_id}":{"get":{"tags":["Dataset-sources"],"summary":"Get Dataset Source","description":"Retrieve a Dataset Source based on the dataset_source_id.\n\n- **dataset_source_id**: ID of the dataset source","operationId":"get_dataset_source","parameters":[{"name":"dataset_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSourceResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Dataset-sources"],"summary":"Delete Dataset Source","description":"Delete a specific DatasetSource.\n\n- **dataset_source_id**: ID of the dataset source","operationId":"delete_dataset_source","parameters":[{"name":"dataset_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Source Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Dataset-sources"],"summary":"Update Dataset Source","description":"Update an existing DatasetSource.\n\n- **id** (str): Optional, ID of the dataset source.\n- **dataset_id** (str): Optional, ID of the dataset. The dataset must already exist.\n- **source_id** (UUID): Optional, Unique Identifier(UUID) of the source data. The source must already exist.\n- **folder** (str or None): Optional, Path within the bucket to ingest data from.\n- **query** (str or None): Optional, Query statement to retrieve data.\n- **ingest_type** (IngestType): Optional, Type of data ingestion. Default is IngestType.INSERT.","operationId":"update_dataset_source","parameters":[{"name":"dataset_source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Source Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSourceUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSourceResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/datasets":{"post":{"tags":["Dataset"],"summary":"Create Dataset","description":"Create a new Dataset\n\n- **payload** (DatasetCreate): Required. The payload that includes:\n - **name** (str): Name of the dataset, min_length=1, max_length=100.\n - **description** (str or None): A description about the dataset.\n - **model_version_id** (str or None): Model version identifier.\n - **tags** (list of DatasetTag or None): A list of tags related to the dataset.\n - **schema** (Schema): The schema of the dataset.","operationId":"create_dataset","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Dataset"],"summary":"Get Datasets","description":"Retrieve all Datasets based on search query OR provided filters\n\n- **search** (str or None): Optional, Global search query to filter datasets across multiple fields (id, name, created_at, updated_at). If provided, specific filters are ignored.\n- **name** (str or None): Optional, Name of the dataset based on which records to be fetched.\n- **description** (str or None): Optional, Description of the dataset based on which records to be fetched.\n- **id** (str or None): Optional, Unique identifier of the dataset based on which records to be fetched.\n- **model_version_id** (str or None): Optional, Model version identifier based on which datasets to be fetched.\n- **created_by** (str or None): Optional, Identifier of the user who created the datasets based on which datasets to be fetched.","operationId":"get_datasets","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"model_version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version Id"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DatasetResponse_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/bulk-action":{"post":{"tags":["Dataset"],"summary":"Dataset Bulk Action","description":"Perform a bulk action on a list of datasets.","operationId":"dataset_bulk_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetBulkActionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/datasets/get-media":{"post":{"tags":["Dataset"],"summary":"Get Media","description":"Retrieve a single image from GCS by dataset_id + image_id.","operationId":"get_media","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMediaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}},"image/*":{}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/log-batch":{"post":{"tags":["Dataset"],"summary":"Log Batch","operationId":"log_batch_v1_datasets_log_batch_post","parameters":[{"name":"x-dataset-id","in":"header","required":true,"schema":{"type":"string","title":"X-Dataset-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordLogMessage"},"title":"Data"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/log-conversation":{"post":{"tags":["Dataset"],"summary":"Log Conversation","operationId":"log_conversation_v1_datasets_log_conversation_post","parameters":[{"name":"x-agent-id","in":"header","required":true,"schema":{"type":"string","description":"Agent ID","title":"X-Agent-Id"},"description":"Agent ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichmentEvent"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/log-feedback":{"post":{"tags":["Dataset"],"summary":"Log Feedback","operationId":"log_feedback_v1_datasets_log_feedback_post","parameters":[{"name":"x-agent-id","in":"header","required":true,"schema":{"type":"string","description":"Agent ID","title":"X-Agent-Id"},"description":"Agent ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventFeedback"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/search":{"post":{"tags":["Dataset"],"summary":"Search Datasets","description":"Retrieve all Datasets based on search params","operationId":"search_datasets","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetSearchParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DatasetResponse_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/tags/{tag}":{"get":{"tags":["Dataset"],"summary":"Get Tagged Datasets","description":"Get all dataset IDs tagged with the specified tag.","operationId":"get_tagged_datasets","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Tag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Get Tagged Datasets"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/datasets/{dataset_id}":{"get":{"tags":["Dataset"],"summary":"Get Dataset","description":"Fetch a specific Dataset\n\n- **dataset_id** (str): Required, ID of the dataset to be fetched.\n- **warehouse_schema** (bool): Optional. When true, schema types are converted for warehouse consumers (e.g. image→json).","operationId":"get_dataset","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"warehouse_schema","in":"query","required":false,"schema":{"type":"boolean","description":"Convert internal types (e.g. image) to warehouse-compatible types","default":false,"title":"Warehouse Schema"},"description":"Convert internal types (e.g. image) to warehouse-compatible types"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset"],"summary":"Delete Dataset","description":"Delete a specific Dataset\n\n- **dataset_id** (str): Required, ID of the dataset to be deleted.","operationId":"delete_dataset","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Dataset"],"summary":"Update Dataset","description":"Update an existing Dataset\n\n- **payload** (DatasetUpdate): Required. The payload that includes:\n - **name** (str or None): Updated name of the dataset.\n - **description** (str or None): A revised description about the dataset.\n - **id** (str or None): Unique identifier of the dataset.\n - **model_version_id** (str or None): Updated model version identifier.\n - **created_by** (str or None): Identifier of the user who updated the dataset.\n - **tags** (list of str or None): A list of updated tags related to the dataset.\n - **schema** (SchemaUpdate or None): The updated schema of the dataset.","operationId":"update_dataset","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/archive":{"post":{"tags":["Dataset"],"summary":"Archive Dataset","operationId":"archive_dataset","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/log":{"post":{"tags":["Dataset"],"summary":"Log","description":"Log a record. Accepts application/json or multipart/form-data (with images).","operationId":"log_v1_datasets__dataset_id__log_post","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"content-type","in":"header","required":false,"schema":{"type":"string","default":"","title":"Content-Type"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/models":{"get":{"tags":["Dataset"],"summary":"Get Models By Dataset Id","description":"Retrieve all Models connected to a Dataset\n\n- **dataset_id** (str): Required, ID of the dataset to fetch models.","operationId":"get_models_by_dataset_id","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ModelResponse_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}/tags":{"post":{"tags":["Dataset"],"summary":"Add Dataset Tags","description":"Add tags to dataset.","operationId":"add_dataset_tags","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"title":"Tag List"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Dataset"],"summary":"Delete Dataset Tags","description":"Delete tags from dataset.","operationId":"delete_dataset_tags","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"description":"List of tag UUIDs to delete","title":"Ids"},"description":"List of tag UUIDs to delete"}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/datasets/{dataset_id}/unarchive":{"post":{"tags":["Dataset"],"summary":"Unarchive Dataset","operationId":"unarchive_dataset","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/destinations":{"post":{"tags":["Destinations"],"summary":"Create Destination","description":"Create a new destination\n\n- **base_destination_create** (DestinationCreateBase): Required. The payload that includes:\n - **name** (str): Name of the new destination.\n - **integration_id** (UUID): Unique identifier of the integration to which the destination would be created.\n - **params** (dict): Additional parameters for the creation of the destination.","operationId":"create_destination","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestinationCreateBase"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestinationResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Destinations"],"summary":"Get Destinations","description":"Get all available destinations based on the provided filters\n\n- **destination_id** (List[UUID]): Optional filter by destination IDs.\n- **integration_id** (List[UUID]): Optional filter by related integration IDs.\n- **name** (List[str]): Optional filter by destination names.\n- **created_by** (List[str]): Optional filter by creation user IDs.","operationId":"get_destinations","parameters":[{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Id"}},{"name":"integration_id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","format":"uuid"}},{"type":"null"}],"title":"Integration Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Name"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Created By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DestinationResponse_"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/destinations/{destination_id}":{"get":{"tags":["Destinations"],"summary":"Get Destination By Id","description":"Get a specific destination by ID\n\n- **destination_id** (UUID): The unique identifier of the destination.","operationId":"get_destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Destination Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestinationResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Destinations"],"summary":"Update Destination By Id","description":"Update a specific destination by ID\n\n- **base_destination_update** (DestinationUpdateBase): The payload containing the update data for the destination, which includes:\n - **name** (str): The updated name of the destination.\n - **params** (dict): A dictionary containing key-value pairs for parameters to be updated.","operationId":"update_destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Destination Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestinationUpdateBase"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DestinationResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Destinations"],"summary":"Delete Destination By Id","description":"Delete a specific destination by ID\n\n- **destination_id** (UUID): The unique identifier of the destination.","operationId":"delete_destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Destination Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails":{"get":{"tags":["Guardrails"],"summary":"Get Guardrails","description":"Get guardrails list with pagination.","operationId":"get_guardrails","parameters":[{"name":"only_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Only Archived"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid4"}},{"type":"null"}],"description":"Guardrail IDs","title":"Ids"},"description":"Guardrail IDs"},{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted guardrails","default":false,"title":"With Deleted"},"description":"Include deleted guardrails"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":25,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_GuardrailSchema_Customized"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Guardrails"],"summary":"Create Guardrail","description":"Create a new guardrail.","operationId":"create_guardrail","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailSchema"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/bulk-action":{"post":{"tags":["Guardrails"],"summary":"Guardrail Bulk Action","description":"Perform a bulk action on a list of guardrails.","operationId":"guardrail_bulk_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailBulkActionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/run":{"post":{"tags":["Guardrails"],"summary":"Guardrail Run","description":"Run guardrules. Accepts application/json (text-only) or multipart/form-data (with optional images, up to MAX_IMAGES).","operationId":"guardrail_run","parameters":[{"name":"content-type","in":"header","required":false,"schema":{"type":"string","default":"","title":"Content-Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailValidationResponse"}}}},"401":{"description":"Unauthorized"},"413":{"description":"Request Entity Too Large"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/schema":{"get":{"tags":["Guardrails"],"summary":"Get Guardrail Schema","description":"Return JSON schema for all available guard payloads dynamically.","operationId":"get_guardrail_schema","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/search":{"post":{"tags":["Guardrails"],"summary":"Search Guardrails","description":"Get guardrails list with pagination.","operationId":"search_guardrails","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":25,"default":25,"title":"Size"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailsSearchParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_GuardrailSchema_Customized"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/tags/{tag}":{"get":{"tags":["Guardrails"],"summary":"Get Tagged Guardrails","description":"Get all ids tagged by *all* tags.","operationId":"get_tagged_guardrails","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Tag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"title":"Response Get Tagged Guardrails"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/validate":{"post":{"tags":["Guardrails"],"summary":"Guardrail Validate","description":"Route handler delegating guardrail validate to the service layer.","operationId":"guardrail_validate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailValidateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailValidationResponse"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/verify-dataset-schema/{dataset_id}":{"post":{"tags":["Guardrails"],"summary":"Verify Dataset Schema","description":"Verify that a dataset has the required schema for guardrail observability.","operationId":"verify_guardrail_dataset_schema","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","title":"Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Verify Dataset Schema"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/versions":{"get":{"tags":["Guardrail Versions"],"summary":"Get Guardrail Versions","description":"Get all guardrail versions.","operationId":"get_guardrail_versions","parameters":[{"name":"guardrail_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"Guardrail ID","title":"Guardrail Id"},"description":"Guardrail ID"},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"}},{"type":"null"}],"description":"Guardrail version IDs","title":"Ids"},"description":"Guardrail version IDs"},{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted guardrails' versions","default":false,"title":"With Deleted"},"description":"Include deleted guardrails' versions"},{"name":"model_provider_with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted model providers","default":false,"title":"Model Provider With Deleted"},"description":"Include deleted model providers"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GuardrailVersionSchema"},"title":"Response Get Guardrail Versions"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/versions/run":{"post":{"tags":["Guardrail Versions"],"summary":"Run Guardrail Versions","description":"Run guardrail versions. Accepts application/json (text-only) or multipart/form-data (with optional images, up to MAX_IMAGES).","operationId":"run_guardrail_versions","parameters":[{"name":"content-type","in":"header","required":false,"schema":{"type":"string","default":"","title":"Content-Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GuardrailRuleResult"},"title":"Response Run Guardrail Versions"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"413":{"description":"Request Entity Too Large"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/versions/{guardrail_version_id}":{"patch":{"tags":["Guardrail Versions"],"summary":"Patch Guardrail Version","description":"Patch a guardrail version.","operationId":"patch_guardrail_version","parameters":[{"name":"guardrail_version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Guardrail Version Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailVersionPatchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailVersionSchema"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/{guardrail_id}":{"get":{"tags":["Guardrails"],"summary":"Get Guardrail By Id","description":"Get guardrail by id.","operationId":"get_guardrail_by_id","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}},{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted guardrails","default":false,"title":"With Deleted"},"description":"Include deleted guardrails"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailSchema"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Guardrails"],"summary":"Patch Guardrail","description":"Patch a guardrail.","operationId":"patch_guardrail","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailPatchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailSchema"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Guardrails"],"summary":"Delete Guardrail","description":"Delete a guardrail.","operationId":"delete_guardrail","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/{guardrail_id}/archive":{"post":{"tags":["Guardrails"],"summary":"Archive Guardrail","operationId":"archive_guardrail","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/{guardrail_id}/create-dataset":{"post":{"tags":["Guardrails"],"summary":"Create Guardrail Dataset","operationId":"create_guardrail_dataset","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetPayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Create Guardrail Dataset"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/{guardrail_id}/tags":{"post":{"tags":["Guardrails"],"summary":"Add Guardrail Tags","description":"Add tags to guardrail.","operationId":"add_guardrail_tags","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"title":"Tag List"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Guardrails"],"summary":"Delete Guardrail Tags","description":"Delete tags from guardrail.","operationId":"delete_guardrail_tags","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string","format":"uuid4"},"description":"List of tag UUIDs to delete","title":"Ids"},"description":"List of tag UUIDs to delete"}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/{guardrail_id}/unarchive":{"post":{"tags":["Guardrails"],"summary":"Unarchive Guardrail","operationId":"unarchive_guardrail","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Guardrail Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailSchema"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/guardrails/{guardrail_id}/versions":{"post":{"tags":["Guardrail Versions"],"summary":"Create Guardrail Version","description":"Create a new guardrail version.","operationId":"create_guardrail_version","parameters":[{"name":"guardrail_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Guardrail Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailVersionCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuardrailVersionSchema"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/integrations":{"get":{"tags":["Integrations"],"summary":"Get Integrations","description":"Get all available integrations\n\n- **integration_type** (IntegrationType): Optional filter by integration type\n- **created_by** (str): Optional filter by user ID who created the integration.","operationId":"get_integrations","parameters":[{"name":"integration_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/IntegrationType"},{"type":"null"}],"title":"Integration Type"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_IntegrationResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/integrations/{integration_id}":{"get":{"tags":["Integrations"],"summary":"Get Integration By Id","description":"Get a specific integration by ID\n\n- **integration_id** (UUID): The unique identifier of the integration.","operationId":"get_integration","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Integration Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Integrations"],"summary":"Delete Integration By Id","description":"Delete a specific integration by ID\n\n- **integration_id** (UUID): The unique identifier of the integration.\n- **delete_destinations** (bool): Whether or not to delete destinations associated with the integration.","operationId":"delete_integration","parameters":[{"name":"integration_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Integration Id"}},{"name":"delete_destinations","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Delete Destinations"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/knowledge":{"post":{"tags":["Knowledge"],"summary":"Create Knowledge","description":"Create a new knowledge object.","operationId":"create_knowledge","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Knowledge"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Knowledge"],"summary":"Get Knowledges","description":"Get Knowledge objects.","operationId":"get_knowledge_objects","parameters":[{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted knowledge","default":false,"title":"With Deleted"},"description":"Include deleted knowledge"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":25,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Knowledge_Customized"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/knowledge/file_info/{ids_list}":{"get":{"tags":["Knowledge"],"summary":"Get File Info","description":"Get file information for a list of file IDs.","operationId":"get_file_info","parameters":[{"name":"ids_list","in":"path","required":true,"schema":{"type":"string","title":"Ids List"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FileInfo"},"title":"Response Get File Info"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/knowledge/upload":{"post":{"tags":["Knowledge"],"summary":"Upload Files","description":"Upload files to cloud storage.","operationId":"upload_files","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_files"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/knowledge/{knowledge_id}":{"delete":{"tags":["Knowledge"],"summary":"Delete Knowledge","description":"Delete an knowledge object.","operationId":"delete_knowledge","parameters":[{"name":"knowledge_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Knowledge Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Knowledge"],"summary":"Get Knowledge By Id","description":"Get a knowledge object by id.","operationId":"get_knowledge_by_id","parameters":[{"name":"knowledge_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Knowledge Id"}},{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted knowledge","default":false,"title":"With Deleted"},"description":"Include deleted knowledge"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Knowledge"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Knowledge"],"summary":"Update knowledge object","operationId":"update_knowledge","parameters":[{"name":"knowledge_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Knowledge Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Knowledge"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/knowledge/{knowledge_id}/reindex":{"post":{"tags":["Knowledge"],"summary":"Reindex knowledge documents","operationId":"reindex_knowledge","parameters":[{"name":"knowledge_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Knowledge Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Knowledge"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/mcps":{"post":{"tags":["MCP Tools"],"summary":"Create Mcp","description":"Create a new MCP entity.\n\nThis endpoint will connect to the MCP server, fetch available tools,\nand validate that the specified tool_name exists.\n\nParameters:\n- **name**: MCP name\n- **url**: MCP server URL\n- **tool_name**: Name of the specific tool to fetch from MCP server\n- **network_access**: Network access level (must be 'remote')\n- **headers**: Optional authentication headers","operationId":"create_mcp","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPBase"}}}},"responses":{"201":{"description":"MCP entity created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCP"}}}},"400":{"description":"Invalid request or tool not found in MCP server"},"422":{"description":"Validation error (malformed request)"},"500":{"description":"Internal server error"},"502":{"description":"MCP server connection error"}}},"get":{"tags":["MCP Tools"],"summary":"List Mcps","description":"Get a paginated list of MCP entities.\n\nIf search is provided, it takes priority over specific filters.\nBy default, soft-deleted MCPs are excluded. Set include_disabled=true to include them.","operationId":"list_mcps","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"network_access","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Network Access"}},{"name":"include_disabled","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Disabled"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Size"}}],"responses":{"200":{"description":"List of MCP entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_MCP_Customized"}}}},"422":{"description":"Validation error"},"500":{"description":"Internal server error"}}}},"/v1/mcps/test":{"post":{"tags":["MCP Tools"],"summary":"Test Mcp Connectivity","description":"Test MCP server connectivity.\n\nThis endpoint tests the connectivity to the MCP server using the provided URL and headers.\nOn success, it returns the full list of available tools with their schemas.\nOn failure, it returns an appropriate error status code (400 or 502).\n\nParameters:\n- **url**: The MCP server URL to test\n- **headers**: Optional authentication headers","operationId":"test_mcp_connectivity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPTestRequest"}}},"required":true},"responses":{"200":{"description":"Successfully connected to MCP server with tool schemas","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPTestResponse"}}}},"400":{"description":"Invalid JSON from MCP server"},"422":{"description":"Validation error"},"500":{"description":"Internal server error"},"502":{"description":"Failed to connect to MCP server"}}}},"/v1/mcps/{mcp_id}":{"get":{"tags":["MCP Tools"],"summary":"Get Mcp By Id","description":"Get an MCP entity by ID.\n\nBy default, returns 404 for soft-deleted MCPs. Set disabled=true to retrieve them.\n\nParameters:\n- **mcp_id**: The UUID of the MCP entity\n- **include_disabled**: If true, will return soft-deleted MCPs","operationId":"get_mcp_by_id","parameters":[{"name":"mcp_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Mcp Id"}},{"name":"include_disabled","in":"query","required":false,"schema":{"type":"boolean","description":"Include soft-deleted MCPs (default: false)","default":false,"title":"Include Disabled"},"description":"Include soft-deleted MCPs (default: false)"}],"responses":{"200":{"description":"MCP entity details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCP"}}}},"404":{"description":"MCP entity not found"},"422":{"description":"Validation error"},"500":{"description":"Internal server error"}}},"patch":{"tags":["MCP Tools"],"summary":"Update Mcp","description":"Update an MCP entity.\n\nOnly the name field can be updated. All other fields are immutable.\n\nParameters:\n- **mcp_id**: The UUID of the MCP entity\n- **payload**: Update payload (only name field is allowed)","operationId":"update_mcp","parameters":[{"name":"mcp_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Mcp Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPUpdate"}}}},"responses":{"200":{"description":"MCP entity updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCP"}}}},"400":{"description":"Invalid request"},"404":{"description":"MCP entity not found"},"422":{"description":"Validation error"},"500":{"description":"Internal server error"}}},"delete":{"tags":["MCP Tools"],"summary":"Delete Mcp","description":"Soft delete an MCP entity.\n\nThis endpoint will soft delete the MCP by setting the deleted_at timestamp.\nExisting agent versions that reference this MCP will continue to work.\n\nParameters:\n- **mcp_id**: The UUID of the MCP entity","operationId":"delete_mcp","parameters":[{"name":"mcp_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Mcp Id"}}],"responses":{"204":{"description":"MCP entity deleted successfully"},"404":{"description":"MCP entity not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal server error"}}}},"/v1/metrics/distribution":{"post":{"tags":["Metrics"],"summary":"Distribution","operationId":"distribution","parameters":[{"name":"x-meta-type","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"use_cache":false,"default":"dataset","title":"X-Meta-Type"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistributionResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/metrics/distribution-multi":{"post":{"tags":["Metrics"],"summary":"Distribution Multi","operationId":"distribution-multiple","parameters":[{"name":"x-meta-type","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"use_cache":false,"default":"dataset","title":"X-Meta-Type"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DistributionPayload"},"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DistributionResponse"},"title":"Response Distribution-Multiple"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/metrics/performance":{"post":{"tags":["Metrics"],"summary":"Performance","operationId":"performance","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AccuracyPayload"},{"$ref":"#/components/schemas/PrecisionPayload"},{"$ref":"#/components/schemas/RecallPayload"},{"$ref":"#/components/schemas/F1ScorePayload"},{"$ref":"#/components/schemas/RMSEPayload"},{"$ref":"#/components/schemas/MSEPayload"},{"$ref":"#/components/schemas/MAEPayload"},{"$ref":"#/components/schemas/MAPEPayload"},{"$ref":"#/components/schemas/LogLossPayload"},{"$ref":"#/components/schemas/AUCROCPayload"}],"title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerformanceResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/metrics/performance-multi":{"post":{"tags":["Metrics"],"summary":"Performance Multi","operationId":"performance-multiple","requestBody":{"content":{"application/json":{"schema":{"items":{"anyOf":[{"$ref":"#/components/schemas/AccuracyPayload"},{"$ref":"#/components/schemas/PrecisionPayload"},{"$ref":"#/components/schemas/RecallPayload"},{"$ref":"#/components/schemas/F1ScorePayload"},{"$ref":"#/components/schemas/RMSEPayload"},{"$ref":"#/components/schemas/MSEPayload"},{"$ref":"#/components/schemas/MAEPayload"},{"$ref":"#/components/schemas/MAPEPayload"},{"$ref":"#/components/schemas/LogLossPayload"},{"$ref":"#/components/schemas/AUCROCPayload"}]},"type":"array","title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PerformanceResponse"},"type":"array","title":"Response Performance-Multiple"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/model-providers":{"get":{"tags":["Model Providers"],"summary":"Get Model Providers","description":"Get model providers list with pagination.","operationId":"get_model_providers","parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid4"}},{"type":"null"}],"description":"Model provider IDs","title":"Ids"},"description":"Model provider IDs"},{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted model providers","default":false,"title":"With Deleted"},"description":"Include deleted model providers"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"enum":["embedding","chat"],"type":"string"},{"type":"null"}],"description":"Filter by provider capability","title":"Type"},"description":"Filter by provider capability"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":25,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ModelProviderSchema_Customized"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Model Providers"],"summary":"Create Model Provider","description":"Create a new model provider.","operationId":"create_model_provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProviderCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProviderSchema"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/model-providers/prebuilt-provider/status":{"get":{"tags":["Model Providers"],"summary":"Get Prebuilt Provider Status","operationId":"get_prebuilt_provider_status","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrebuiltProviderStatus"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/model-providers/{model_provider_id}":{"get":{"tags":["Model Providers"],"summary":"Get Model Provider By Id","description":"Get model provider by id.","operationId":"get_model_provider_by_id","parameters":[{"name":"model_provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Model Provider Id"}},{"name":"with_deleted","in":"query","required":false,"schema":{"type":"boolean","description":"Include deleted model providers","default":false,"title":"With Deleted"},"description":"Include deleted model providers"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProviderSchema"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Model Providers"],"summary":"Patch Model Provider","description":"Patch a model provider.","operationId":"patch_model_provider","parameters":[{"name":"model_provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Model Provider Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProviderPatchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelProviderSchema"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Model Providers"],"summary":"Delete Model Provider","description":"Delete a model provider.","operationId":"delete_model_provider","parameters":[{"name":"model_provider_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Model Provider Id"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/models":{"post":{"tags":["Model"],"summary":"Create Model","description":"Create a new Model\n\n- **payload** (ModelCreate): Required. The payload that includes:\n - **name** (str): Name of the model, min_length=1, max_length=100.\n - **description** (str or None): A description about the model.\n - **id** (str or None): Unique identifier of the model. If not provided, it will be generated.","operationId":"create_model","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Model"],"summary":"Get Models","description":"Get all Models with optional filters\n\n- **payload** (ModelFilters): Optional. The payload that includes:\n - **name** (str): Name of the model.\n - **id** (str): Unique identifier of the model.\n - **created_by** (str): User who created the model.","operationId":"get_models","parameters":[{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ModelResponse_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models/{model_id}":{"delete":{"tags":["Model"],"summary":"Delete Model","description":"Delete a Model by id","operationId":"delete_model","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Model"],"summary":"Get Model By Id","description":"Get a Model by id","operationId":"get_model_by_id","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Model"],"summary":"Update Model","description":"Update a Model by id\n\n- **model_id** (str): Required. The id of the model to be updated.\n- **payload** (ModelUpdate): Required. The payload that includes:\n - **name** (str): Name of the model, min_length=1, max_length=100.\n - **description** (str or None): A description about the model.","operationId":"update_model","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models/{model_id}/datasets":{"get":{"tags":["Model"],"summary":"Get Datasets By Model Id","description":"Get all Datasets connected to a Model by id\n\n- **model_id** (str): Required. The id of the model to get datasets for.","operationId":"get_datasets_by_model_id","parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"string","title":"Model Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DatasetResponse_Customized"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/policies":{"post":{"tags":["Policies"],"summary":"Create Policy","description":"Creates a new Policy\n\n- **payload** (PolicySchema): Required. The policy data to be created:\n - **name** (str): A descriptive name for this policy.\n - **data_config**: Configuration relevant to the retrieval of data for this policy:\n for compare distribution policy:\n - **query_a** (Query): Cube.js query.\n - **query_b** (Query): Cube.js query.\n - **query_a_time_range_config**: (TimeRangeConfig or None): Time range configuration for query A.\n - **query_b_time_range_config**: (TimeRangeConfig or None): Time range configuration for query B.\n - **distance_function** (DistanceFunction): Distance function to use.\n for statistics policy:\n - **query** (Query): Cube.js query.\n - **time_range_config**: (TimeRangeConfig): Time range configuration for the query.\n - **cron_expression** (str): Cron expression for policy evaluation.\n - **condition_above_value** (float or None): Condition above value.\n - **condition_below_value** (float or None): Condition below value.\n - **destination_ids** (list of UUID): List of communication channels to get notified through.\n - **alert_on_status** (AlertOnStatusDirection): Trigger policy action if the value is above/below.\n - **alert_on_policy_level** (bool): Trigger policy action on a single group/entire groups.\n - **dataset_id** (str): The dataset this policy is monitoring.","operationId":"create_policy","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Policies"],"summary":"Get Policies","description":"Retrieve all Policies based on provided filters\n\n- **name** (str or None): Optional. The name of the policy to filter by.\n- **status** (PolicyStatus or None): Optional. The status of the policy to filter by.\n- **created_by** (str or None): Optional. The creator of the policy to filter by.\n- **dataset_id** (str or None): Optional. The ID of the dataset associated with the policy to filter by.\n- **search** (str or None): Optional. Global search term that searches across policy ID, name, and updated_at fields. If both search and specific filters are provided, search takes precedence.\n\nRaises:\n 500: If there is a server error.\n 404: If the requested resource is not found.\n 200: If the operation is successful.","operationId":"get_policies","parameters":[{"name":"only_archived","in":"query","required":false,"schema":{"type":"boolean","description":"Only return archived policies","default":false,"title":"Only Archived"},"description":"Only return archived policies"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PolicyStatus"},{"type":"null"}],"title":"Status"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"dataset_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"}},{"name":"dataset_b_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset B Id"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PolicyResponse_Customized"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/policies/bulk-action":{"post":{"tags":["Policies"],"summary":"Policy Bulk Action","description":"Perform a bulk action on a list of policies.","operationId":"policy_bulk_action","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyBulkActionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/policies/search":{"post":{"tags":["Policies"],"summary":"Search Policies","description":"Search through Policies based on provided filters","operationId":"search_policies","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"default":25,"title":"Size"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicySearchParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PolicyResponse_Customized"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/policies/tags/{tag}":{"get":{"tags":["Policies"],"summary":"Get Tagged Policies","description":"Get all ids tagged by *all* tags.","operationId":"get_tagged_policies","parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Tag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Get Tagged Policies"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/policies/template":{"post":{"tags":["Policies"],"summary":"Create Policy Template","description":"Creates a new Policy based on a provided template","operationId":"create_policy_template","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/NoResponseTemplate"},{"$ref":"#/components/schemas/LatencySpikeTemplate"},{"$ref":"#/components/schemas/LatencyAnomalyTemplate"},{"$ref":"#/components/schemas/NoThroughputTemplate"},{"$ref":"#/components/schemas/ThroughputAnomalyTemplate"},{"$ref":"#/components/schemas/GuardrailViolationsTemplate"}],"title":"Payload","discriminator":{"propertyName":"type","mapping":{"no_response":"#/components/schemas/NoResponseTemplate","latency_spike":"#/components/schemas/LatencySpikeTemplate","latency_anomaly":"#/components/schemas/LatencyAnomalyTemplate","no_throughput":"#/components/schemas/NoThroughputTemplate","throughput_anomaly":"#/components/schemas/ThroughputAnomalyTemplate","guardrail_violations":"#/components/schemas/GuardrailViolationsTemplate"}}}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyResponse"}}}},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/policies/{policy_id}":{"get":{"tags":["Policies"],"summary":"Get Policy By Id","description":"Get policy by ID\n\n- policy_id (UUID): The ID of the policy.","operationId":"get_policy","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Policies"],"summary":"Delete policy by ID","description":"Delete a specific Policy\n\n- **policy_id**: The ID of the policy to be deleted.\n\nRaises:\n PolicyNotFoundException: If the policy with the specified ID is not found.","operationId":"delete_policy","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Policies"],"summary":"Update policy by ID","description":"Update policy by ID.\n\n- **payload** (PolicyUpdate): Required. The updated policy information with:\n - **name** (str or None): The updated name of the policy.\n - **data_config**: Configuration relevant to the retrieval of data for this policy:\n for compare distribution policy:\n - **query_a** (Query): Cube.js query.\n - **query_b** (Query): Cube.js query.\n - **query_a_time_range_config**: (TimeRangeConfig or None): Time range configuration for query A.\n - **query_b_time_range_config**: (TimeRangeConfig or None): Time range configuration for query B.\n - **distance_function** (DistanceFunction): Distance function to use.\n for statistics policy:\n - **query** (Query): Cube.js query.\n - **cron_expression** (str or None): The updated cron expression for the policy evaluation.\n - **condition_above_value** (float or None): The updated condition above value.\n - **condition_below_value** (float or None): The updated condition below value.\n - **destination_ids** (list of UUID or None): The updated list of communication channels to get notified through.\n - **alert_on_status** (AlertOnStatusDirection or None): The updated trigger policy action if the value is above/below.\n - **alert_on_policy_level** (bool or None): The updated trigger policy action on a single group/entire groups.\n - **dataset_id** (str or None): The updated dataset this policy is monitoring.\n- **policy_id** (UUID): Required. The ID of the policy to be updated.","operationId":"update_policy","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyUpdate"}}}},"responses":{"200":{"description":"The updated policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/policies/{policy_id}/archive":{"post":{"tags":["Policies"],"summary":"archive policy by ID","operationId":"archive_policy","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/policies/{policy_id}/tags":{"post":{"tags":["Policies"],"summary":"Add Policy Tags","description":"Add tags to policy.","operationId":"add_policy_tags","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Tag List"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Policies"],"summary":"Delete Policy Tags","description":"Delete tags from policy.","operationId":"delete_policy_tags","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of tag UUIDs to delete","title":"Ids"},"description":"List of tag UUIDs to delete"}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/policies/{policy_id}/trigger":{"post":{"tags":["Policies"],"summary":"Trigger policy by ID","description":"Trigger policy by ID.\n\n- **policy_id** (UUID): The unique identifier of the policy that needs to be triggered.","operationId":"trigger_policy","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"responses":{"202":{"description":"Accepted"},"204":{"description":"True if the policy is successfully triggered, raise error otherwise"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/policies/{policy_id}/unarchive":{"post":{"tags":["Policies"],"summary":"unarchive policy by ID","operationId":"unarchive_policy","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Policy Id"}}],"responses":{"200":{"description":"The unarchived policy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/sources":{"post":{"tags":["Sources"],"summary":"Create Source","description":"Create a new source.\n\nThe SourceCreate model is defined by either the SourceCreateGCS, SourceCreateAzure or\nSourceCreateS3 classes, based on the source type.\n\nParameters:\n\n- **source_id**: UUID of the source.\n- **payload**: Instance of SourceCreate model which can be any one of the following based on source type:\n - **SourceCreateGCS**\n - **type**: Literal, Source Type GCS.\n - **params**: SourceGCSParams object or None. Parameters for GCS source.\n - **credentials**: GCPCredentials object or None. Credentials for GCS source.\n - Validation is applied on the `credentials` field based on the hosting type.\n - **SourceCreateAzure**\n - **type**: Literal, Source type AZURE_BLOB_STORAGE.\n - **params**: SourceAzureParams object. Parameters for Azure source.\n - **credentials**: AzureCredentials object. Credentials for Azure source.\n - **SourceCreateS3**\n - **type**: Literal, Source type S3.\n - **params**: SourceS3Params object. Parameters for S3 source.\n - **credentials**: AWSCredentials object. Credentials for AWS source.","operationId":"create_source","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SourceCreatePostgres"},{"$ref":"#/components/schemas/SourceCreateGCS"},{"$ref":"#/components/schemas/SourceCreateAzure"},{"$ref":"#/components/schemas/SourceCreateS3"}],"title":"Source Create Payload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"get":{"tags":["Sources"],"summary":"Get Sources","description":"Retrieve all sources based on the provided filters.\n\n- **name**: Name of the source\n- **created_by**: Creator of the source\n- **created_at**: When the source was created\n- **updated_at**: When the source was last updated\n- **type**: Type of the source","operationId":"get_sources","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"created_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"}},{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"updated_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SourceType"},{"type":"null"}],"title":"Type"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_SourceResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/sources/test-connection":{"post":{"tags":["Sources"],"summary":"Test Source Connection","description":"Test the connection to a source.\n\n- **payload**: Instance of TestSourceConnectionRequest model.","operationId":"test_source_connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSourceConnectionRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/sources/{source_id}":{"get":{"tags":["Sources"],"summary":"Get Source","description":"Retrieve a Source based on the given source_id.\n\n- **source_id**: UUID of the source","operationId":"get_source","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Sources"],"summary":"Delete Source","description":"Delete a specific source.\n\n- **source_id**: UUID of the source","operationId":"delete_source","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Source Id"}}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Sources"],"summary":"Update Source","description":"Update an existing source.\n\nThe SourceUpdate Model is defined by the SourceUpdateGCS or SourceUpdateS3 class, based on the source type.\n\nParameters:\n\n- **source_id**: UUID of the source to update.\n\n- **payload**: Instance of SourceUpdate model which can be any one of the following based on source type:\n - **SourceUpdateGCS**\n - **type**: Literal, Source Type GCS.\n - **params**: SourceGCSParams object or None. Parameters for GCS source.\n - **credentials**: GCPCredentials object or None. Credentials for GCS source.\n - **SourceUpdateS3**\n - **type**: Literal, Source type S3.\n - **params**: SourceS3Params object or None. Parameters for S3 source.\n - **credentials**: AWSCredentials object or None. Credentials for AWS source.","operationId":"update_source","parameters":[{"name":"source_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Source Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","additionalProperties":true},{"$ref":"#/components/schemas/SourceUpdateGCS"},{"$ref":"#/components/schemas/SourceUpdateS3"},{"$ref":"#/components/schemas/SourceUpdatePostgres"}],"title":"Sourceupdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceResponse"}}}},"404":{"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/tags":{"get":{"tags":["Tags"],"summary":"Get Tags","operationId":"get_tags","parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"}},{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"},"title":"Response Get Tags"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Tags"],"summary":"Create Tag","description":"Create a new tag.","operationId":"create_tag","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagCreatePayload"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"401":{"description":"Unauthorized"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/tags-management/tags/delete-all":{"delete":{"tags":["Management"],"summary":"Delete All Tags","description":"Delete all tags for the tenant.","operationId":"delete_all_tags","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAllEntityResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"500":{"description":"Internal Server Error"}}}},"/v1/tags/{tag_id}":{"get":{"tags":["Tags"],"summary":"Get Tag By Id","description":"Get tag by id.","operationId":"get_tag_by_id","parameters":[{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Tag Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"patch":{"tags":["Tags"],"summary":"Patch Tag","operationId":"patch_tag","parameters":[{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Tag Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagPatchPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Tags"],"summary":"Delete Tag","description":"Delete tag.","operationId":"delete_tag","parameters":[{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","format":"uuid4","title":"Tag Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"422":{"description":"Unprocessable Entity"},"500":{"description":"Internal Server Error"}}}},"/v1/tenant/{tenant_id}":{"delete":{"tags":["tenant"],"summary":"Delete Tenant","description":"Delete tenant endpoint.","operationId":"delete_tenant","parameters":[{"name":"tenant_id","in":"path","required":true,"schema":{"type":"string","title":"Tenant Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"info":{"title":"Superwise Main Entities","description":"API reference","version":"1.31.0"},"components":{"schemas":{"DeleteAllEntityResponse":{"properties":{"entity":{"type":"string","title":"Entity"},"succeeded":{"type":"integer","title":"Succeeded"},"failed":{"type":"integer","title":"Failed"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["entity","succeeded","failed","total"],"title":"DeleteAllEntityResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Tag":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","title":"Color"},"id":{"type":"string","format":"uuid4","title":"Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["name","color","id","created_by"],"title":"Tag"},"TagCreatePayload":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","title":"Color"}},"type":"object","required":["name","color"],"title":"TagCreatePayload"},"TagPatchPayload":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":50},{"type":"null"}],"title":"Name"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","title":"TagPatchPayload"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"BulkActionItemResult":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"string"}],"title":"Id"},"status":{"$ref":"#/components/schemas/BulkItemStatus"},"error_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Error Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"}},"type":"object","required":["id","status"],"title":"BulkActionItemResult"},"BulkActionResponse":{"properties":{"summary":{"$ref":"#/components/schemas/BulkActionSummary"},"results":{"items":{"$ref":"#/components/schemas/BulkActionItemResult"},"type":"array","title":"Results"}},"type":"object","required":["summary","results"],"title":"BulkActionResponse"},"BulkActionSummary":{"properties":{"requested":{"type":"integer","title":"Requested"},"succeeded":{"type":"integer","title":"Succeeded"},"failed":{"type":"integer","title":"Failed"}},"type":"object","required":["requested","succeeded","failed"],"title":"BulkActionSummary"},"BulkItemStatus":{"type":"string","enum":["success","failed"],"title":"BulkItemStatus"},"DatasetBulkActionRequest":{"properties":{"action":{"$ref":"#/components/schemas/DatasetBulkActionType","description":"The action to perform on the datasets"},"ids":{"items":{"type":"string"},"type":"array","maxItems":50,"minItems":1,"title":"Ids","description":"List of dataset IDs to perform the action on"}},"type":"object","required":["action","ids"],"title":"DatasetBulkActionRequest"},"DatasetBulkActionType":{"type":"string","enum":["delete","archive"],"title":"DatasetBulkActionType"},"DatasetCreate":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Dataset Name","description":"A descriptive name for this dataset"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Description","description":"Relevant information about the context of this dataset"},"model_version_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version Id"},"tags":{"anyOf":[{"items":{"$ref":"#/components/schemas/DatasetTag"},"type":"array"},{"type":"null"}],"title":"Tags"},"schema":{"$ref":"#/components/schemas/Schema-Input","default":{}}},"additionalProperties":false,"type":"object","required":["name"],"title":"DatasetCreate","example":{"description":"Some Dataset Description","model_version_id":"catboost_v365","name":"Name for Some Dataset","schema":{"fields":{"age":{"type":"numeric"}}},"tags":{"project":"churn_prediction","type":"training"}}},"DatasetResponse":{"properties":{"_id":{"type":"string","title":"Id"},"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Dataset Name","description":"A descriptive name for this dataset"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Description","description":"Relevant information about the context of this dataset"},"model_version_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Version Id"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"User who last updated this dataset"},"tags":{"anyOf":[{"items":{"$ref":"#/components/schemas/DatasetTag"},"type":"array"},{"type":"null"}],"title":"Tags"},"schema":{"$ref":"#/components/schemas/Schema-Output","default":{}},"tenant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Id"},"tag_ids":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Tag Ids"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["_id","id","name","created_by"],"title":"DatasetResponse","example":{"_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","created_by":"1514f337-7b42-435d-bc19-99be46c13098","description":"Some Dataset Description","id":"Training_16101988","model_version_id":"catboost_v365","name":"Name for Some Dataset","tags":{"project":"churn_prediction","type":"training"}}},"DatasetSearchParams":{"properties":{"filters":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Filters","description":"Filter on db columns","examples":[["name","eq","active"],[["id","eq","5c05dc9f-f04a-4ce8-9d57-2ec63ee76aac"],"and",["description","ilike","Construction"]]]},"search":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Search","description":"Free text search on searchable fields"},"sort_by":{"type":"string","enum":["id","name","created_at","updated_at"],"title":"Sort By","description":"Field to sort by","default":"updated_at"},"sort_direction":{"type":"string","enum":["asc","desc"],"title":"Sort Direction","description":"Sort direction (ascending or descending)","default":"desc"},"with_archived":{"type":"boolean","title":"With Archived","description":"Include archived datasets in the response","default":false},"only_archived":{"type":"boolean","title":"Only Archived","description":"Include only archived datasets in the response","default":false}},"type":"object","title":"DatasetSearchParams"},"DatasetTag":{"properties":{"key":{"type":"string","title":"Key"},"value":{"type":"string","title":"Value"}},"type":"object","required":["key","value"],"title":"DatasetTag"},"DatasetUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Name","default":"NOT_SET"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"schema":{"anyOf":[{"$ref":"#/components/schemas/SchemaUpdate"},{"type":"null"}]}},"additionalProperties":false,"type":"object","title":"DatasetUpdate"},"EnrichmentEvent":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"agent_id":{"type":"string","title":"Agent Id"},"tenant_id":{"type":"string","title":"Tenant Id"},"dataset_id":{"type":"string","title":"Dataset Id"},"message_id":{"type":"string","title":"Message Id"},"question":{"type":"string","title":"Question"},"answer":{"type":"string","title":"Answer"},"question_timestamp":{"type":"string","format":"date-time","title":"Question Timestamp"},"answer_timestamp":{"type":"string","format":"date-time","title":"Answer Timestamp"},"response_time_seconds":{"type":"number","title":"Response Time Seconds"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"is_guardrails_violated":{"type":"boolean","title":"Is Guardrails Violated","default":false},"violated_guardrails":{"type":"string","title":"Violated Guardrails","default":"[]"},"context_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context Id"}},"type":"object","required":["agent_id","tenant_id","dataset_id","message_id","question","answer","question_timestamp","answer_timestamp","response_time_seconds"],"title":"EnrichmentEvent"},"EventFeedback":{"properties":{"id":{"type":"string","title":"Id"},"tenant_id":{"type":"string","title":"Tenant Id"},"event_type":{"$ref":"#/components/schemas/EventType"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"data":{"$ref":"#/components/schemas/EventFeedbackData"}},"type":"object","required":["id","tenant_id","event_type","timestamp","data"],"title":"EventFeedback"},"EventFeedbackData":{"properties":{"answer_id":{"type":"string","format":"uuid","title":"Answer Id"},"question":{"type":"string","title":"Question"},"answer":{"type":"string","title":"Answer"},"is_positive":{"type":"boolean","title":"Is Positive"},"negative_feedback_category_harmful":{"type":"boolean","title":"Negative Feedback Category Harmful"},"negative_feedback_category_untrue":{"type":"boolean","title":"Negative Feedback Category Untrue"},"negative_feedback_category_unhelpful":{"type":"boolean","title":"Negative Feedback Category Unhelpful"},"negative_feedback_category_other":{"type":"boolean","title":"Negative Feedback Category Other"},"feedback_description":{"type":"string","title":"Feedback Description"},"agent_id":{"type":"string","title":"Agent Id"}},"type":"object","required":["answer_id","question","answer","is_positive","negative_feedback_category_harmful","negative_feedback_category_untrue","negative_feedback_category_unhelpful","negative_feedback_category_other","feedback_description"],"title":"EventFeedbackData"},"EventType":{"type":"string","enum":["FAILED_DATA_DELIVERY","APPLICATION_FEEDBACK"],"title":"EventType"},"GetMediaRequest":{"properties":{"dataset_id":{"type":"string","title":"Dataset Id","description":"Dataset that owns the images"},"image_id":{"type":"string","title":"Image Id","description":"Image UUID to retrieve"},"thumbnail":{"type":"boolean","title":"Thumbnail","description":"When true, return a down-scaled thumbnail instead of the full image","default":false}},"type":"object","required":["dataset_id","image_id"],"title":"GetMediaRequest","description":"Request body for the get-media endpoint."},"ModelCreate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["name"],"title":"ModelCreate"},"ModelFullResponse":{"properties":{"id":{"type":"string","title":"Id"},"_id":{"type":"string","format":"uuid4","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_by":{"type":"string","title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"datasets":{"items":{"$ref":"#/components/schemas/DatasetResponse"},"type":"array","title":"Datasets"}},"type":"object","required":["id","_id","name","created_by","created_at","updated_at","datasets"],"title":"ModelFullResponse"},"ModelResponse":{"properties":{"id":{"type":"string","title":"Id"},"_id":{"type":"string","format":"uuid4","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_by":{"type":"string","title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","_id","name","created_by","created_at","updated_at"],"title":"ModelResponse"},"ModelUpdate":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"ModelUpdate"},"Page_DatasetResponse_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DatasetResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DatasetResponse]Customized"},"Page_ModelFullResponse_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ModelFullResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[ModelFullResponse]Customized"},"Page_ModelResponse_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ModelResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[ModelResponse]Customized"},"RecordLogMessage":{"properties":{"record":{"additionalProperties":true,"type":"object","title":"Record"}},"type":"object","required":["record"],"title":"RecordLogMessage"},"Schema-Input":{"properties":{"fields":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/SchemaItem"},"type":"object"},{"type":"null"}],"title":"Fields"},"key_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Field"}},"type":"object","title":"Schema"},"Schema-Output":{"properties":{"fields":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/SchemaItem"},"type":"object"},{"type":"null"}],"title":"Fields"},"key_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Field"}},"type":"object","title":"Schema"},"SchemaItem":{"properties":{"type":{"$ref":"#/components/schemas/Type"},"default_value":{"title":"Default Value"}},"type":"object","required":["type"],"title":"SchemaItem"},"SchemaUpdate":{"properties":{"fields":{"anyOf":[{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/SchemaUpdateItem"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Fields"},"key_field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Field"}},"type":"object","title":"SchemaUpdate"},"SchemaUpdateItem":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"anyOf":[{"$ref":"#/components/schemas/Type"},{"type":"null"}]},"default_value":{"title":"Default Value"}},"additionalProperties":false,"type":"object","title":"SchemaUpdateItem"},"Type":{"type":"string","enum":["numeric","string","boolean","datetime","date","json","image","image_link"],"title":"Type"},"Dashboard":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","maxLength":100,"minLength":1,"title":"name"},"created_by":{"type":"string","title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"positions":{"additionalProperties":{"$ref":"#/components/schemas/WidgetMeta"},"propertyNames":{"format":"uuid"},"type":"object","title":"Positions"},"tags":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Tags"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","name","created_by","created_at","updated_at","positions"],"title":"Dashboard"},"DashboardBulkActionRequest":{"properties":{"action":{"$ref":"#/components/schemas/DashboardBulkActionType","description":"The action to perform on the dashboards"},"ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":50,"minItems":1,"title":"Ids","description":"List of dashboard IDs to perform the action on"}},"type":"object","required":["action","ids"],"title":"DashboardBulkActionRequest"},"DashboardBulkActionType":{"type":"string","enum":["delete","archive"],"title":"DashboardBulkActionType"},"DashboardCreate":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"name"}},"type":"object","required":["name"],"title":"DashboardCreate"},"DashboardItem":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","maxLength":50,"minLength":1,"title":"name"},"query_type":{"$ref":"#/components/schemas/QueryType"},"datasource":{"$ref":"#/components/schemas/Datasource"},"data_config":{"anyOf":[{"$ref":"#/components/schemas/DataConfigGeneral-Output"},{"$ref":"#/components/schemas/DataConfigDistributionCompare-Output"}],"title":"Data Config"},"created_by":{"type":"string","title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"dashboard_id":{"type":"string","format":"uuid","title":"Dashboard Id"},"item_metadata":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object","title":"Item Metadata"}},"type":"object","required":["id","name","query_type","datasource","data_config","created_by","created_at","updated_at","dashboard_id","item_metadata"],"title":"DashboardItem"},"DashboardItemCreate":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"name"},"query_type":{"$ref":"#/components/schemas/QueryType"},"datasource":{"$ref":"#/components/schemas/Datasource"},"data_config":{"anyOf":[{"$ref":"#/components/schemas/DataConfigGeneral-Input"},{"$ref":"#/components/schemas/DataConfigDistributionCompare-Input"}],"title":"Data Config"},"dashboard_id":{"type":"string","format":"uuid","title":"Dashboard Id"},"item_metadata":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object","title":"Item Metadata"},"visualization_type":{"$ref":"#/components/schemas/VisualizationType"}},"type":"object","required":["name","query_type","datasource","data_config","dashboard_id","item_metadata","visualization_type"],"title":"DashboardItemCreate"},"DashboardItemDistributionCompareQuery-Input":{"properties":{"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"order":{"anyOf":[{"items":{"items":{},"type":"array"},"type":"array"},{"items":{},"type":"array"},{"type":"null"}],"title":"Order"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"UTC"},"filters":{"items":{"$ref":"#/components/schemas/Filter"},"type":"array","title":"Filters"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"timeDimensions":{"items":{"$ref":"#/components/schemas/TimeDimension"},"type":"array","title":"Timedimensions"}},"type":"object","required":["measures"],"title":"DashboardItemBaseQuery"},"DashboardItemDistributionCompareQuery-Output":{"properties":{"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"order":{"anyOf":[{"items":{"items":{},"type":"array"},"type":"array"},{"items":{},"type":"array"},{"type":"null"}],"title":"Order"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"UTC"},"filters":{"items":{"$ref":"#/components/schemas/Filter"},"type":"array","title":"Filters"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"},"timeDimensions":{"items":{"$ref":"#/components/schemas/TimeDimension"},"type":"array","title":"Timedimensions"}},"type":"object","required":["measures"],"title":"DashboardItemBaseQuery"},"DashboardItemQuery-Input":{"properties":{"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"order":{"anyOf":[{"items":{"items":{},"type":"array"},"type":"array"},{"items":{},"type":"array"},{"type":"null"}],"title":"Order"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"UTC"},"filters":{"items":{"$ref":"#/components/schemas/Filter"},"type":"array","title":"Filters"},"limit":{"type":"integer","title":"Limit"},"timeDimensions":{"items":{"$ref":"#/components/schemas/TimeDimension"},"type":"array","title":"Timedimensions"}},"type":"object","required":["measures","limit"],"title":"DashboardItemBaseQuery","example":{"dimensions":["Orders.status"],"filters":[{"dimension":"Orders.status","operator":"equals","values":["processing"]}],"measures":["Orders.count"],"order":[{"desc":true,"id":"Orders.count"}],"timeDimensions":[{"dateRange":["2024-01-01","2024-12-31"],"dimension":"Orders.time","granularity":"month"}],"timezone":"UTC"}},"DashboardItemQuery-Output":{"properties":{"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"order":{"anyOf":[{"items":{"items":{},"type":"array"},"type":"array"},{"items":{},"type":"array"},{"type":"null"}],"title":"Order"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"UTC"},"filters":{"items":{"$ref":"#/components/schemas/Filter"},"type":"array","title":"Filters"},"limit":{"type":"integer","title":"Limit"},"timeDimensions":{"items":{"$ref":"#/components/schemas/TimeDimension"},"type":"array","title":"Timedimensions"}},"type":"object","required":["measures","limit"],"title":"DashboardItemBaseQuery","example":{"dimensions":["Orders.status"],"filters":[{"dimension":"Orders.status","operator":"equals","values":["processing"]}],"measures":["Orders.count"],"order":[{"desc":true,"id":"Orders.count"}],"timeDimensions":[{"dateRange":["2024-01-01","2024-12-31"],"dimension":"Orders.time","granularity":"month"}],"timezone":"UTC"}},"DashboardItemUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":50,"minLength":1},{"type":"null"}],"title":"name"},"query_type":{"anyOf":[{"$ref":"#/components/schemas/QueryType"},{"type":"null"}]},"datasource":{"anyOf":[{"$ref":"#/components/schemas/Datasource"},{"type":"null"}]},"data_config":{"anyOf":[{"$ref":"#/components/schemas/DataConfigGeneral-Input"},{"$ref":"#/components/schemas/DataConfigDistributionCompare-Input"},{"type":"null"}],"title":"Data Config"},"item_metadata":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}]},"type":"object"},{"type":"null"}],"title":"Item Metadata"},"visualization_type":{"anyOf":[{"$ref":"#/components/schemas/VisualizationType"},{"type":"null"}]}},"type":"object","required":["name"],"title":"DashboardItemUpdate"},"DashboardSearchParams":{"properties":{"filters":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Filters","description":"Filter on db columns","examples":[["name","eq","active"],[["id","eq","5c05dc9f-f04a-4ce8-9d57-2ec63ee76aac"],"and",["description","ilike","Construction"]]]},"search":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Search","description":"Free text search on searchable fields"},"sort_by":{"type":"string","enum":["id","name","status","updated_at","created_at"],"title":"Sort By","description":"Field to sort by","default":"updated_at"},"sort_direction":{"type":"string","enum":["asc","desc"],"title":"Sort Direction","description":"Sort direction (ascending or descending)","default":"desc"},"only_archived":{"type":"boolean","title":"Only Archived","description":"Include only archived dashboards","default":false}},"type":"object","title":"DashboardSearchParams"},"DashboardUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"name"},"positions":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/WidgetMeta"},"propertyNames":{"format":"uuid"},"type":"object"},{"type":"null"}],"title":"Positions"}},"type":"object","title":"DashboardUpdate"},"DataConfigDistributionCompare-Input":{"properties":{"type":{"type":"string","const":"distribution_compare","title":"Type","default":"distribution_compare"},"query_a":{"$ref":"#/components/schemas/DashboardItemDistributionCompareQuery-Input"},"query_b":{"$ref":"#/components/schemas/DashboardItemDistributionCompareQuery-Input"},"distance_function":{"anyOf":[{"$ref":"#/components/schemas/DistanceFunction"},{"type":"null"}]}},"type":"object","required":["query_a","query_b"],"title":"DataConfigDistributionCompare"},"DataConfigDistributionCompare-Output":{"properties":{"type":{"type":"string","const":"distribution_compare","title":"Type","default":"distribution_compare"},"query_a":{"$ref":"#/components/schemas/DashboardItemDistributionCompareQuery-Output"},"query_b":{"$ref":"#/components/schemas/DashboardItemDistributionCompareQuery-Output"},"distance_function":{"anyOf":[{"$ref":"#/components/schemas/DistanceFunction"},{"type":"null"}]}},"type":"object","required":["query_a","query_b"],"title":"DataConfigDistributionCompare"},"DataConfigGeneral-Input":{"properties":{"type":{"type":"string","const":"general","title":"Type","default":"general"},"query":{"$ref":"#/components/schemas/DashboardItemQuery-Input"}},"type":"object","required":["query"],"title":"DataConfigGeneral"},"DataConfigGeneral-Output":{"properties":{"type":{"type":"string","const":"general","title":"Type","default":"general"},"query":{"$ref":"#/components/schemas/DashboardItemQuery-Output"}},"type":"object","required":["query"],"title":"DataConfigGeneral"},"Datasource":{"type":"string","enum":["datasets","events"],"title":"Datasource"},"DistanceFunction":{"type":"string","enum":["wasserstein_distance","jensen_shannon_divergence"],"title":"DistanceFunction"},"Filter":{"properties":{"member":{"type":"string","title":"Member"},"operator":{"type":"string","title":"Operator"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"},{"type":"null"}],"title":"Values"}},"type":"object","required":["member","operator"],"title":"DashboardItemQueryFilter"},"Granularity":{"type":"string","enum":["minute","hour","day","week","month","quarter","year"],"title":"Granularity"},"Page_DashboardItem_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DashboardItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DashboardItem]Customized"},"Page_Dashboard_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Dashboard"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Dashboard]Customized"},"QueryType":{"type":"string","enum":["raw_data","statistics","time_series","distribution"],"title":"QueryType"},"TimeDimension":{"properties":{"dimension":{"type":"string","title":"Dimension"},"granularity":{"$ref":"#/components/schemas/Granularity"}},"type":"object","required":["dimension","granularity"],"title":"DashboardItemQueryTimeDimension"},"VisualizationType":{"type":"string","enum":["table","line_graph","bar_plot","time_series","histogram","query_value"],"title":"VisualizationType"},"WidgetMeta":{"properties":{"visualization_type":{"$ref":"#/components/schemas/VisualizationType"},"x_pos":{"type":"integer","title":"X Pos"},"y_pos":{"type":"integer","title":"Y Pos"},"height":{"type":"integer","title":"Height","default":0},"width":{"type":"integer","title":"Width","default":0}},"type":"object","required":["visualization_type","x_pos","y_pos"],"title":"WidgetMeta"},"Agent":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"last_interaction_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Interaction At"},"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"dataset_id":{"type":"string","title":"Dataset Id"},"observability_enabled":{"type":"boolean","title":"Observability Enabled","default":true},"guardrails_violation_message":{"type":"string","title":"Guardrails Violation Message"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"status":{"$ref":"#/components/schemas/AgentStatus","default":"unknown"},"api_token":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Api Token"},"tags":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Tags"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","created_by","name","dataset_id","guardrails_violation_message","url","api_token"],"title":"Agent"},"AgentBulkActionRequest":{"properties":{"action":{"$ref":"#/components/schemas/AgentBulkActionType","description":"The action to perform on the agents"},"ids":{"items":{"type":"string","format":"uuid4"},"type":"array","maxItems":50,"minItems":1,"title":"Ids","description":"List of agent IDs to perform the action on"}},"type":"object","required":["action","ids"],"title":"AgentBulkActionRequest"},"AgentBulkActionType":{"type":"string","enum":["delete","archive","activate","deactivate"],"title":"AgentBulkActionType"},"AgentCreatePayload":{"properties":{"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"authentication_enabled":{"type":"boolean","title":"Authentication Enabled","default":false},"observability_enabled":{"type":"boolean","title":"Observability Enabled","default":true},"guardrails_violation_message":{"type":"string","title":"Guardrails Violation Message","description":"Message to display on violation of guardrails.","default":"Attention: Your message has been blocked due to a guardrail violation. Please rephrase your message and try again."}},"type":"object","required":["name"],"title":"AgentCreatePayload"},"AgentPatchPayload":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":95},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"authentication_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Authentication Enabled"},"observability_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Observability Enabled"},"guardrails_violation_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Guardrails Violation Message"},"dataset_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Dataset Id"}},"type":"object","title":"AgentPatchPayload"},"AgentStatus":{"type":"string","enum":["healthy","unhealthy","unknown","degraded","updating"],"title":"AgentStatus"},"AskRequestPayload":{"properties":{"input":{"type":"string","maxLength":50000,"title":"Input","description":"The user's current message or question to the AI agent."},"chat_history":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChatHistoryEntry"},"type":"array"},{"type":"null"}],"title":"Chat History","description":"The existing conversation history with the AI agent."},"context_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context Id","description":"Optional context ID string for tracking conversation context."},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Optional metadata for the request. For example, the user's ID, the session ID, etc. Used for enrichment."}},"type":"object","required":["input"],"title":"AskRequestPayload","example":{"chat_history":[{"message":"Tell me about landmarks in Paris.","role":"human"},{"message":"Paris is home to many famous landmarks, including the Eiffel Tower, Louvre Museum, and Notre-Dame Cathedral.","role":"ai"}],"context_id":"user-session-12345","input":"When was the Eiffel Tower built?"}},"AskResponsePayload":{"properties":{"output":{"type":"string","title":"Output","description":"The AI agent's response to the user's inquiry."},"metadata":{"$ref":"#/components/schemas/ResponseMetadata","description":"The metadata associated with the response."}},"additionalProperties":false,"type":"object","required":["output"],"title":"AskResponsePayload","example":{"output":"The Eiffel Tower was constructed from 1887 to 1889."}},"BasicLLMConfig":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"type":{"type":"string","const":"BasicLLM","title":"Type","default":"BasicLLM"},"framework":{"type":"string","const":"Superwise","title":"Framework","default":"Superwise"},"model":{"$ref":"#/components/schemas/ModelLLM"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"}},"type":"object","required":["model"],"title":"BasicLLMConfig"},"BearerAuthenticationConfig":{"properties":{"type":{"type":"string","const":"Bearer","title":"Type"},"token":{"type":"string","title":"Token"}},"type":"object","required":["type","token"],"title":"BearerAuthenticationConfig"},"Body_upload_files":{"properties":{"files":{"items":{"type":"string","format":"binary"},"type":"array","title":"Files"}},"type":"object","required":["files"],"title":"Body_upload_files"},"ChatHistoryEntry":{"properties":{"role":{"$ref":"#/components/schemas/Role","description":"The role can be either 'human' or 'ai'."},"message":{"type":"string","title":"Message","description":"The message content."}},"type":"object","required":["role","message"],"title":"ChatHistoryEntry","example":{"message":"Tell me about landmarks in Paris.","role":"human"}},"ContextChainConfig-Input":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"type":{"type":"string","const":"AIAssistant","title":"Type","default":"AIAssistant"},"framework":{"type":"string","const":"Superwise","title":"Framework","default":"Superwise"},"model":{"$ref":"#/components/schemas/ModelLLM"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"context":{"anyOf":[{"$ref":"#/components/schemas/ContextDef-Input"},{"type":"null"}]}},"type":"object","required":["model"],"title":"ContextChainConfig"},"ContextChainConfig-Output":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"type":{"type":"string","const":"AIAssistant","title":"Type","default":"AIAssistant"},"framework":{"type":"string","const":"Superwise","title":"Framework","default":"Superwise"},"model":{"$ref":"#/components/schemas/ModelLLM"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"context":{"anyOf":[{"$ref":"#/components/schemas/ContextDef-Output"},{"type":"null"}]}},"type":"object","required":["model"],"title":"ContextChainConfig"},"ContextDef-Input":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"config":{"oneOf":[{"$ref":"#/components/schemas/ToolConfigKnowledge"},{"$ref":"#/components/schemas/ToolConfigPGVector"},{"$ref":"#/components/schemas/ToolConfigPineconeVectorDB"},{"$ref":"#/components/schemas/ToolConfigSQLDatabasePostgres"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMySQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMSSQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseOracle"},{"$ref":"#/components/schemas/ToolConfigBigQuery"}],"title":"Config","discriminator":{"propertyName":"type","mapping":{"BigQuery":"#/components/schemas/ToolConfigBigQuery","Knowledge":"#/components/schemas/ToolConfigKnowledge","MSSQL":"#/components/schemas/ToolConfigSQLDatabaseMSSQL","MySQL":"#/components/schemas/ToolConfigSQLDatabaseMySQL","Oracle":"#/components/schemas/ToolConfigSQLDatabaseOracle","PGVector":"#/components/schemas/ToolConfigPGVector","Pinecone":"#/components/schemas/ToolConfigPineconeVectorDB","PostgreSQL":"#/components/schemas/ToolConfigSQLDatabasePostgres"}}}},"type":"object","required":["name","config"],"title":"ContextDef"},"ContextDef-Output":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"config":{"oneOf":[{"$ref":"#/components/schemas/ToolConfigKnowledge"},{"$ref":"#/components/schemas/ToolConfigPGVector"},{"$ref":"#/components/schemas/ToolConfigPineconeVectorDB"},{"$ref":"#/components/schemas/ToolConfigSQLDatabasePostgres"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMySQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMSSQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseOracle"},{"$ref":"#/components/schemas/ToolConfigBigQuery"}],"title":"Config","discriminator":{"propertyName":"type","mapping":{"BigQuery":"#/components/schemas/ToolConfigBigQuery","Knowledge":"#/components/schemas/ToolConfigKnowledge","MSSQL":"#/components/schemas/ToolConfigSQLDatabaseMSSQL","MySQL":"#/components/schemas/ToolConfigSQLDatabaseMySQL","Oracle":"#/components/schemas/ToolConfigSQLDatabaseOracle","PGVector":"#/components/schemas/ToolConfigPGVector","Pinecone":"#/components/schemas/ToolConfigPineconeVectorDB","PostgreSQL":"#/components/schemas/ToolConfigSQLDatabasePostgres"}}}},"type":"object","required":["name","config"],"title":"ContextDef"},"DatasetPayload":{"properties":{"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"}},"type":"object","required":["name"],"title":"DatasetPayload"},"DebugMetadata":{"properties":{"question":{"type":"string","title":"Question"},"answer":{"type":"string","title":"Answer"},"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"type":"string","format":"date-time","title":"End Time"},"intermediate_steps":{"items":{"$ref":"#/components/schemas/IntermediateStep"},"type":"array","title":"Intermediate Steps"}},"type":"object","required":["question","answer","start_time","end_time","intermediate_steps"],"title":"DebugMetadata"},"EmbeddingModel":{"properties":{"provider_id":{"type":"string","title":"Provider Id"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"}},"type":"object","required":["provider_id"],"title":"EmbeddingModel"},"FileInfo":{"properties":{"filename":{"type":"string","title":"Filename"},"content_type":{"$ref":"#/components/schemas/SupportedContentType"},"size":{"type":"integer","title":"Size"},"id":{"type":"string","format":"uuid4","title":"Id"}},"type":"object","required":["filename","content_type","size","id"],"title":"FileInfo"},"FileKnowledgeMetadata":{"properties":{"type":{"type":"string","const":"file","title":"Type","default":"file"},"file_ids":{"items":{"type":"string"},"type":"array","minItems":1,"title":"File Ids"}},"type":"object","required":["file_ids"],"title":"FileKnowledgeMetadata"},"FileUploadResponse":{"properties":{"status":{"$ref":"#/components/schemas/UploadStatus"},"file_info":{"anyOf":[{"$ref":"#/components/schemas/FileInfo"},{"type":"null"}]}},"type":"object","required":["status"],"title":"FileUploadResponse"},"FlowiseCreationCredential":{"properties":{"name":{"type":"string","title":"Name"},"credentialName":{"type":"string","title":"Credentialname"},"plainDataObj":{"additionalProperties":{"type":"string"},"type":"object","title":"Plaindataobj"}},"type":"object","required":["name","credentialName","plainDataObj"],"title":"FlowiseCreationCredential"},"FlowiseCredentialUserInput":{"additionalProperties":{"$ref":"#/components/schemas/FlowiseCreationCredential"},"type":"object","title":"FlowiseCredentialUserInput"},"FlowiseGetCredentialSchema":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"framework":{"type":"string","const":"Flowise","title":"Framework","default":"Flowise"},"type":{"type":"string","const":"Flowise","title":"Type","default":"Flowise"},"flow_id":{"type":"string","title":"Flow Id"},"url":{"type":"string","title":"Url"},"api_key":{"type":"string","title":"Api Key"}},"type":"object","required":["flow_id","url","api_key"],"title":"FlowiseGetCredentialSchema"},"FlowiseStrictConfig-Input":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"framework":{"type":"string","const":"Flowise","title":"Framework","default":"Flowise"},"type":{"type":"string","const":"Flowise","title":"Type","default":"Flowise"},"flow_id":{"type":"string","title":"Flow Id"},"url":{"type":"string","title":"Url"},"api_key":{"type":"string","title":"Api Key"},"flowise_credentials":{"$ref":"#/components/schemas/FlowiseCredentialUserInput"}},"type":"object","required":["flow_id","url","api_key"],"title":"FlowiseStrictConfig"},"FlowiseStrictConfig-Output":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"framework":{"type":"string","const":"Flowise","title":"Framework","default":"Flowise"},"type":{"type":"string","const":"Flowise","title":"Type","default":"Flowise"},"flow_id":{"type":"string","title":"Flow Id"},"url":{"type":"string","title":"Url"},"api_key":{"type":"string","title":"Api Key"},"flowise_credentials":{"$ref":"#/components/schemas/FlowiseCredentialUserInput"}},"type":"object","required":["flow_id","url","api_key"],"title":"FlowiseStrictConfig"},"GuardRailsViolation":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"message":{"type":"string","title":"Message"}},"type":"object","required":["name","type","message"],"title":"GuardRailsViolation"},"GuardrailConfig":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"should_block":{"type":"boolean","title":"Should Block"}},"type":"object","required":["id","should_block"],"title":"GuardrailConfig"},"IntermediateStep":{"properties":{"start_time":{"type":"string","format":"date-time","title":"Start Time"},"end_time":{"type":"string","format":"date-time","title":"End Time"},"input_data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Data"},"output_data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output Data"}},"type":"object","required":["input_data","output_data"],"title":"IntermediateStep"},"Knowledge":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"knowledge_metadata":{"oneOf":[{"$ref":"#/components/schemas/UrlKnowledgeMetadata"},{"$ref":"#/components/schemas/FileKnowledgeMetadata"}],"title":"Knowledge Metadata","discriminator":{"propertyName":"type","mapping":{"file":"#/components/schemas/FileKnowledgeMetadata","url":"#/components/schemas/UrlKnowledgeMetadata"}}},"embedding_model":{"$ref":"#/components/schemas/EmbeddingModel"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"indexed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Indexed At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"}},"type":"object","required":["id","name","knowledge_metadata","embedding_model","created_by"],"title":"Knowledge"},"KnowledgeCreatePayload":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"knowledge_metadata":{"oneOf":[{"$ref":"#/components/schemas/UrlKnowledgeMetadata"},{"$ref":"#/components/schemas/FileKnowledgeMetadata"}],"title":"Knowledge Metadata","discriminator":{"propertyName":"type","mapping":{"file":"#/components/schemas/FileKnowledgeMetadata","url":"#/components/schemas/UrlKnowledgeMetadata"}}},"embedding_model":{"$ref":"#/components/schemas/EmbeddingModel"}},"type":"object","required":["name","knowledge_metadata","embedding_model"],"title":"KnowledgeCreatePayload"},"KnowledgeUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":50,"minLength":1},{"type":"null"}],"title":"name"}},"type":"object","required":["name"],"title":"KnowledgeUpdate"},"MCP":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"MCP name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"url":{"type":"string","minLength":1,"title":"Url","description":"MCP server URL"},"network_access":{"type":"string","const":"remote","title":"Network Access","description":"Network access level","default":"remote"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Authentication headers"},"params":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Params","description":"Additional query parameters"},"id":{"type":"string","format":"uuid","title":"Id","description":"MCP entity ID"},"created_by":{"type":"string","title":"Created By","description":"User ID"},"tool_schemas":{"additionalProperties":{"$ref":"#/components/schemas/MCPToolSchema"},"type":"object","title":"Tool Schemas","description":"Cached schemas from MCP server"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Creation timestamp"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Last update timestamp"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"Soft delete timestamp"}},"type":"object","required":["name","url","id","created_by","tool_schemas"],"title":"MCP","description":"Schema for MCP entity responses."},"MCPBase":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"MCP name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"url":{"type":"string","minLength":1,"title":"Url","description":"MCP server URL"},"network_access":{"type":"string","const":"remote","title":"Network Access","description":"Network access level","default":"remote"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Authentication headers"},"params":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Params","description":"Additional query parameters"}},"type":"object","required":["name","url"],"title":"MCPBase","description":"Base MCP schema with common fields."},"MCPTestRequest":{"properties":{"url":{"type":"string","minLength":1,"title":"Url","description":"MCP server URL to test"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Optional authentication headers"}},"type":"object","required":["url"],"title":"MCPTestRequest","description":"Request schema for MCP connectivity test."},"MCPTestResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Whether the connectivity test succeeded"},"message":{"type":"string","title":"Message","description":"Test result message"},"tools_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tools Count","description":"Number of available tools if test succeeded"},"tools":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/MCPToolSchema"},"type":"object"},{"type":"null"}],"title":"Tools","description":"Full tool schemas from MCP server (only present on success)"}},"type":"object","required":["success","message"],"title":"MCPTestResponse","description":"Response schema for MCP connectivity test."},"MCPToolSchema":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"inputSchema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Inputschema"},"annotations":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Annotations"}},"type":"object","required":["name"],"title":"MCPToolSchema","description":"Minimal MCP tool schema for StructuredTool conversion"},"MCPUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"MCP name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"additionalProperties":false,"type":"object","title":"MCPUpdate","description":"Schema for updating an MCP entity - only name can be updated."},"ModelLLM":{"properties":{"provider_id":{"type":"string","title":"Provider Id"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters"}},"type":"object","required":["provider_id"],"title":"ModelLLM"},"ModelStatus":{"properties":{"total_budget":{"type":"number","title":"Total Budget"},"budget_spent":{"type":"number","title":"Budget Spent"},"budget_reset_at":{"type":"string","format":"date-time","title":"Budget Reset At"}},"type":"object","required":["total_budget","budget_spent","budget_reset_at"],"title":"ModelStatus"},"Page_Agent_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Agent"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[Agent]Customized"},"Page_Knowledge_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Knowledge"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[Knowledge]Customized"},"Page_MCP_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MCP"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[MCP]Customized"},"PlaygroundAskProxyRequestPayload":{"properties":{"input":{"type":"string","maxLength":50000,"title":"Input","description":"The user's current message or question to the AI agent."},"chat_history":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChatHistoryEntry"},"type":"array"},{"type":"null"}],"title":"Chat History","description":"The existing conversation history with the AI agent."},"context_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context Id","description":"Optional context ID string for tracking conversation context."},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Optional metadata for the request. For example, the user's ID, the session ID, etc. Used for enrichment."},"config":{"oneOf":[{"$ref":"#/components/schemas/ReactAgentConfig-Input"},{"$ref":"#/components/schemas/ContextChainConfig-Input"},{"$ref":"#/components/schemas/BasicLLMConfig"},{"$ref":"#/components/schemas/FlowiseStrictConfig-Input"}],"title":"Config","description":"The agent configuration.","discriminator":{"propertyName":"type","mapping":{"AIAssistant":"#/components/schemas/ContextChainConfig-Input","BasicLLM":"#/components/schemas/BasicLLMConfig","Flowise":"#/components/schemas/FlowiseStrictConfig-Input","ReactAgent":"#/components/schemas/ReactAgentConfig-Input"}}},"guardrails":{"items":{"$ref":"#/components/schemas/GuardrailConfig"},"type":"array","title":"Guardrails","description":"Guardrails to apply to this conversation."},"guardrails_violation_message":{"type":"string","title":"Guardrails Violation Message","description":"Message to display on violation of guardrails.","default":"Attention: Your message has been blocked due to a guardrail violation. Please rephrase your message and try again."}},"type":"object","required":["input","config"],"title":"PlaygroundAskProxyRequestPayload","example":{"chat_history":[{"message":"Tell me about landmarks in Paris.","role":"human"},{"message":"Paris is home to many famous landmarks, including the Eiffel Tower, Louvre Museum, and Notre-Dame Cathedral.","role":"ai"}],"context_id":"user-session-12345","input":"When was the Eiffel Tower built?"}},"ProviderConfig":{"properties":{"provider":{"type":"string","title":"Provider"},"versions":{"items":{"type":"string"},"type":"array","title":"Versions"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters"}},"type":"object","required":["provider","versions","parameters"],"title":"ProviderConfig"},"ReactAgentConfig-Input":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"type":{"type":"string","const":"ReactAgent","title":"Type","default":"ReactAgent"},"framework":{"type":"string","const":"Superwise","title":"Framework","default":"Superwise"},"model":{"$ref":"#/components/schemas/ModelLLM"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"tools":{"items":{"$ref":"#/components/schemas/ToolDef-Input"},"type":"array","title":"Tools"}},"type":"object","required":["model","tools"],"title":"ReactAgentConfig"},"ReactAgentConfig-Output":{"properties":{"show_cites":{"type":"boolean","title":"Show Cites","default":false},"type":{"type":"string","const":"ReactAgent","title":"Type","default":"ReactAgent"},"framework":{"type":"string","const":"Superwise","title":"Framework","default":"Superwise"},"model":{"$ref":"#/components/schemas/ModelLLM"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"tools":{"items":{"$ref":"#/components/schemas/ToolDef-Output"},"type":"array","title":"Tools"}},"type":"object","required":["model","tools"],"title":"ReactAgentConfig"},"ResponseMetadata":{"properties":{"cite_sources":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"array"},{"type":"null"}],"title":"Cite Sources","description":"The sources cited in the response."},"debug_metadata":{"anyOf":[{"$ref":"#/components/schemas/DebugMetadata"},{"type":"null"}],"description":"Debug metadata associated with the response if applicable."},"guardrails_violations":{"items":{"$ref":"#/components/schemas/GuardRailsViolation"},"type":"array","title":"Guardrails Violations","description":"The guardrails violated in the response."},"is_guardrails_violated":{"type":"boolean","title":"Is Guardrails Violated","description":"Whether the response violates any guardrails.","default":false}},"additionalProperties":false,"type":"object","title":"ResponseMetadata","example":{"cite_sources":["www.wikipedia.com","www.britannica.com"]}},"Role":{"type":"string","enum":["human","ai"],"title":"Role"},"StreamEventType":{"type":"string","enum":["system","guardrails","llm","tool","error","response","internal","guardrail_violation","llm_error"],"title":"StreamEventType","description":"Event types for streamed responses."},"StreamedResponse":{"properties":{"event":{"$ref":"#/components/schemas/StreamEventType"},"text":{"type":"string","title":"Text"},"event_subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Subtype"}},"type":"object","required":["event","text"],"title":"StreamedResponse"},"SupportedContentType":{"type":"string","enum":["application/pdf","text/plain"],"title":"SupportedContentType"},"ToolConfigBigQuery":{"properties":{"type":{"type":"string","const":"BigQuery","title":"Type","default":"BigQuery"},"config_metadata":{"anyOf":[{"$ref":"#/components/schemas/ToolConfigSQLMetadata"},{"type":"null"}]},"project_id":{"type":"string","title":"Project Id"},"dataset_id":{"type":"string","title":"Dataset Id"},"service_account":{"additionalProperties":{"type":"string"},"type":"object","title":"Service Account"}},"type":"object","required":["project_id","dataset_id","service_account"],"title":"ToolConfigBigQuery"},"ToolConfigKnowledge":{"properties":{"type":{"type":"string","const":"Knowledge","title":"Type","default":"Knowledge"},"knowledge_id":{"type":"string","title":"Knowledge Id"},"knowledge_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/UrlKnowledgeMetadata"},{"$ref":"#/components/schemas/FileKnowledgeMetadata"}],"discriminator":{"propertyName":"type","mapping":{"file":"#/components/schemas/FileKnowledgeMetadata","url":"#/components/schemas/UrlKnowledgeMetadata"}}},{"type":"null"}],"title":"Knowledge Metadata","hidden":true},"embedding_model":{"anyOf":[{"$ref":"#/components/schemas/EmbeddingModel"},{"type":"null"}],"hidden":true}},"type":"object","required":["knowledge_id"],"title":"ToolConfigKnowledge"},"ToolConfigMCP-Input":{"properties":{"type":{"type":"string","const":"MCP","title":"Type","default":"MCP"},"transport":{"type":"string","const":"streamable_http","title":"Transport","default":"streamable_http"},"mcp_id":{"type":"string","format":"uuid4","title":"Mcp Id","description":"MCP entity ID (UUID)"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name","description":"Specific tool name to use from MCP entity"},"tool_schema":{"items":{"$ref":"#/components/schemas/MCPToolSchema"},"type":"array","minItems":1,"title":"Tool Schema","description":"Tool schema(s) from MCP entity"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"MCP server URL from MCP entity"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Headers from MCP entity"},"params":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Params","description":"Query params from MCP entity"}},"type":"object","required":["mcp_id","tool_schema"],"title":"ToolConfigMCP"},"ToolConfigMCP-Output":{"properties":{"type":{"type":"string","const":"MCP","title":"Type","default":"MCP"},"mcp_id":{"type":"string","format":"uuid4","title":"Mcp Id","description":"MCP entity ID (UUID)"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name","description":"Specific tool name to use from MCP entity"},"tool_schema":{"items":{"$ref":"#/components/schemas/MCPToolSchema"},"type":"array","minItems":1,"title":"Tool Schema","description":"Tool schema(s) from MCP entity"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"MCP server URL from MCP entity"},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","description":"Headers from MCP entity"},"params":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Params","description":"Query params from MCP entity"}},"type":"object","required":["mcp_id","tool_schema"],"title":"ToolConfigMCP"},"ToolConfigOpenAPI":{"properties":{"type":{"type":"string","const":"OpenAPI","title":"Type","default":"OpenAPI"},"openapi_schema":{"additionalProperties":true,"type":"object","title":"Openapi Schema"},"authentication":{"anyOf":[{"$ref":"#/components/schemas/BearerAuthenticationConfig"},{"type":"null"}]}},"type":"object","required":["openapi_schema"],"title":"ToolConfigOpenAPI"},"ToolConfigPGVector":{"properties":{"type":{"type":"string","const":"PGVector","title":"Type","default":"PGVector"},"connection_string":{"type":"string","title":"Connection String"},"table_name":{"type":"string","title":"Table Name"},"db_schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Db Schema"},"embedding_model":{"$ref":"#/components/schemas/EmbeddingModel"}},"type":"object","required":["connection_string","table_name","embedding_model"],"title":"ToolConfigPGVector"},"ToolConfigPineconeVectorDB":{"properties":{"type":{"type":"string","const":"Pinecone","title":"Type","default":"Pinecone"},"api_key":{"type":"string","title":"Api Key"},"index_name":{"type":"string","title":"Index Name"},"embedding_model":{"$ref":"#/components/schemas/EmbeddingModel"}},"type":"object","required":["api_key","index_name","embedding_model"],"title":"ToolConfigPineconeVectorDB"},"ToolConfigSQLDatabaseMSSQL":{"properties":{"type":{"type":"string","const":"MSSQL","title":"Type","default":"MSSQL"},"config_metadata":{"anyOf":[{"$ref":"#/components/schemas/ToolConfigSQLMetadata"},{"type":"null"}]},"connection_string":{"type":"string","pattern":"^mssql://","title":"Connection String"}},"type":"object","required":["connection_string"],"title":"ToolConfigSQLDatabaseMSSQL"},"ToolConfigSQLDatabaseMySQL":{"properties":{"type":{"type":"string","const":"MySQL","title":"Type","default":"MySQL"},"config_metadata":{"anyOf":[{"$ref":"#/components/schemas/ToolConfigSQLMetadata"},{"type":"null"}]},"connection_string":{"type":"string","pattern":"^mysql://","title":"Connection String"}},"type":"object","required":["connection_string"],"title":"ToolConfigSQLDatabaseMySQL"},"ToolConfigSQLDatabaseOracle":{"properties":{"type":{"type":"string","const":"Oracle","title":"Type","default":"Oracle"},"config_metadata":{"anyOf":[{"$ref":"#/components/schemas/ToolConfigSQLMetadata"},{"type":"null"}]},"connection_string":{"type":"string","pattern":"^oracle://","title":"Connection String"}},"type":"object","required":["connection_string"],"title":"ToolConfigSQLDatabaseOracle"},"ToolConfigSQLDatabasePostgres":{"properties":{"type":{"type":"string","const":"PostgreSQL","title":"Type","default":"PostgreSQL"},"config_metadata":{"anyOf":[{"$ref":"#/components/schemas/ToolConfigSQLMetadata"},{"type":"null"}]},"connection_string":{"type":"string","pattern":"^postgresql://","title":"Connection String"}},"type":"object","required":["connection_string"],"title":"ToolConfigSQLDatabasePostgres"},"ToolConfigSQLMetadata":{"properties":{"include_tables":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Include Tables"},"exclude_tables":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Exclude Tables"}},"type":"object","title":"ToolConfigSQLMetadata"},"ToolDef-Input":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"description":{"type":"string","title":"Description"},"config":{"oneOf":[{"$ref":"#/components/schemas/ToolConfigPGVector"},{"$ref":"#/components/schemas/ToolConfigPineconeVectorDB"},{"$ref":"#/components/schemas/ToolConfigSQLDatabasePostgres"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMySQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMSSQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseOracle"},{"$ref":"#/components/schemas/ToolConfigBigQuery"},{"$ref":"#/components/schemas/ToolConfigOpenAPI"},{"$ref":"#/components/schemas/ToolConfigMCP-Input"},{"$ref":"#/components/schemas/ToolConfigKnowledge"}],"title":"Config","discriminator":{"propertyName":"type","mapping":{"BigQuery":"#/components/schemas/ToolConfigBigQuery","Knowledge":"#/components/schemas/ToolConfigKnowledge","MCP":"#/components/schemas/ToolConfigMCP-Input","MSSQL":"#/components/schemas/ToolConfigSQLDatabaseMSSQL","MySQL":"#/components/schemas/ToolConfigSQLDatabaseMySQL","OpenAPI":"#/components/schemas/ToolConfigOpenAPI","Oracle":"#/components/schemas/ToolConfigSQLDatabaseOracle","PGVector":"#/components/schemas/ToolConfigPGVector","Pinecone":"#/components/schemas/ToolConfigPineconeVectorDB","PostgreSQL":"#/components/schemas/ToolConfigSQLDatabasePostgres"}}}},"type":"object","required":["name","description","config"],"title":"ToolDef"},"ToolDef-Output":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name"},"description":{"type":"string","title":"Description"},"config":{"oneOf":[{"$ref":"#/components/schemas/ToolConfigPGVector"},{"$ref":"#/components/schemas/ToolConfigPineconeVectorDB"},{"$ref":"#/components/schemas/ToolConfigSQLDatabasePostgres"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMySQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseMSSQL"},{"$ref":"#/components/schemas/ToolConfigSQLDatabaseOracle"},{"$ref":"#/components/schemas/ToolConfigBigQuery"},{"$ref":"#/components/schemas/ToolConfigOpenAPI"},{"$ref":"#/components/schemas/ToolConfigMCP-Output"},{"$ref":"#/components/schemas/ToolConfigKnowledge"}],"title":"Config","discriminator":{"propertyName":"type","mapping":{"BigQuery":"#/components/schemas/ToolConfigBigQuery","Knowledge":"#/components/schemas/ToolConfigKnowledge","MCP":"#/components/schemas/ToolConfigMCP-Output","MSSQL":"#/components/schemas/ToolConfigSQLDatabaseMSSQL","MySQL":"#/components/schemas/ToolConfigSQLDatabaseMySQL","OpenAPI":"#/components/schemas/ToolConfigOpenAPI","Oracle":"#/components/schemas/ToolConfigSQLDatabaseOracle","PGVector":"#/components/schemas/ToolConfigPGVector","Pinecone":"#/components/schemas/ToolConfigPineconeVectorDB","PostgreSQL":"#/components/schemas/ToolConfigSQLDatabasePostgres"}}}},"type":"object","required":["name","description","config"],"title":"ToolDef"},"UploadResponse":{"properties":{"files":{"items":{"$ref":"#/components/schemas/FileUploadResponse"},"type":"array","title":"Files"},"total_files":{"type":"integer","title":"Total Files"},"total_size":{"type":"integer","title":"Total Size"}},"type":"object","required":["files","total_files","total_size"],"title":"UploadResponse"},"UploadStatus":{"type":"string","enum":["success","file_too_large","unsupported_file_type","upload_failed"],"title":"UploadStatus"},"UrlKnowledgeMetadata":{"properties":{"type":{"type":"string","const":"url","title":"Type","default":"url"},"url":{"type":"string","title":"Url"},"max_depth":{"type":"integer","maximum":5,"minimum":1,"title":"Max Depth"}},"type":"object","required":["url","max_depth"],"title":"UrlKnowledgeMetadata"},"Version":{"properties":{"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"},"agent_config":{"oneOf":[{"$ref":"#/components/schemas/ReactAgentConfig-Output"},{"$ref":"#/components/schemas/ContextChainConfig-Output"},{"$ref":"#/components/schemas/BasicLLMConfig"},{"$ref":"#/components/schemas/FlowiseStrictConfig-Output"}],"title":"Agent Config","discriminator":{"propertyName":"type","mapping":{"AIAssistant":"#/components/schemas/ContextChainConfig-Output","BasicLLM":"#/components/schemas/BasicLLMConfig","Flowise":"#/components/schemas/FlowiseStrictConfig-Output","ReactAgent":"#/components/schemas/ReactAgentConfig-Output"}}},"guardrails":{"items":{"$ref":"#/components/schemas/GuardrailConfig"},"type":"array","title":"Guardrails"},"id":{"type":"string","format":"uuid4","title":"Id"},"agent_id":{"type":"string","format":"uuid4","title":"Agent Id"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["name","agent_config","id","agent_id","created_by"],"title":"Version"},"VersionCreatePayload":{"properties":{"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"},"agent_config":{"oneOf":[{"$ref":"#/components/schemas/ReactAgentConfig-Input"},{"$ref":"#/components/schemas/ContextChainConfig-Input"},{"$ref":"#/components/schemas/BasicLLMConfig"},{"$ref":"#/components/schemas/FlowiseStrictConfig-Input"}],"title":"Agent Config","discriminator":{"propertyName":"type","mapping":{"AIAssistant":"#/components/schemas/ContextChainConfig-Input","BasicLLM":"#/components/schemas/BasicLLMConfig","Flowise":"#/components/schemas/FlowiseStrictConfig-Input","ReactAgent":"#/components/schemas/ReactAgentConfig-Input"}}},"guardrails":{"items":{"$ref":"#/components/schemas/GuardrailConfig"},"type":"array","title":"Guardrails"}},"type":"object","required":["name","agent_config"],"title":"VersionCreatePayload"},"VersionPatchPayload":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":95},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"}},"type":"object","title":"VersionPatchPayload"},"DestinationCreateBase":{"properties":{"name":{"type":"string","maxLength":300,"minLength":1,"title":"Name"},"integration_id":{"type":"string","format":"uuid","title":"Integration Id"},"params":{"additionalProperties":true,"type":"object","title":"Params"}},"type":"object","required":["name","integration_id","params"],"title":"DestinationCreateBase"},"DestinationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"integration_id":{"type":"string","format":"uuid","title":"Integration Id"},"params":{"additionalProperties":true,"type":"object","title":"Params"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"created_by":{"type":"string","title":"Created By"},"tenant_id":{"type":"string","title":"Tenant Id"}},"type":"object","required":["id","name","integration_id","params","updated_at","created_at","created_by","tenant_id"],"title":"DestinationResponse"},"DestinationUpdateBase":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":300,"minLength":1},{"type":"null"}],"title":"Name"},"params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Params"}},"type":"object","title":"DestinationUpdateBase"},"IntegrationResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"integration_type":{"$ref":"#/components/schemas/IntegrationType"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"created_by":{"type":"string","title":"Created By"},"tenant_id":{"type":"string","title":"Tenant Id"}},"type":"object","required":["id","integration_type","updated_at","created_at","created_by","tenant_id"],"title":"IntegrationResponse"},"IntegrationType":{"type":"string","enum":["slack"],"title":"IntegrationType"},"Page_DestinationResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DestinationResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DestinationResponse]"},"Page_IntegrationResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/IntegrationResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[IntegrationResponse]"},"AnthropicProviderConfig":{"properties":{"provider":{"type":"string","const":"Anthropic","title":"Provider"},"api_key":{"type":"string","minLength":1,"title":"Api Key","description":"Anthropic API key"}},"type":"object","required":["provider","api_key"],"title":"AnthropicProviderConfig"},"GoogleAIProviderConfig":{"properties":{"provider":{"type":"string","const":"GoogleAI","title":"Provider"},"api_key":{"type":"string","minLength":1,"title":"Api Key","description":"Google AI API key"}},"type":"object","required":["provider","api_key"],"title":"GoogleAIProviderConfig"},"ModelProviderCreatePayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name"},"config":{"oneOf":[{"$ref":"#/components/schemas/OpenAIProviderConfig"},{"$ref":"#/components/schemas/OpenAICompatibleProviderConfig"},{"$ref":"#/components/schemas/GoogleAIProviderConfig"},{"$ref":"#/components/schemas/AnthropicProviderConfig"},{"$ref":"#/components/schemas/VertexAIProviderConfig"}],"title":"Config","discriminator":{"propertyName":"provider","mapping":{"Anthropic":"#/components/schemas/AnthropicProviderConfig","GoogleAI":"#/components/schemas/GoogleAIProviderConfig","OpenAI":"#/components/schemas/OpenAIProviderConfig","OpenAICompatible":"#/components/schemas/OpenAICompatibleProviderConfig","VertexAIModelGarden":"#/components/schemas/VertexAIProviderConfig"}}}},"type":"object","required":["name","config"],"title":"ModelProviderCreatePayload"},"ModelProviderPatchPayload":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":100,"minLength":1},{"type":"null"}],"title":"Name"}},"type":"object","title":"ModelProviderPatchPayload"},"ModelProviderSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name"},"config":{"oneOf":[{"$ref":"#/components/schemas/OpenAIProviderConfig"},{"$ref":"#/components/schemas/OpenAICompatibleProviderConfig"},{"$ref":"#/components/schemas/GoogleAIProviderConfig"},{"$ref":"#/components/schemas/AnthropicProviderConfig"},{"$ref":"#/components/schemas/VertexAIProviderConfig"},{"$ref":"#/components/schemas/SuperwiseProviderConfig"}],"title":"Config","discriminator":{"propertyName":"provider","mapping":{"Anthropic":"#/components/schemas/AnthropicProviderConfig","GoogleAI":"#/components/schemas/GoogleAIProviderConfig","OpenAI":"#/components/schemas/OpenAIProviderConfig","OpenAICompatible":"#/components/schemas/OpenAICompatibleProviderConfig","Superwise":"#/components/schemas/SuperwiseProviderConfig","VertexAIModelGarden":"#/components/schemas/VertexAIProviderConfig"}}},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"}},"type":"object","required":["id","name","config","created_by"],"title":"ModelProviderSchema"},"OpenAICompatibleProviderConfig":{"properties":{"provider":{"type":"string","const":"OpenAICompatible","title":"Provider"},"api_key":{"type":"string","minLength":1,"title":"Api Key","description":"OpenAI compatible API key"},"base_url":{"type":"string","title":"Base Url","description":"Base URL for the compatible OpenAI endpoint"}},"type":"object","required":["provider","api_key","base_url"],"title":"OpenAICompatibleProviderConfig"},"OpenAIProviderConfig":{"properties":{"provider":{"type":"string","const":"OpenAI","title":"Provider"},"api_key":{"type":"string","minLength":1,"title":"Api Key","description":"OpenAI API key"}},"type":"object","required":["provider","api_key"],"title":"OpenAIProviderConfig"},"Page_ModelProviderSchema_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ModelProviderSchema"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[ModelProviderSchema]Customized"},"PrebuiltProviderStatus":{"properties":{"total_budget":{"type":"number","title":"Total Budget"},"budget_spent":{"type":"number","title":"Budget Spent"},"budget_reset_at":{"type":"string","format":"date-time","title":"Budget Reset At"}},"type":"object","required":["total_budget","budget_spent","budget_reset_at"],"title":"PrebuiltProviderStatus"},"ServiceAccount":{"additionalProperties":true,"type":"object","title":"ServiceAccount"},"SuperwiseProviderConfig":{"properties":{"provider":{"type":"string","const":"Superwise","title":"Provider"}},"type":"object","required":["provider"],"title":"SuperwiseProviderConfig"},"VertexAIProviderConfig":{"properties":{"provider":{"type":"string","const":"VertexAIModelGarden","title":"Provider"},"project_id":{"type":"string","minLength":1,"title":"Project Id"},"endpoint_id":{"type":"string","minLength":1,"title":"Endpoint Id"},"location":{"type":"string","minLength":1,"title":"Location"},"service_account":{"$ref":"#/components/schemas/ServiceAccount","description":"Service account JSON"}},"type":"object","required":["provider","project_id","endpoint_id","location","service_account"],"title":"VertexAIProviderConfig"},"AllowedTopicsPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"allowed_topics","title":"Type","default":"allowed_topics"},"model":{"$ref":"#/components/schemas/ModelLLM","description":"Model for topic classification."},"topics":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Topics"}},"additionalProperties":true,"type":"object","required":["name","tags","model","topics"],"title":"AllowedTopicsPayload"},"BlurrinessPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"image_blurriness","title":"Type","default":"image_blurriness"},"min_variance":{"type":"number","exclusiveMinimum":0,"title":"Min Variance","description":"Minimum variance of Laplacian (sharpness). Image must have variance >= this to pass. Must be > 0."}},"additionalProperties":true,"type":"object","required":["name","tags","min_variance"],"title":"BlurrinessPayload"},"CompetitorCheckPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"competitor_check","title":"Type","default":"competitor_check"},"competitor_names":{"items":{"type":"string"},"type":"array","maxItems":10,"minItems":1,"uniqueItems":true,"title":"Competitor Names","description":"Set of restricted competitor names."}},"additionalProperties":true,"type":"object","required":["name","tags","competitor_names"],"title":"CompetitorCheckPayload"},"CorrectLanguagePayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"correct_language","title":"Type","default":"correct_language"},"language_codes":{"items":{"type":"string"},"type":"array","minItems":1,"uniqueItems":true,"title":"Language Codes"},"filter_mode":{"$ref":"#/components/schemas/FilterMode"}},"additionalProperties":true,"type":"object","required":["name","tags","language_codes","filter_mode"],"title":"CorrectLanguagePayload"},"DetectJailbreakPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","const":"input"},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: 'input'."},"type":{"type":"string","const":"detect_jailbreak","title":"Type","default":"detect_jailbreak"},"threshold":{"type":"number","maximum":1,"minimum":0,"title":"Threshold","description":"Threshold for jailbreak detection must be between 0 and 1.","default":0.7}},"additionalProperties":true,"type":"object","required":["name","tags"],"title":"DetectJailbreakPayload"},"FilterMode":{"type":"string","enum":["include","exclude"],"title":"FilterMode","description":"Enum for filter modes in language guards."},"GuardType":{"type":"string","enum":["toxicity","allowed_topics","restricted_topics","correct_language","string_check","competitor_check","pii_detection","detect_jailbreak","image_blurriness","image_resolution","image_semantics","image_tampering"],"title":"GuardType","description":"Enumeration of all available guard types."},"GuardrailBulkActionRequest":{"properties":{"action":{"$ref":"#/components/schemas/GuardrailBulkActionType","description":"The action to perform on the guardrails"},"ids":{"items":{"type":"string","format":"uuid4"},"type":"array","maxItems":50,"minItems":1,"title":"Ids","description":"List of guardrail IDs to perform the action on"}},"type":"object","required":["action","ids"],"title":"GuardrailBulkActionRequest"},"GuardrailBulkActionType":{"type":"string","enum":["delete","archive"],"title":"GuardrailBulkActionType"},"GuardrailCreatePayload":{"properties":{"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"observability_enabled":{"type":"boolean","title":"Observability Enabled","default":true}},"type":"object","required":["name"],"title":"GuardrailCreatePayload"},"GuardrailPatchPayload":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":95},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"dataset_id":{"anyOf":[{"type":"string","format":"uuid4"},{"type":"null"}],"title":"Dataset Id"},"observability_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Observability Enabled"}},"type":"object","title":"GuardrailPatchPayload"},"GuardrailRuleResult":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/GuardType"},"valid":{"type":"boolean","title":"Valid"},"message":{"type":"string","title":"Message"}},"type":"object","required":["name","type","valid","message"],"title":"GuardrailRuleResult"},"GuardrailSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_by":{"type":"string","title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"last_interaction_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Interaction At"},"observability_enabled":{"type":"boolean","title":"Observability Enabled","default":true},"dataset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"},"current_version":{"anyOf":[{"$ref":"#/components/schemas/GuardrailVersionSchema"},{"type":"null"}]},"tags":{"items":{"type":"string","format":"uuid4"},"type":"array","title":"Tags"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","name","created_by"],"title":"GuardrailSchema"},"GuardrailValidateRequest":{"properties":{"guardrules":{"items":{"oneOf":[{"$ref":"#/components/schemas/AllowedTopicsPayload"},{"$ref":"#/components/schemas/BlurrinessPayload"},{"$ref":"#/components/schemas/CorrectLanguagePayload"},{"$ref":"#/components/schemas/CompetitorCheckPayload"},{"$ref":"#/components/schemas/DetectJailbreakPayload"},{"$ref":"#/components/schemas/PiiDetectionPayload"},{"$ref":"#/components/schemas/RestrictedTopicsPayload"},{"$ref":"#/components/schemas/ResolutionPayload"},{"$ref":"#/components/schemas/ImageSemanticsPayload"},{"$ref":"#/components/schemas/StringCheckPayload"},{"$ref":"#/components/schemas/ToxicityPayload"},{"$ref":"#/components/schemas/ImageTamperingPayload"}],"discriminator":{"propertyName":"type","mapping":{"allowed_topics":"#/components/schemas/AllowedTopicsPayload","competitor_check":"#/components/schemas/CompetitorCheckPayload","correct_language":"#/components/schemas/CorrectLanguagePayload","detect_jailbreak":"#/components/schemas/DetectJailbreakPayload","image_blurriness":"#/components/schemas/BlurrinessPayload","image_resolution":"#/components/schemas/ResolutionPayload","image_semantics":"#/components/schemas/ImageSemanticsPayload","image_tampering":"#/components/schemas/ImageTamperingPayload","pii_detection":"#/components/schemas/PiiDetectionPayload","restricted_topics":"#/components/schemas/RestrictedTopicsPayload","string_check":"#/components/schemas/StringCheckPayload","toxicity":"#/components/schemas/ToxicityPayload"}}},"type":"array","title":"Guardrules"}},"type":"object","required":["guardrules"],"title":"GuardrailValidateRequest"},"GuardrailValidationResponse":{"items":{"$ref":"#/components/schemas/GuardrailRuleResult"},"type":"array","title":"GuardrailValidationResponse"},"GuardrailVersionCreatePayload":{"properties":{"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"},"guardrules":{"items":{"oneOf":[{"$ref":"#/components/schemas/AllowedTopicsPayload"},{"$ref":"#/components/schemas/BlurrinessPayload"},{"$ref":"#/components/schemas/CorrectLanguagePayload"},{"$ref":"#/components/schemas/CompetitorCheckPayload"},{"$ref":"#/components/schemas/DetectJailbreakPayload"},{"$ref":"#/components/schemas/PiiDetectionPayload"},{"$ref":"#/components/schemas/RestrictedTopicsPayload"},{"$ref":"#/components/schemas/ResolutionPayload"},{"$ref":"#/components/schemas/ImageSemanticsPayload"},{"$ref":"#/components/schemas/StringCheckPayload"},{"$ref":"#/components/schemas/ToxicityPayload"},{"$ref":"#/components/schemas/ImageTamperingPayload"}],"discriminator":{"propertyName":"type","mapping":{"allowed_topics":"#/components/schemas/AllowedTopicsPayload","competitor_check":"#/components/schemas/CompetitorCheckPayload","correct_language":"#/components/schemas/CorrectLanguagePayload","detect_jailbreak":"#/components/schemas/DetectJailbreakPayload","image_blurriness":"#/components/schemas/BlurrinessPayload","image_resolution":"#/components/schemas/ResolutionPayload","image_semantics":"#/components/schemas/ImageSemanticsPayload","image_tampering":"#/components/schemas/ImageTamperingPayload","pii_detection":"#/components/schemas/PiiDetectionPayload","restricted_topics":"#/components/schemas/RestrictedTopicsPayload","string_check":"#/components/schemas/StringCheckPayload","toxicity":"#/components/schemas/ToxicityPayload"}}},"type":"array","title":"Guardrules","default":[]}},"type":"object","required":["name"],"title":"GuardrailVersionCreatePayload"},"GuardrailVersionPatchPayload":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":95},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"}},"type":"object","title":"GuardrailVersionPatchPayload"},"GuardrailVersionSchema":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id"},"guardrail_id":{"type":"string","format":"uuid4","title":"Guardrail Id"},"name":{"type":"string","maxLength":95,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description"},"guardrules":{"items":{"oneOf":[{"$ref":"#/components/schemas/AllowedTopicsPayload"},{"$ref":"#/components/schemas/BlurrinessPayload"},{"$ref":"#/components/schemas/CorrectLanguagePayload"},{"$ref":"#/components/schemas/CompetitorCheckPayload"},{"$ref":"#/components/schemas/DetectJailbreakPayload"},{"$ref":"#/components/schemas/PiiDetectionPayload"},{"$ref":"#/components/schemas/RestrictedTopicsPayload"},{"$ref":"#/components/schemas/ResolutionPayload"},{"$ref":"#/components/schemas/ImageSemanticsPayload"},{"$ref":"#/components/schemas/StringCheckPayload"},{"$ref":"#/components/schemas/ToxicityPayload"},{"$ref":"#/components/schemas/ImageTamperingPayload"}],"discriminator":{"propertyName":"type","mapping":{"allowed_topics":"#/components/schemas/AllowedTopicsPayload","competitor_check":"#/components/schemas/CompetitorCheckPayload","correct_language":"#/components/schemas/CorrectLanguagePayload","detect_jailbreak":"#/components/schemas/DetectJailbreakPayload","image_blurriness":"#/components/schemas/BlurrinessPayload","image_resolution":"#/components/schemas/ResolutionPayload","image_semantics":"#/components/schemas/ImageSemanticsPayload","image_tampering":"#/components/schemas/ImageTamperingPayload","pii_detection":"#/components/schemas/PiiDetectionPayload","restricted_topics":"#/components/schemas/RestrictedTopicsPayload","string_check":"#/components/schemas/StringCheckPayload","toxicity":"#/components/schemas/ToxicityPayload"}}},"type":"array","title":"Guardrules"},"created_by":{"type":"string","title":"Created By"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","guardrail_id","name","guardrules","created_by"],"title":"GuardrailVersionSchema"},"GuardrailsSearchParams":{"properties":{"only_archived":{"type":"boolean","title":"Only Archived","default":false},"with_archived":{"type":"boolean","title":"With Archived","default":false},"with_deleted":{"type":"boolean","title":"With Deleted","default":false},"filters":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Filters","description":"Filter on db columns","examples":[["name","eq","active"],[["id","eq","5c05dc9f-f04a-4ce8-9d57-2ec63ee76aac"],"and",["description","ilike","Construction"]]]},"search":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Search","description":"Free text search on searchable fields"},"sort_by":{"type":"string","enum":["id","name","status","updated_at","created_at","current_version.created_at","last_interaction_at"],"title":"Sort By","description":"Field to sort by","default":"updated_at"},"sort_direction":{"type":"string","enum":["asc","desc"],"title":"Sort Direction","description":"Sort direction (ascending or descending)","default":"desc"},"sort_by_version_field":{"anyOf":[{"type":"string","const":"created_at"},{"type":"null"}],"title":"Sort By Version Field","description":"Field to sort by in the current version"}},"type":"object","title":"GuardrailsSearchParams"},"ImageSemanticsPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"image_semantics","title":"Type","default":"image_semantics"},"image_categories":{"items":{"type":"string","enum":["Photograph","Artwork","Document Scan","Screenshot","Diagram","Meme","Other"]},"type":"array","minItems":1,"title":"Image Categories"},"filter_mode":{"$ref":"#/components/schemas/FilterMode"}},"additionalProperties":true,"type":"object","required":["name","tags","image_categories","filter_mode"],"title":"ImageSemanticsPayload"},"ImageTamperingPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"image_tampering","title":"Type","default":"image_tampering"},"tamper_threshold":{"type":"number","maximum":1,"minimum":0,"title":"Tamper Threshold","description":"Threshold for image tampering detection must be between 0 and 1.","default":0.65},"min_tamper_ratio_percent":{"type":"number","maximum":100,"minimum":0,"title":"Min Tamper Ratio Percent","description":"Minimum tampered ratio must be between 0% and 100%.","default":1}},"additionalProperties":true,"type":"object","required":["name","tags"],"title":"ImageTamperingPayload"},"ModelName":{"type":"string","enum":["original","unbiased","multilingual","original-small","unbiased-small"],"title":"ModelName"},"Page_GuardrailSchema_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GuardrailSchema"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[GuardrailSchema]Customized"},"PiiDetectionPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"pii_detection","title":"Type","default":"pii_detection"},"categories":{"items":{"type":"string"},"type":"array","minItems":1,"uniqueItems":true,"title":"Categories","description":"Set of PII categories."},"threshold":{"type":"number","maximum":1,"minimum":0,"title":"Threshold","description":"Threshold for PII detection (must be between 0 and 1)."}},"additionalProperties":true,"type":"object","required":["name","tags","categories","threshold"],"title":"PiiDetectionPayload"},"ResolutionPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"image_resolution","title":"Type","default":"image_resolution"},"min_width":{"type":"integer","exclusiveMinimum":0,"title":"Min Width","description":"Minimum image width in pixels. Must be > 0."},"min_height":{"type":"integer","exclusiveMinimum":0,"title":"Min Height","description":"Minimum image height in pixels. Must be > 0."}},"additionalProperties":true,"type":"object","required":["name","tags","min_width","min_height"],"title":"ResolutionPayload"},"RestrictedTopicsPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"restricted_topics","title":"Type","default":"restricted_topics"},"model":{"$ref":"#/components/schemas/ModelLLM","description":"Model for topic classification."},"topics":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Topics"}},"additionalProperties":true,"type":"object","required":["name","tags","model","topics"],"title":"RestrictedTopicsPayload"},"StringCheckPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"string_check","title":"Type","default":"string_check"},"regex_pattern":{"items":{"type":"string"},"type":"array","minItems":1,"uniqueItems":true,"title":"Regex Pattern","description":"set of regex patterns to search for prohibited content"}},"additionalProperties":true,"type":"object","required":["name","tags","regex_pattern"],"title":"StringCheckPayload"},"ToxicityPayload":{"properties":{"name":{"type":"string","maxLength":100,"minLength":1,"title":"Name","description":"Name of the rule."},"tags":{"items":{"type":"string","enum":["input","output"]},"type":"array","uniqueItems":true,"title":"Tags","description":"Specifies what this rule applies to: any combination of 'input' and/or 'output'."},"type":{"type":"string","const":"toxicity","title":"Type","default":"toxicity"},"threshold":{"type":"number","maximum":1,"minimum":0,"title":"Threshold","description":"Threshold for toxicity detection must be between 0 and 1.","default":0.5},"model_name":{"$ref":"#/components/schemas/ModelName","description":"Model name for toxicity detection.","default":"unbiased-small"},"validation_method":{"type":"string","enum":["sentence","full"],"title":"Validation Method","description":"Validation method for toxicity detection.","default":"sentence"}},"additionalProperties":true,"type":"object","required":["name","tags"],"title":"ToxicityPayload"},"AWSCredentialsRequest":{"properties":{"credentials_type":{"type":"string","const":"AWS","title":"Credentials Type","default":"AWS"},"aws_access_key_id":{"type":"string","title":"Aws Access Key Id"},"aws_secret_access_key":{"type":"string","title":"Aws Secret Access Key"}},"type":"object","required":["aws_access_key_id","aws_secret_access_key"],"title":"AWSCredentialsRequest"},"AzureCredentialsRequest":{"properties":{"credentials_type":{"type":"string","const":"AZURE","title":"Credentials Type","default":"AZURE"},"tenant_id":{"type":"string","title":"Tenant Id"},"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"}},"type":"object","required":["tenant_id","client_id","client_secret"],"title":"AzureCredentialsRequest"},"DatasetSourceCreate":{"properties":{"dataset_id":{"type":"string","title":"Dataset Id"},"source_id":{"type":"string","format":"uuid","title":"Source Id"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"ingest_type":{"$ref":"#/components/schemas/IngestType","default":"insert"},"increment_field_type":{"anyOf":[{"$ref":"#/components/schemas/IncrementFieldType"},{"type":"null"}]},"increment_field_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Name"},"table_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Table Name"},"data_retrieval_cron_expression":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Retrieval Cron Expression"},"increment_field_last_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Last Value"}},"additionalProperties":false,"type":"object","required":["dataset_id","source_id"],"title":"DatasetSourceCreate","example":{"created_by":"some_user","dataset_id":"inference_dataset","folder":"models/32/versions/38/production_data/","id":"Model32/Version38","ingest-type":"insert","source_id":"e6a16ff7-4a31-11eb-be7b-8324edc8f36b"}},"DatasetSourceResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"source_id":{"type":"string","format":"uuid","title":"Source Id"},"internal_dataset_id":{"type":"string","title":"Internal Dataset Id"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"ingest_type":{"$ref":"#/components/schemas/IngestType","default":"insert"},"increment_field_type":{"anyOf":[{"$ref":"#/components/schemas/IncrementFieldType"},{"type":"null"}]},"increment_field_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Name"},"table_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Table Name"},"data_retrieval_cron_expression":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Retrieval Cron Expression"},"increment_field_last_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Last Value"}},"type":"object","required":["id","source_id","internal_dataset_id","created_by"],"title":"DatasetSourceResponse"},"DatasetSourceResponseWithSource":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"source_id":{"type":"string","format":"uuid","title":"Source Id"},"internal_dataset_id":{"type":"string","title":"Internal Dataset Id"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"ingest_type":{"$ref":"#/components/schemas/IngestType","default":"insert"},"increment_field_type":{"anyOf":[{"$ref":"#/components/schemas/IncrementFieldType"},{"type":"null"}]},"increment_field_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Name"},"table_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Table Name"},"data_retrieval_cron_expression":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Retrieval Cron Expression"},"increment_field_last_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Last Value"},"source":{"oneOf":[{"$ref":"#/components/schemas/SourceGetS3"},{"$ref":"#/components/schemas/SourceGetAzure"},{"$ref":"#/components/schemas/SourceGetGCS"}],"title":"Source","discriminator":{"propertyName":"type","mapping":{"AZURE_BLOB_STORAGE":"#/components/schemas/SourceGetAzure","GCS":"#/components/schemas/SourceGetGCS","S3":"#/components/schemas/SourceGetS3"}}}},"type":"object","required":["id","source_id","internal_dataset_id","created_by","source"],"title":"DatasetSourceResponseWithSource"},"DatasetSourceUpdate":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"dataset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"},"source_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Source Id"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder"},"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"},"ingest_type":{"anyOf":[{"$ref":"#/components/schemas/IngestType"},{"type":"null"}]},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"increment_field_last_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Increment Field Last Value"}},"type":"object","title":"DatasetSourceUpdate"},"GCPCredentialsRequest":{"properties":{"credentials_type":{"type":"string","const":"GCP","title":"Credentials Type","default":"GCP"},"service_account":{"additionalProperties":{"type":"string"},"type":"object","title":"Service Account"}},"type":"object","required":["service_account"],"title":"GCPCredentialsRequest"},"IncrementFieldType":{"type":"string","enum":["DATETIME","DATE","NUMERIC"],"title":"IncrementFieldType"},"IngestType":{"type":"string","enum":["insert","update"],"title":"IngestType"},"Page_DatasetSourceResponseWithSource_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DatasetSourceResponseWithSource"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous"},"first":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First"},"last":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DatasetSourceResponseWithSource]"},"Page_SourceResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SourceResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"},"next":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next"},"previous":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previous"},"first":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First"},"last":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[SourceResponse]"},"PostgresCredentials":{"properties":{"credentials_type":{"type":"string","const":"POSTGRESQL","title":"Credentials Type","default":"POSTGRESQL"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"}},"type":"object","required":["username","password"],"title":"PostgresCredentials"},"SourceAzureParams":{"properties":{"event_hub_namespace_id":{"type":"string","pattern":"^/subscriptions/[a-z0-9-]+/resourceGroups/[\\w.()-]+/providers/Microsoft\\.EventHub/namespaces/[A-Za-z0-9-]{6,50}$","title":"Event Hub Namespace Id"},"event_hub_name":{"type":"string","title":"Event Hub Name"},"storage_account_id":{"type":"string","pattern":"^/subscriptions/[a-z0-9-]+/resourceGroups/[\\w.()-]+/providers/Microsoft\\.Storage/storageAccounts/[a-z0-9]{3,24}$","title":"Storage Account Id"}},"type":"object","required":["event_hub_namespace_id","event_hub_name","storage_account_id"],"title":"SourceAzureParams"},"SourceCreateAzure":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"AZURE_BLOB_STORAGE","title":"Type","default":"AZURE_BLOB_STORAGE"},"credentials":{"$ref":"#/components/schemas/AzureCredentialsRequest"},"params":{"$ref":"#/components/schemas/SourceAzureParams"}},"additionalProperties":false,"type":"object","required":["name","credentials","params"],"title":"SourceCreateAzure"},"SourceCreateGCS":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"GCS","title":"Type","default":"GCS"},"credentials":{"anyOf":[{"$ref":"#/components/schemas/GCPCredentialsRequest"},{"type":"null"}]},"params":{"$ref":"#/components/schemas/SourceGCSParams"}},"additionalProperties":false,"type":"object","required":["name","params"],"title":"SourceCreateGCS"},"SourceCreatePostgres":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"POSTGRESQL","title":"Type","default":"POSTGRESQL"},"credentials":{"$ref":"#/components/schemas/PostgresCredentials"},"params":{"$ref":"#/components/schemas/SourcePostgresParams"}},"additionalProperties":false,"type":"object","required":["name","credentials","params"],"title":"SourceCreatePostgres"},"SourceCreateS3":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","const":"S3","title":"Type","default":"S3"},"credentials":{"anyOf":[{"$ref":"#/components/schemas/AWSCredentialsRequest"},{"type":"null"}]},"params":{"$ref":"#/components/schemas/SourceS3Params"}},"additionalProperties":false,"type":"object","required":["name","params"],"title":"SourceCreateS3"},"SourceGCSParams":{"properties":{"bucket_name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_-]{1,61}[a-z0-9](\\.[a-z0-9][a-z0-9_-]{1,61}[a-z0-9])*$","title":"Bucket Name"},"topic_name":{"type":"string","pattern":"^projects/[a-z][a-z0-9-]{3,29}/topics/[A-Za-z][A-Za-z0-9_.~%+-]{2,254}$","title":"Topic Name"}},"type":"object","required":["bucket_name","topic_name"],"title":"SourceGCSParams"},"SourceGetAzure":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"type":{"type":"string","const":"AZURE_BLOB_STORAGE","title":"Type"},"params":{"$ref":"#/components/schemas/SourceAzureParams"}},"type":"object","required":["id","name","created_by","type","params"],"title":"SourceGetAzure"},"SourceGetGCS":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"type":{"type":"string","const":"GCS","title":"Type"},"params":{"$ref":"#/components/schemas/SourceGCSParams"}},"type":"object","required":["id","name","created_by","type","params"],"title":"SourceGetGCS"},"SourceGetPostgres":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"type":{"type":"string","const":"POSTGRESQL","title":"Type"},"params":{"$ref":"#/components/schemas/SourcePostgresParams"}},"type":"object","required":["id","name","created_by","type","params"],"title":"SourceGetPostgres"},"SourceGetS3":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"created_by":{"type":"string","title":"Created By"},"type":{"type":"string","const":"S3","title":"Type"},"params":{"$ref":"#/components/schemas/SourceS3Params"}},"type":"object","required":["id","name","created_by","type","params"],"title":"SourceGetS3"},"SourcePostgresParams":{"properties":{"host":{"type":"string","title":"Host"},"port":{"type":"integer","maximum":65535,"minimum":1,"title":"Port"},"db":{"type":"string","title":"Db"}},"type":"object","required":["host","port","db"],"title":"SourcePostgresParams"},"SourceResponse":{"oneOf":[{"$ref":"#/components/schemas/SourceGetS3"},{"$ref":"#/components/schemas/SourceGetAzure"},{"$ref":"#/components/schemas/SourceGetGCS"},{"$ref":"#/components/schemas/SourceGetPostgres"}],"title":"SourceResponse","discriminator":{"propertyName":"type","mapping":{"AZURE_BLOB_STORAGE":"#/components/schemas/SourceGetAzure","GCS":"#/components/schemas/SourceGetGCS","POSTGRESQL":"#/components/schemas/SourceGetPostgres","S3":"#/components/schemas/SourceGetS3"}}},"SourceS3Params":{"properties":{"bucket_arn":{"type":"string","pattern":"^arn:aws(-cn|-us-gov)?:s3:([a-z]{2}(-gov)?-[a-z]+-\\d)?:(\\d{12})?:[0-9a-z][0-9a-z.-]{2,62}$","title":"Bucket Arn"},"queue_arn":{"type":"string","pattern":"^arn:aws(-cn|-us-gov)?:sqs:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:.+$","title":"Queue Arn"}},"type":"object","required":["bucket_arn","queue_arn"],"title":"SourceS3Params"},"SourceType":{"type":"string","enum":["GCS","S3","AZURE_BLOB_STORAGE","POSTGRESQL"],"title":"SourceType"},"SourceUpdateGCS":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"credentials":{"anyOf":[{"$ref":"#/components/schemas/GCPCredentialsRequest"},{"type":"null"}]},"params":{"anyOf":[{"$ref":"#/components/schemas/SourceGCSParams"},{"type":"null"}]},"type":{"type":"string","const":"GCS","title":"Type","default":"GCS"}},"type":"object","title":"SourceUpdateGCS"},"SourceUpdatePostgres":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"credentials":{"anyOf":[{"$ref":"#/components/schemas/PostgresCredentials"},{"type":"null"}]},"params":{"anyOf":[{"$ref":"#/components/schemas/SourcePostgresParams"},{"type":"null"}]},"type":{"type":"string","const":"POSTGRESQL","title":"Type","default":"POSTGRESQL"}},"type":"object","title":"SourceUpdatePostgres"},"SourceUpdateS3":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"credentials":{"anyOf":[{"$ref":"#/components/schemas/AWSCredentialsRequest"},{"type":"null"}]},"params":{"anyOf":[{"$ref":"#/components/schemas/SourceS3Params"},{"type":"null"}]},"type":{"type":"string","const":"S3","title":"Type","default":"S3"}},"type":"object","title":"SourceUpdateS3"},"TestSourceConnectionRequest":{"properties":{"type":{"$ref":"#/components/schemas/SourceType"},"params":{"$ref":"#/components/schemas/SourcePostgresParams"},"credentials":{"$ref":"#/components/schemas/PostgresCredentials"}},"type":"object","required":["type","params","credentials"],"title":"TestSourceConnectionRequest"},"AlertOnStatusDirection":{"type":"string","enum":["HEALTHY_TO_UNHEALTHY","UNHEALTHY_TO_HEALTHY","BOTH"],"title":"AlertOnStatusDirection"},"DataConfigStatistics-Input":{"properties":{"type":{"type":"string","const":"statistics","title":"Type","default":"statistics"},"query":{"$ref":"#/components/schemas/PolicyQuery"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig"}},"type":"object","required":["query","time_range_config"],"title":"DataConfigStatistics"},"DataConfigStatistics-Output":{"properties":{"type":{"type":"string","const":"statistics","title":"Type","default":"statistics"},"query":{"$ref":"#/components/schemas/PolicyQuery"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig"}},"type":"object","required":["query","time_range_config"],"title":"DataConfigStatistics"},"GuardrailViolationsTemplate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","default":true},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","default":"*/5 * * * *"},"threshold_settings":{"anyOf":[{"$ref":"#/components/schemas/StaticThresholdSettings"},{"type":"null"}]},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","default":"HEALTHY_TO_UNHEALTHY"},"type":{"type":"string","const":"guardrail_violations","title":"Type","default":"guardrail_violations"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id"},"internal_id":{"type":"string","title":"Internal Id"},"measure":{"type":"string","title":"Measure","default":"count"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig","default":{"field_name":"received_ts","unit":"HOUR","value":1}},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","default":true},"threshold":{"type":"integer","title":"Threshold"}},"type":"object","required":["name","dataset_id","destination_ids","agent_id","threshold"],"title":"GuardrailViolationsTemplate"},"LatencyAnomalyTemplate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","default":true},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","default":"*/15 * * * *"},"threshold_settings":{"anyOf":[{"$ref":"#/components/schemas/MovingAverageThresholdSettings"},{"type":"null"}]},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","default":"HEALTHY_TO_UNHEALTHY"},"type":{"type":"string","const":"latency_anomaly","title":"Type","default":"latency_anomaly"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id"},"internal_id":{"type":"string","title":"Internal Id"},"measure":{"type":"string","title":"Measure","default":"avgResponse_time_seconds"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig","default":{"field_name":"received_ts","unit":"MINUTE","value":30}},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","default":true},"warn_above_threshold":{"type":"boolean","title":"Warn Above Threshold"},"warn_below_threshold":{"type":"boolean","title":"Warn Below Threshold"}},"type":"object","required":["name","dataset_id","destination_ids","agent_id","warn_above_threshold","warn_below_threshold"],"title":"LatencyAnomalyTemplate"},"LatencySpikeTemplate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","default":true},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","default":"*/15 * * * *"},"threshold_settings":{"anyOf":[{"$ref":"#/components/schemas/StaticThresholdSettings"},{"type":"null"}]},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","default":"HEALTHY_TO_UNHEALTHY"},"type":{"type":"string","const":"latency_spike","title":"Type","default":"latency_spike"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id"},"internal_id":{"type":"string","title":"Internal Id"},"measure":{"type":"string","title":"Measure","default":"avgResponse_time_seconds"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig","default":{"field_name":"received_ts","unit":"MINUTE","value":30}},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","default":true},"threshold":{"type":"number","title":"Threshold"}},"type":"object","required":["name","dataset_id","destination_ids","agent_id","threshold"],"title":"LatencySpikeTemplate"},"MovingAverageThresholdSettings":{"properties":{"is_violation_above":{"type":"boolean","title":"Is Violation Above","default":true},"is_violation_below":{"type":"boolean","title":"Is Violation Below","default":true},"violation_deviation":{"type":"number","exclusiveMinimum":0,"title":"Violation Deviation"},"threshold_type":{"type":"string","const":"moving_average","title":"Threshold Type","default":"moving_average"},"window_size":{"type":"integer","exclusiveMinimum":0,"title":"Window Size"}},"type":"object","required":["violation_deviation","window_size"],"title":"MovingAverageThresholdSettings"},"NoResponseTemplate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","default":true},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","default":"0 * * * *"},"threshold_settings":{"anyOf":[{"$ref":"#/components/schemas/StaticThresholdSettings"},{"type":"null"}]},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","default":"HEALTHY_TO_UNHEALTHY"},"type":{"type":"string","const":"no_response","title":"Type","default":"no_response"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id"},"internal_id":{"type":"string","title":"Internal Id"},"measure":{"type":"string","title":"Measure","default":"count"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig","default":{"field_name":"received_ts","unit":"HOUR","value":1}},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","default":true},"threshold":{"type":"integer","title":"Threshold"}},"type":"object","required":["name","dataset_id","destination_ids","agent_id","threshold"],"title":"NoResponseTemplate"},"NoThroughputTemplate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","default":true},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","default":"*/5 * * * *"},"threshold_settings":{"$ref":"#/components/schemas/StaticThresholdSettings","default":{"condition_below_value":1,"threshold_type":"static"}},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","default":"HEALTHY_TO_UNHEALTHY"},"type":{"type":"string","const":"no_throughput","title":"Type","default":"no_throughput"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id"},"internal_id":{"type":"string","title":"Internal Id"},"measure":{"type":"string","title":"Measure","default":"count"},"time_range_config":{"anyOf":[{"$ref":"#/components/schemas/TimeRangeConfig"},{"type":"null"}]},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","default":true},"value":{"type":"integer","title":"Value"},"unit":{"type":"string","enum":["HOUR","MINUTE"],"title":"Unit","default":"HOUR"}},"type":"object","required":["name","dataset_id","destination_ids","agent_id","value"],"title":"NoThroughputTemplate"},"Page_PolicyResponse_Customized":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PolicyResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0,"title":"Total"},"page":{"type":"integer","minimum":1,"title":"Page"},"size":{"type":"integer","minimum":1,"title":"Size"},"pages":{"type":"integer","minimum":0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[PolicyResponse]Customized"},"PolicyBulkActionRequest":{"properties":{"action":{"$ref":"#/components/schemas/PolicyBulkActionType","description":"The action to perform on the policies"},"ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":50,"minItems":1,"title":"Ids","description":"List of policy IDs to perform the action on"}},"type":"object","required":["action","ids"],"title":"PolicyBulkActionRequest"},"PolicyBulkActionType":{"type":"string","enum":["delete","archive"],"title":"PolicyBulkActionType"},"PolicyCreate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","description":"Trigger policy action on a single group/entire groups"},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","description":"Cron expression for policy evaluation"},"threshold_settings":{"oneOf":[{"$ref":"#/components/schemas/StaticThresholdSettings"},{"$ref":"#/components/schemas/MovingAverageThresholdSettings"}],"title":"Threshold Settings","discriminator":{"propertyName":"threshold_type","mapping":{"moving_average":"#/components/schemas/MovingAverageThresholdSettings","static":"#/components/schemas/StaticThresholdSettings"}}},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","description":"Trigger policy action if the value is above/below"},"data_config":{"anyOf":[{"$ref":"#/components/schemas/DataConfigStatistics-Input"},{"$ref":"#/components/schemas/DataConfigDistributionCompare-Input"}],"title":"Data Config"},"dataset_b_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset B Id","description":"The second dataset this policy is monitoring"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description for this policy"},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","description":"If true, the policy will be initialized with historic data","default":false}},"type":"object","required":["alert_on_policy_level","name","dataset_id","destination_ids","cron_expression","threshold_settings","alert_on_status","data_config"],"title":"PolicyCreate"},"PolicyQuery":{"properties":{"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"order":{"anyOf":[{"items":{"$ref":"#/components/schemas/PolicyQueryOrder"},"type":"array"},{"$ref":"#/components/schemas/PolicyQueryOrder"},{"type":"null"}],"title":"Order"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"UTC"},"filters":{"items":{"anyOf":[{"$ref":"#/components/schemas/PolicyQueryFilter"},{"$ref":"#/components/schemas/PolicyQueryFilterWithoutNoneValues"}]},"type":"array","title":"Filters"}},"additionalProperties":false,"type":"object","required":["measures"],"title":"PolicyQuery","example":{"dimensions":["Orders.status"],"filters":[{"member":"Orders.status","operator":"equals","values":["processing"]}],"measures":["Orders.count"],"order":[{"desc":true,"id":"Orders.count"}],"timezone":"UTC"}},"PolicyQueryFilter":{"properties":{"member":{"type":"string","title":"Member"},"operator":{"type":"string","title":"Operator"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string"}],"title":"Values"}},"type":"object","required":["member","operator","values"],"title":"PolicyQueryFilter"},"PolicyQueryFilterWithoutNoneValues":{"properties":{"member":{"type":"string","title":"Member"},"operator":{"type":"string","title":"Operator"}},"type":"object","required":["member","operator"],"title":"PolicyQueryFilterWithoutNoneValues"},"PolicyQueryOrder":{"properties":{"id":{"type":"string","title":"Id"},"desc":{"type":"boolean","title":"Desc"}},"type":"object","required":["id","desc"],"title":"PolicyQueryOrder"},"PolicyResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"data_config":{"anyOf":[{"$ref":"#/components/schemas/DataConfigStatistics-Output"},{"$ref":"#/components/schemas/DataConfigDistributionCompare-Output"}],"title":"Data Config"},"created_by":{"type":"string","title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"last_evaluation":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Evaluation"},"next_evaluation":{"type":"string","format":"date-time","title":"Next Evaluation"},"status":{"$ref":"#/components/schemas/PolicyStatus","default":"pending"},"threshold_settings":{"oneOf":[{"$ref":"#/components/schemas/StaticThresholdSettings"},{"$ref":"#/components/schemas/MovingAverageThresholdSettings"}],"title":"Threshold Settings","discriminator":{"propertyName":"threshold_type","mapping":{"moving_average":"#/components/schemas/MovingAverageThresholdSettings","static":"#/components/schemas/StaticThresholdSettings"}}},"cron_expression":{"type":"string","title":"Cron Expression"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","default":[]},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection"},"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level"},"tenant_id":{"type":"string","title":"Tenant Id"},"dataset_id":{"type":"string","title":"Dataset Id"},"dataset_b_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset B Id"},"status_reason":{"anyOf":[{"$ref":"#/components/schemas/ValidationResult"},{"type":"null"}]},"is_running":{"type":"boolean","title":"Is Running"},"is_triggered":{"type":"boolean","title":"Is Triggered"},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tags":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Tags"},"archived_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archived At"}},"type":"object","required":["id","name","data_config","created_by","created_at","updated_at","next_evaluation","threshold_settings","cron_expression","alert_on_status","alert_on_policy_level","tenant_id","dataset_id","is_running","is_triggered","initialize_with_historic_data"],"title":"PolicyResponse"},"PolicySearchParams":{"properties":{"filters":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Filters","description":"Filter on db columns","examples":[["name","ilike","active"],[["id","eq","5c05dc9f-f04a-4ce8-9d57-2ec63ee76aac"],"and",["description","ilike","Construction"]]]},"search":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Search","description":"Free text search on searchable fields"},"sort_by":{"type":"string","enum":["id","name","status","created_at","updated_at","last_evaluation"],"title":"Sort By","description":"Field to sort by","default":"updated_at"},"sort_direction":{"type":"string","enum":["asc","desc"],"title":"Sort Direction","description":"Sort direction (ascending or descending)","default":"desc"},"only_archived":{"type":"boolean","title":"Only Archived","default":false}},"type":"object","title":"PolicySearchParams"},"PolicyStatus":{"type":"string","enum":["pending","healthy","unhealthy","error","no_data"],"title":"PolicyStatus"},"PolicyUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"data_config":{"anyOf":[{"$ref":"#/components/schemas/DataConfigStatistics-Input"},{"$ref":"#/components/schemas/DataConfigDistributionCompare-Input"},{"type":"null"}],"title":"Data Config"},"cron_expression":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cron Expression"},"destination_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Destination Ids"},"alert_on_status":{"anyOf":[{"$ref":"#/components/schemas/AlertOnStatusDirection"},{"type":"null"}]},"alert_on_policy_level":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Alert On Policy Level"},"dataset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset Id"},"dataset_b_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dataset B Id"},"threshold_settings":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/StaticThresholdSettings"},{"$ref":"#/components/schemas/MovingAverageThresholdSettings"}],"discriminator":{"propertyName":"threshold_type","mapping":{"moving_average":"#/components/schemas/MovingAverageThresholdSettings","static":"#/components/schemas/StaticThresholdSettings"}}},{"type":"null"}],"title":"Threshold Settings"},"initialize_with_historic_data":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Initialize With Historic Data"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","title":"PolicyUpdate"},"StaticThresholdSettings":{"properties":{"condition_above_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Condition Above Value","description":"Condition above value"},"condition_below_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Condition Below Value","description":"Condition below value"},"threshold_type":{"type":"string","const":"static","title":"Threshold Type","default":"static"}},"type":"object","title":"StaticThresholdSettings"},"ThroughputAnomalyTemplate":{"properties":{"alert_on_policy_level":{"type":"boolean","title":"Alert On Policy Level","default":true},"name":{"type":"string","title":"Policy Name","description":"A descriptive name for this policy"},"dataset_id":{"type":"string","title":"Dataset Id","description":"The dataset this policy is monitoring"},"destination_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Destination Ids","description":"List of communication channels to get notified through"},"cron_expression":{"type":"string","title":"Cron Expression","default":"0 * * * *"},"threshold_settings":{"anyOf":[{"$ref":"#/components/schemas/MovingAverageThresholdSettings"},{"type":"null"}]},"alert_on_status":{"$ref":"#/components/schemas/AlertOnStatusDirection","default":"HEALTHY_TO_UNHEALTHY"},"type":{"type":"string","const":"throughput_anomaly","title":"Type","default":"throughput_anomaly"},"agent_id":{"type":"string","format":"uuid","title":"Agent Id"},"internal_id":{"type":"string","title":"Internal Id"},"measure":{"type":"string","title":"Measure","default":"count"},"time_range_config":{"$ref":"#/components/schemas/TimeRangeConfig","default":{"field_name":"received_ts","unit":"HOUR","value":1}},"initialize_with_historic_data":{"type":"boolean","title":"Initialize With Historic Data","default":true},"warn_above_threshold":{"type":"boolean","title":"Warn Above Threshold"},"warn_below_threshold":{"type":"boolean","title":"Warn Below Threshold"}},"type":"object","required":["name","dataset_id","destination_ids","agent_id","warn_above_threshold","warn_below_threshold"],"title":"ThroughputAnomalyTemplate"},"TimeRangeConfig":{"properties":{"field_name":{"type":"string","title":"Field Name"},"unit":{"$ref":"#/components/schemas/TimeRangeUnit"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["field_name","unit","value"],"title":"TimeRangeConfig"},"TimeRangeUnit":{"type":"string","enum":["MINUTE","HOUR","DAY","WEEK","MONTH"],"title":"TimeRangeUnit"},"ValidationErrorDetail":{"properties":{"type":{"type":"string","title":"Type"},"detail":{"type":"string","title":"Detail"},"invalid_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invalid Key"}},"type":"object","required":["type","detail"],"title":"ValidationErrorDetail"},"ValidationResult":{"properties":{"is_valid":{"type":"boolean","title":"Is Valid","default":false},"errors":{"items":{"$ref":"#/components/schemas/ValidationErrorDetail"},"type":"array","title":"Errors"}},"type":"object","title":"ValidationResult"},"AUCROCPayload":{"properties":{"metric":{"type":"string","enum":["AUC_ROC"],"const":"AUC_ROC","title":"Metric","default":"AUC_ROC"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"},"actual_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Actual Positive Class"}},"type":"object","required":["dataset_id","prediction_field","actual_field","actual_positive_class"],"title":"AUCROCPayload"},"AccuracyPayload":{"properties":{"metric":{"type":"string","enum":["ACCURACY"],"const":"ACCURACY","title":"Metric","default":"ACCURACY"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"}},"type":"object","required":["dataset_id","prediction_field","actual_field"],"title":"AccuracyPayload"},"BaseQuery":{"properties":{"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"order":{"anyOf":[{"items":{"$ref":"#/components/schemas/QueryOrder"},"type":"array"},{"items":{"items":{},"type":"array"},"type":"array"},{"$ref":"#/components/schemas/QueryOrder"},{"type":"null"}],"title":"Order","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"UTC"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]}},"type":"object","required":["measures"],"title":"BaseQuery"},"DistributionFrequenciesCategoricalResponse":{"properties":{"values":{"items":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"type":"array","title":"Values"},"frequencies":{"items":{"type":"number"},"type":"array","title":"Frequencies"}},"type":"object","required":["values","frequencies"],"title":"DistributionFrequenciesCategoricalResponse"},"DistributionFrequenciesNumericalResponse":{"properties":{"bins":{"items":{"type":"number"},"type":"array","title":"Bins"},"frequencies":{"items":{"type":"number"},"type":"array","title":"Frequencies"}},"type":"object","required":["bins","frequencies"],"title":"DistributionFrequenciesNumericalResponse"},"DistributionPayload":{"properties":{"query_a":{"$ref":"#/components/schemas/BaseQuery"},"query_b":{"$ref":"#/components/schemas/BaseQuery"}},"type":"object","required":["query_a","query_b"],"title":"DistributionPayload"},"DistributionResponse":{"properties":{"frequencies_a":{"anyOf":[{"$ref":"#/components/schemas/DistributionFrequenciesNumericalResponse"},{"$ref":"#/components/schemas/DistributionFrequenciesCategoricalResponse"}],"title":"Frequencies A"},"frequencies_b":{"anyOf":[{"$ref":"#/components/schemas/DistributionFrequenciesNumericalResponse"},{"$ref":"#/components/schemas/DistributionFrequenciesCategoricalResponse"}],"title":"Frequencies B"},"jensen_shannon_divergence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Jensen Shannon Divergence"},"wasserstein_distance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Wasserstein Distance"}},"type":"object","required":["frequencies_a","frequencies_b"],"title":"DistributionResponse"},"F1ScorePayload":{"properties":{"metric":{"type":"string","enum":["F1_SCORE"],"const":"F1_SCORE","title":"Metric","default":"F1_SCORE"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"},"prediction_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Prediction Positive Class"},"actual_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Actual Positive Class"}},"type":"object","required":["dataset_id","prediction_field","actual_field","prediction_positive_class","actual_positive_class"],"title":"F1ScorePayload"},"LogLossPayload":{"properties":{"metric":{"type":"string","enum":["LOG_LOSS"],"const":"LOG_LOSS","title":"Metric","default":"LOG_LOSS"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"},"actual_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Actual Positive Class"}},"type":"object","required":["dataset_id","prediction_field","actual_field","actual_positive_class"],"title":"LogLossPayload"},"MAEPayload":{"properties":{"metric":{"type":"string","enum":["MAE"],"const":"MAE","title":"Metric","default":"MAE"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"}},"type":"object","required":["dataset_id","prediction_field","actual_field"],"title":"MAEPayload"},"MAPEPayload":{"properties":{"metric":{"type":"string","enum":["MAPE"],"const":"MAPE","title":"Metric","default":"MAPE"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"}},"type":"object","required":["dataset_id","prediction_field","actual_field"],"title":"MAPEPayload"},"MSEPayload":{"properties":{"metric":{"type":"string","enum":["MSE"],"const":"MSE","title":"Metric","default":"MSE"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"}},"type":"object","required":["dataset_id","prediction_field","actual_field"],"title":"MSEPayload"},"PerformanceMetric":{"type":"string","enum":["ACCURACY","PRECISION","RECALL","F1_SCORE","AUC_ROC","LOG_LOSS","MAE","MSE","RMSE","MAPE"],"title":"PerformanceMetric"},"PerformanceResponse":{"properties":{"metric":{"$ref":"#/components/schemas/PerformanceMetric"},"results":{"items":{"$ref":"#/components/schemas/PerformanceResult"},"type":"array","title":"Results"}},"type":"object","required":["metric","results"],"title":"PerformanceResponse"},"PerformanceResult":{"properties":{"dimensions_values":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"boolean"}]},"type":"object"},{"type":"null"}],"title":"Dimensions Values"},"value":{"type":"number","title":"Value"}},"type":"object","required":["dimensions_values","value"],"title":"PerformanceResult"},"PrecisionPayload":{"properties":{"metric":{"type":"string","enum":["PRECISION"],"const":"PRECISION","title":"Metric","default":"PRECISION"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"},"prediction_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Prediction Positive Class"},"actual_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Actual Positive Class"}},"type":"object","required":["dataset_id","prediction_field","actual_field","prediction_positive_class","actual_positive_class"],"title":"PrecisionPayload"},"QueryFilter":{"properties":{"member":{"type":"string","title":"Member"},"operator":{"type":"string","title":"Operator"},"values":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"type":"boolean"},{"type":"integer"}]},"type":"array"},{"type":"string"},{"type":"boolean"},{"type":"integer"},{"type":"null"}],"title":"Values"}},"type":"object","required":["member","operator"],"title":"QueryFilter"},"QueryOrder":{"properties":{"id":{"type":"string","title":"Id"},"desc":{"type":"boolean","title":"Desc"}},"type":"object","required":["id","desc"],"title":"QueryOrder"},"RMSEPayload":{"properties":{"metric":{"type":"string","enum":["RMSE"],"const":"RMSE","title":"Metric","default":"RMSE"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"}},"type":"object","required":["dataset_id","prediction_field","actual_field"],"title":"RMSEPayload"},"RecallPayload":{"properties":{"metric":{"type":"string","enum":["RECALL"],"const":"RECALL","title":"Metric","default":"RECALL"},"dataset_id":{"type":"string","title":"Dataset Id"},"filters":{"items":{"$ref":"#/components/schemas/QueryFilter"},"type":"array","title":"Filters","default":[]},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions","default":[]},"prediction_field":{"type":"string","title":"Prediction Field"},"actual_field":{"type":"string","title":"Actual Field"},"prediction_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Prediction Positive Class"},"actual_positive_class":{"anyOf":[{"type":"string"},{"type":"boolean"}],"title":"Actual Positive Class"}},"type":"object","required":["dataset_id","prediction_field","actual_field","prediction_positive_class","actual_positive_class"],"title":"RecallPayload"}},"securitySchemes":{"implicit":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://authentication.superwise.ai/identity/resources/auth/v1/api-token","scopes":{}}}}}},"tags":[{"name":"agents","description":"\n provide Superwise Builder the ability to configure and manage LLM agents.\n "},{"name":"dashboard-item","description":"\n The actual widgets that display a specific query in a specific way\n "},{"name":"dashboards","description":"\n Dashboards are a parent container for items which display a specific query in a specific way\n"},{"name":"dataset-models","description":"\n Dataset Models are a way to group datasets and models in Superwise.\n "},{"name":"dataset-sources","description":"\n provide Superwise the context of which data we are currently pulling from a source.\n "},{"name":"datasets","description":"\n Datasets are a way to organize your model's data in Superwise.\n "},{"name":"destinations","description":"\n A set of communication channels to notify about events Superwise detects\n "},{"name":"guardrails","description":"\n Guardrails are validators used to ensure user prompt's or application responses are restricted to a certain set of rules.\n"},{"name":"integrations","description":"\n A one-time-connection to a 3rd party notification service ( e.g. Slack )\n "},{"name":"metrics","description":"\n Metrics are ML non-SQL calculations ( drift, ROC-AUC etc).\n"},{"name":"models","description":"\n Models are a way to group datasets in Superwise.\n "},{"name":"policies","description":"\n Policies are a way to monitor your data and get notified when certain conditions are met.\n"},{"name":"sources","description":"\n provide Superwise the ability to connect to a data source and pull data from it.\n "}],"security":[{"implicit":[]}],"servers":[{"url":"api.superwise.ai","description":"Superwise Api Gateway"}]}ion/json